# cast.[framework](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework).ui

namespace static

This is the `cast.framework.ui` namespace.

## Classes

### [ApplicationData](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.ApplicationData)

Data about running application or remote controlled application.

### [BrowseContent](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.BrowseContent)

Content for the media browse carousel. This content should be used
for both media browse UI on IDLE screen and related content screen during
playback.

### [BrowseItem](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.BrowseItem)

Content for the individual browse item in the media browse list.

### [Controls](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.Controls)

Touch Controls. Provides interface for configuring controls on touch-enabled
devices.

### [PlayerData](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.PlayerData)

Player data. Provide the player media and break state.

### [PlayerDataBinder](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.PlayerDataBinder)

The player data binder. This binds a player data object to the player state.
The player data is updated to accurately reflect the current
player state without firing any change events.

### [PlayerDataChangedEvent](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.PlayerDataChangedEvent)

Player data changed event. Provides the changed field (type), and new value.

### [UiConfig](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.UiConfig)

UI Configuration.

### [UiManager](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.ui.UiManager)

Provides an interface for managing the UI.

## Enumerations

### BrowseImageAspectRatio

static

string

Aspect ratio of all images in the media browse carousel.

| #### Value ||
|---|---|
| SQUARE_1_TO_1 | string Square images. |
| PORTRAIT_2_TO_3 | string Portrait orientation images with 2:3 aspect ratio. UI for portrait orientation is not final and is a subject to change. |
| LANDSCAPE_16_TO_9 | string Landscape orientation images with 16:9 aspect ratio. |

### BrowseImageType

static

string

Type of placeholder that will be used if image is not available for the
browse item.

| #### Value ||
|---|---|
| MUSIC_TRACK | string A song track or radio seeded by the track. |
| MUSIC_ALBUM | string A playlist that consists of songs from a specific music album or radio seeded by album. |
| ARTIST | string A playlist that consists of songs by a specific music artist or band, or radio seeded by an artist or band. |
| PLAYLIST | string A playlist publicly available or radio seeded by playlist. Playlists always contain a finite and defined set of songs. |
| EPISODE | string Episode of a TV show. |
| MOVIE | string A movie. |
| PHOTO | string An image. |
| PODCAST | string A podcast series. |
| MUSIC_GENRE | string A music genre. |
| AUDIO_BOOK | string An audio book. |
| RADIO_STATION | string A radio station. This could be a terrestrial or an internet radio station. |
| MUSIC_MIX | string A music mix seeded by genre. |
| VIDEO | string A single video. |
| TV_SHOW | string A TV show. |
| NEWS | string News audio or video. |

### BrowseMediaBadge

static

string

Badge that will be displayed on top of the browse item image.

| #### Value ||
|---|---|
| LIVE | string LIVE indicator badge. Should be used if stream is a live content. |

### ControlsButton

static

string

Predefined buttons for the Media Controls overlay

| #### Value ||
|---|---|
| QUEUE_NEXT | string Go to the next item in queue |
| QUEUE_PREV | string Go to the previous item in queue |
| SEEK_FORWARD_10 | string Seek 10 seconds forward |
| SEEK_FORWARD_15 | string Seek 15 seconds forward |
| SEEK_FORWARD_30 | string Seek 30 seconds forward |
| SEEK_BACKWARD_10 | string Seek 10 seconds backward |
| SEEK_BACKWARD_15 | string Seek 15 seconds backward |
| SEEK_BACKWARD_30 | string Seek 30 seconds backward |
| CAPTIONS | string Turn on/off closed captions |
| NO_BUTTON | string Clear slot from any buttons |
| REPEAT | string Toggle repeat mode. |
| SHUFFLE | string Toggle shuffle mode. |
| LIKE | string Like toggle button with a thumbs up icon style. |
| LIKE_HEART | string Like toggle button with a heart icon style. |
| DISLIKE | string Dislike toggle button with a thumbs down icon style. |
| LYRICS | string Lyrics toggle button. |

### ControlsSlot

static

string

Touch Controls interface.

| #### Value ||
|---|---|
| SLOT_1 | string Side left slot. Deprecated, use SLOT_SECONDARY_1 instead. |
| SLOT_2 | string Center left slot. Deprecated, use SLOT_PRIMARY_1 instead. |
| SLOT_3 | string Center right slot. Deprecated, use SLOT_PRIMARY_2 instead. |
| SLOT_4 | string Side right slot. Deprecated, use SLOT_SECONDARY_2 instead. |
| SLOT_PRIMARY_1 | string Center left slot. Placed to the left of the play/pause button. |
| SLOT_PRIMARY_2 | string Center right slot. Placed to the right of the play/pause button. |
| SLOT_SECONDARY_1 | string Side left slot. Aligned to the left edge of the screen. |
| SLOT_SECONDARY_2 | string Side right slot. Aligned to the right edge of the screen. |

### DisplayType

static

string

Device display type.

| #### Value ||
|---|---|
| TV | string |
| TOUCH | string |

### PlayerDataEventType

static

string

Player data changed event types.

| #### Value ||
|---|---|
| ANY_CHANGE | string Any field change will trigger this event. |
| APPLICATION_DATA_CHANGED | string Application name changed. |
| STATE_CHANGED | string Current player state changed. |
| IS_SEEKING_CHANGED | string isSeeking field changed. |
| DURATION_CHANGED | string duration field changed. |
| CURRENT_TIME_CHANGED | string currentTime field changed. |
| PLAYBACK_RATE_CHANGED | string playbackRate field changed. |
| METADATA_CHANGED | string metadata field changed. |
| MEDIA_SESSION_ID_CHANGED | string mediaSessionId field changed. |
| MEDIA_CHANGED | string media field changed. |
| QUEUE_DATA_CHANGED | string queueData field changed. |
| TITLE_CHANGED | string title field changed. |
| SUBTITLE_CHANGED | string subtitle field changed. |
| THUMBNAIL_URL_CHANGED | string thumbnailUrl field changed. |
| SECONDARY_IMAGE_URL_CHANGED | string secondaryImageUrl field changed. |
| NEXT_TITLE_CHANGED | string nextTitle field changed. |
| NEXT_SUBTITLE_CHANGED | string nextSubtitle field changed. |
| NEXT_THUMBNAIL_URL_CHANGED | string nextThumbnailUrl field changed. |
| NEXT_METADATA_CHANGED | string nextMetadata field changed. |
| PRELOADING_NEXT_CHANGED | string preloadingNext field changed. |
| MEDIA_CATEGORY_CHANGED | string mediaCategory field changed. |
| SUPPORTED_MEDIA_COMMANDS_CHANGED | string contentType field changed. |
| IS_LIVE_CHANGED | string isLive field changed. |
| IS_AT_LIVE_EDGE_CHANGED | string isAtLiveEdge field changed. |
| BREAK_PERCENTAGE_POSITIONS_CHANGED | string breakPercentagePositions field changed. |
| IS_PLAYING_BREAK_CHANGED | string isPlayingBreak field changed. |
| IS_BREAK_SKIPPABLE_CHANGED | string isBreakSkippable field changed. |
| WHEN_SKIPPABLE_CHANGED | string whenSkippable field changed. |
| NUMBER_BREAK_CLIPS_CHANGED | string numberBreakClips field changed. |
| CURRENT_BREAK_CLIP_NUMBER_CHANGED | string currentBreakClipNumber field changed. |
| BREAK_TITLE_CHANGED | string breakTitle field changed. |
| DISPLAY_STATUS_CHANGED | string displayStatus field changed. |
| DISPLAY_TYPE_CHANGED | string displayType field changed. |
| LIVE_SEEKABLE_RANGE_CHANGED | string liveSeekableRange field changed. |
| MEDIA_START_ABSOLUTE_TIME_CHANGED | string mediaStartAbsoluteTime field changed. |
| SECTION_START_TIME_IN_MEDIA_CHANGED | string sectionStartTimeInMedia field changed. |
| SECTION_DURATION_CHANGED | string sectionDuration field changed. |
| CUSTOM_STATE_CHANGED | string Custom state changed. |
| ACTIVE_TRACK_IDS_CHANGED | string activeTrackIds field changed. |

### SecondaryImagePosition

static

string

Position of the secondary image.

| #### Value ||
|---|---|
| TOP_RIGHT_VIDEO_OVERLAY | string Sets secondary logo at top right on the overlay. |

### State

static

string

UI state of receiver application.

| #### Value ||
|---|---|
| LAUNCHING | string |
| IDLE | string |
| LOADING | string |
| BUFFERING | string |
| PAUSED | string |
| PLAYING | string |

## Properties

### BrowseImageAspectRatio

static

string

Aspect ratio of all images in the media browse carousel.

| #### Value ||
|---|---|
| SQUARE_1_TO_1 | string Square images. |
| PORTRAIT_2_TO_3 | string Portrait orientation images with 2:3 aspect ratio. UI for portrait orientation is not final and is a subject to change. |
| LANDSCAPE_16_TO_9 | string Landscape orientation images with 16:9 aspect ratio. |

### BrowseImageType

static

string

Type of placeholder that will be used if image is not available for the
browse item.

| #### Value ||
|---|---|
| MUSIC_TRACK | string A song track or radio seeded by the track. |
| MUSIC_ALBUM | string A playlist that consists of songs from a specific music album or radio seeded by album. |
| ARTIST | string A playlist that consists of songs by a specific music artist or band, or radio seeded by an artist or band. |
| PLAYLIST | string A playlist publicly available or radio seeded by playlist. Playlists always contain a finite and defined set of songs. |
| EPISODE | string Episode of a TV show. |
| MOVIE | string A movie. |
| PHOTO | string An image. |
| PODCAST | string A podcast series. |
| MUSIC_GENRE | string A music genre. |
| AUDIO_BOOK | string An audio book. |
| RADIO_STATION | string A radio station. This could be a terrestrial or an internet radio station. |
| MUSIC_MIX | string A music mix seeded by genre. |
| VIDEO | string A single video. |
| TV_SHOW | string A TV show. |
| NEWS | string News audio or video. |

### BrowseMediaBadge

static

string

Badge that will be displayed on top of the browse item image.

| #### Value ||
|---|---|
| LIVE | string LIVE indicator badge. Should be used if stream is a live content. |

### ControlsButton

static

string

Predefined buttons for the Media Controls overlay

| #### Value ||
|---|---|
| QUEUE_NEXT | string Go to the next item in queue |
| QUEUE_PREV | string Go to the previous item in queue |
| SEEK_FORWARD_10 | string Seek 10 seconds forward |
| SEEK_FORWARD_15 | string Seek 15 seconds forward |
| SEEK_FORWARD_30 | string Seek 30 seconds forward |
| SEEK_BACKWARD_10 | string Seek 10 seconds backward |
| SEEK_BACKWARD_15 | string Seek 15 seconds backward |
| SEEK_BACKWARD_30 | string Seek 30 seconds backward |
| CAPTIONS | string Turn on/off closed captions |
| NO_BUTTON | string Clear slot from any buttons |
| REPEAT | string Toggle repeat mode. |
| SHUFFLE | string Toggle shuffle mode. |
| LIKE | string Like toggle button with a thumbs up icon style. |
| LIKE_HEART | string Like toggle button with a heart icon style. |
| DISLIKE | string Dislike toggle button with a thumbs down icon style. |
| LYRICS | string Lyrics toggle button. |

### ControlsSlot

static

string

Touch Controls interface.

| #### Value ||
|---|---|
| SLOT_1 | string Side left slot. Deprecated, use SLOT_SECONDARY_1 instead. |
| SLOT_2 | string Center left slot. Deprecated, use SLOT_PRIMARY_1 instead. |
| SLOT_3 | string Center right slot. Deprecated, use SLOT_PRIMARY_2 instead. |
| SLOT_4 | string Side right slot. Deprecated, use SLOT_SECONDARY_2 instead. |
| SLOT_PRIMARY_1 | string Center left slot. Placed to the left of the play/pause button. |
| SLOT_PRIMARY_2 | string Center right slot. Placed to the right of the play/pause button. |
| SLOT_SECONDARY_1 | string Side left slot. Aligned to the left edge of the screen. |
| SLOT_SECONDARY_2 | string Side right slot. Aligned to the right edge of the screen. |

### DisplayType

static

string

Device display type.

| #### Value ||
|---|---|
| TV | string |
| TOUCH | string |

### PlayerDataEventType

static

string

Player data changed event types.

| #### Value ||
|---|---|
| ANY_CHANGE | string Any field change will trigger this event. |
| APPLICATION_DATA_CHANGED | string Application name changed. |
| STATE_CHANGED | string Current player state changed. |
| IS_SEEKING_CHANGED | string isSeeking field changed. |
| DURATION_CHANGED | string duration field changed. |
| CURRENT_TIME_CHANGED | string currentTime field changed. |
| PLAYBACK_RATE_CHANGED | string playbackRate field changed. |
| METADATA_CHANGED | string metadata field changed. |
| MEDIA_SESSION_ID_CHANGED | string mediaSessionId field changed. |
| MEDIA_CHANGED | string media field changed. |
| QUEUE_DATA_CHANGED | string queueData field changed. |
| TITLE_CHANGED | string title field changed. |
| SUBTITLE_CHANGED | string subtitle field changed. |
| THUMBNAIL_URL_CHANGED | string thumbnailUrl field changed. |
| SECONDARY_IMAGE_URL_CHANGED | string secondaryImageUrl field changed. |
| NEXT_TITLE_CHANGED | string nextTitle field changed. |
| NEXT_SUBTITLE_CHANGED | string nextSubtitle field changed. |
| NEXT_THUMBNAIL_URL_CHANGED | string nextThumbnailUrl field changed. |
| NEXT_METADATA_CHANGED | string nextMetadata field changed. |
| PRELOADING_NEXT_CHANGED | string preloadingNext field changed. |
| MEDIA_CATEGORY_CHANGED | string mediaCategory field changed. |
| SUPPORTED_MEDIA_COMMANDS_CHANGED | string contentType field changed. |
| IS_LIVE_CHANGED | string isLive field changed. |
| IS_AT_LIVE_EDGE_CHANGED | string isAtLiveEdge field changed. |
| BREAK_PERCENTAGE_POSITIONS_CHANGED | string breakPercentagePositions field changed. |
| IS_PLAYING_BREAK_CHANGED | string isPlayingBreak field changed. |
| IS_BREAK_SKIPPABLE_CHANGED | string isBreakSkippable field changed. |
| WHEN_SKIPPABLE_CHANGED | string whenSkippable field changed. |
| NUMBER_BREAK_CLIPS_CHANGED | string numberBreakClips field changed. |
| CURRENT_BREAK_CLIP_NUMBER_CHANGED | string currentBreakClipNumber field changed. |
| BREAK_TITLE_CHANGED | string breakTitle field changed. |
| DISPLAY_STATUS_CHANGED | string displayStatus field changed. |
| DISPLAY_TYPE_CHANGED | string displayType field changed. |
| LIVE_SEEKABLE_RANGE_CHANGED | string liveSeekableRange field changed. |
| MEDIA_START_ABSOLUTE_TIME_CHANGED | string mediaStartAbsoluteTime field changed. |
| SECTION_START_TIME_IN_MEDIA_CHANGED | string sectionStartTimeInMedia field changed. |
| SECTION_DURATION_CHANGED | string sectionDuration field changed. |
| CUSTOM_STATE_CHANGED | string Custom state changed. |
| ACTIVE_TRACK_IDS_CHANGED | string activeTrackIds field changed. |

### SecondaryImagePosition

static

string

Position of the secondary image.

| #### Value ||
|---|---|
| TOP_RIGHT_VIDEO_OVERLAY | string Sets secondary logo at top right on the overlay. |

### State

static

string

UI state of receiver application.

| #### Value ||
|---|---|
| LAUNCHING | string |
| IDLE | string |
| LOADING | string |
| BUFFERING | string |
| PAUSED | string |
| PLAYING | string |