--- title: "Update" method: PUT path: "/projects/{project_id}/player_settings" tags: ["Player settings"] --- # Update `PUT /projects/{project_id}/player_settings` Updates the player settings for a project ## Request body - RequestBodyPlayerSettings - `enabled` boolean — Whether the player distribution is on or off - `player_version` '0' | '1' — The player version to use. Possible values are `0` for legacy and `1` for the current - `player_style` 'small' | 'standard' | 'large' | 'video' — he style of user interface to show for the player. Possible values are `small`, `standard`, `large`, or `video` - `player_title` string, nullable — The title to show in the `large` player when there isn't a playlist - `call_to_action` string — The text prompt to show on the player - `image_url` string, nullable — An image to show in the player instead of the content's image - `persistent_ad_image` boolean, nullable — Whether to show clickable ad images in the player when the ad isn't playing - `theme` 'auto' | 'dark' | 'light' — The color theme to use for the player. The color theme to use for the player. Possible values are `auto`, `dark`, or `light` - `dark_theme` object — The dark theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `highlight_color` string — The hexadecimal highlight color to use in the player - `word_highlight_color` string — The hexadecimal word highlight color to use in the player - `light_theme` object — The light theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `highlight_color` string — The hexadecimal highlight color to use in the player - `word_highlight_color` string — The hexadecimal word highlight color to use in the player - `video_theme` object — The video theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `title_enabled` boolean — Whether to always show the content's title (e.g. instead of the call_to_action) - `image_enabled` boolean — Whether to show or hide the image in the player - `widget_style` 'none' | 'small' | 'standard' | 'large' | 'video' — The style of user interface to show for the widget at the bottom of the screen. Possible values are `none`, `small`, `standard`, `large`, `video` The widget appears once you scroll past the player in the page. - `widget_position` 'auto' | 'left' | 'center' | 'right' — The side of the screen on which to show the widget. Possible values are `auto`, `left`, `center`, `right` The 'auto' position places the standard player in the center, otherwise to the right. - `segment_playback_enabled` boolean — Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page - `segment_highlights_enabled` boolean — Whether segments should be highlighted in time with content playback - `skip_button_style` string — The style of skip buttons to show in the player. Possible values are `segments` or `seconds` You can specify the number of seconds to skip, e.g. `seconds-15` or `seconds-15-30` - `intro_url` string, nullable — The URL of an intro audio file to play before all content in the player - `outro_url` string, nullable — The URL of an outro audio file to play after all content in the player. - `intro_outro_enabled` boolean — Whether or not the intro and outro should be played. The default is `false` - `download_button_enabled` boolean — Whether to show a download button next to each playlist item in the player - `analytics_custom_url` string, nullable — Custom analytics server URL - `analytics_tag_enabled` string, nullable — Google Analytics tag enabled - `analytics_tag` string, nullable — Google Analytics tag - `logo_icon_enabled` boolean — Whether to show the BeyondWords logo in the player - `word_highlights_enabled` boolean - `continuous_playback_mode` 'none' | 'recent' — The continuous playback mode. Possible values are `none` or `recent` - `outro_playback_mode` 'after-all' | 'after-each' — The outro playback mode. Possible values are `after-all` or `after-each` ## Response `200` OK - PlayerSettingsModel - `enabled` boolean — Whether the player distribution is on or off - `player_version` '0' | '1' — The player version to use. Possible values are `0` for legacy and `1` for the current - `player_style` 'small' | 'standard' | 'large' | 'video' — The style of user interface to show for the player. Possible values are `small`, `standard`, `large`, or `video` - `player_title` string, nullable — The title to show in the `large` player when there isn't a playlist - `call_to_action` string — The text prompt to show on the player - `image_url` string, nullable — An image to show in the player instead of the content's image - `theme` 'auto' | 'dark' | 'light' — The color theme to use for the player. Possible values are `auto`, `dark`, or `light` The 'auto' theme is based on the user's light/dark mode system preference. - `dark_theme` object — The dark theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `highlight_color` string — The hexadecimal highlight color to use in the player - `word_highlight_color` string — The hexadecimal word highlight color to use in the player - `light_theme` object — The light theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `highlight_color` string — The hexadecimal highlight color to use in the player - `word_highlight_color` string — The hexadecimal word highlight color to use in the player - `video_theme` object — The video theme colors - `text_color` string — The hexadecimal text color to use in the player - `background_color` string — The hexadecimal background color to use in the player - `icon_color` string — The hexadecimal icon color to use in the player - `title_enabled` boolean — Whether to always show the content's title (e.g. instead of the call_to_action) - `image_enabled` boolean — Whether to show or hide the image in the player - `persistent_ad_image` boolean — Whether to show clickable ad images in the player when the ad isn't playing - `widget_style` 'none' | 'small' | 'standard' | 'large' | 'video' — The style of user interface to show for the widget at the bottom of the screen. Possible values are `none`, `small`, `standard`, `large`, `video` The widget appears once you scroll past the player in the page. - `widget_position` 'auto' | 'left' | 'center' | 'right' — The side of the screen on which to show the widget. Possible values are `auto`, `left`, `center`, `right` The 'auto' position places the standard player in the center, otherwise to the right. - `segment_playback_enabled` boolean — Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page - `segment_highlights_enabled` boolean — Whether segments should be highlighted in time with content playback - `skip_button_style` string — The style of skip buttons to show in the player. Possible values are `segments` or `seconds` You can specify the number of seconds to skip, e.g. `seconds-15` or `seconds-15-30` - `intros_outros` object[] — The URLs of intros and outros audio files - `placement` string - `audio` object[] - `url` string - `video` object[] - `url` string - `intro_url` string, nullable — The URL of an intro audio file to play before all content in the player - `outro_url` string, nullable — The URL of an outro audio file to play after all content in the player - `intro_outro_enabled` boolean — Whether or not the intro and outro should be played. The default is `false` - `download_button_enabled` boolean — Whether to show a download button next to each playlist item in the player. - `logo_icon_enabled` boolean — Whether to show the BeyondWords logo in the player. - `analytics_enabled` boolean — Analytics enabled. - `analytics_uuid_enabled` boolean — Analytics uuid enabled. - `analytics_url` string — Analytics server URL - `analytics_custom_url` string, nullable — Custom analytics server URL - `analytics_id` integer — Analytics ID - `analytics_tag_enabled` boolean — Analytics tag enabled - `analytics_tag` string, nullable — Google Analytics tag - `updated` string — Time at which the object was updated (ISO 8601) - `word_highlights_enabled` boolean - `continuous_playback_mode` 'none' | 'recent' — The continuous playback mode. Possible values are `none` or `recent` - `outro_playback_mode` 'after-all' | 'after-each' — The outro playback mode. Possible values are `after-all` or `after-each` --- [API](https://skmtc.net/beyondwords/apis/beyondwords-rest-api.md) · [All operations](https://skmtc.net/beyondwords/apis/beyondwords-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beyondwords/beyondwords-rest-api/revisions/8c4bfe3e2ebd/schema)