Classes

Enumerations

CaptionMimeType

static

string

Possible caption mimetype of text track.

Value

CEA608

CEA 608

TTML

TTML

VTT

VTT

TTML_MP4

TTML MP4

Command

static

number

Commands supported by cast.framework.messages.MediaStatus#supportedMediaCommands.

Value

PAUSE

Pause Command.

SEEK

Seek Command.

STREAM_VOLUME

Stream Volume Command.

STREAM_MUTE

Stream Volume Command.

ALL_BASIC_MEDIA

All basic media. Includes the mandatory commands and PAUSE, SEEK, STREAM_VOLUME, STREAM_MUTE. EDIT_TRACKS, PLAYBACK_RATE

QUEUE_NEXT

Queue Next Command.

QUEUE_PREV

Queue Prev Command.

QUEUE_SHUFFLE

This value was deprecated.
Use the flag {shuffle: true/false} and QUEUE_UPDATE message, which supports both shuffle and unshuffle instead.

Queue Shuffle Command.

QUEUE_REPEAT_ALL

Queue Repeat All mode.

QUEUE_REPEAT_ONE

Queue Repeat One mode.

QUEUE_REPEAT

Queue Repeat modes.

SKIP_AD

Skip AD Command.

EDIT_TRACKS

Edit tracks Commands.

PLAYBACK_RATE

Pleyback Rate Command.

LIKE

User action Like command.

DISLIKE

User action Dislike command.

FOLLOW

User action Follow command.

UNFOLLOW

User action Unfollow command.

ContainerType

static

number

Possible types of container metadata.

Value

GENERIC_CONTAINER

Generic template suitable for most media types. Used by cast.framework.messages.ContainerMetadata.

AUDIOBOOK_CONTAINER

Metadata for an audiobook. Used by cast.framework.messages.AudiobookContainerMetadata.

See also
cast.framework.messages.QueueData.containerMetadata

ContentFilteringMode

static

string

Provides content filtering mode.

Value

FILTER_EXPLICIT

Do not play explicit content.

ErrorReason

static

string

Represents media error message reasons.

Value

INVALID_COMMAND

Returned when the command is not valid or not implemented.

INVALID_PARAMS

Returned when the params are not valid or a non optional param is missing.

INVALID_MEDIA_SESSION_ID

Returned when the media session does not exist.

SKIP_LIMIT_REACHED

Returned when cannot skip more items due to reaching skip limit.

NOT_SUPPORTED

Returned when the request is not supported by the application.

LANGUAGE_NOT_SUPPORTED

Returned when the requested language is not supported.

END_OF_QUEUE

Returned when skip is not possible due to going back beyond the first item or forward beyond the last item in the queue.

DUPLICATE_REQUEST_ID

Returned when the request ID is not unique (the receiver is processing a request with the same ID).

APP_ERROR

Returned when the application state is invalid to fulfill the request.

AUTHENTICATION_EXPIRED

Returned when a request cannot be performed because authentication has expired, e.g. user changed password or the token was revoked.

PREMIUM_ACCOUNT_REQUIRED

Returned when premium account is required for the request to succeed.

CONCURRENT_STREAM_LIMIT

Returned when too many concurrent streams are detected.

PARENTAL_CONTROL_RESTRICTED

Returned when the content is blocked due to parental controls.

CONTENT_FILTERED

Returned when the content is blocked due to filter.

NOT_AVAILABLE_IN_REGION

Returned when the content is blocked due to being regionally unavailable.

CONTENT_ALREADY_PLAYING

Returned when the requested content is already playing.

INVALID_REQUEST

Returned when the request is not valid.

GENERIC_LOAD_ERROR

Returned when the load request encounter intermittent issue.

ErrorType

static

string

Represents media error message types.

Value

INVALID_PLAYER_STATE

Returned when the player state is invalid to fulfill the request.

LOAD_FAILED

Returned when the LOAD request failed.

LOAD_CANCELLED

Returned when the LOAD request is cancelled by a second incoming LOAD request.

INVALID_REQUEST

Returned when the request is not valid.

ERROR

Generic error, for any other error case.

ExtendedPlayerState

static

string

Extended player state information.

Value

LOADING

The player is in LOADING state.

FocusState

static

string

Focus states.

Value

IN_FOCUS

Receiver is in focus.

NOT_IN_FOCUS

Receiver is not in focus, other activity is active.

GetStatusOptions

static

number

The Get Status flag options determine the amount of data that must be included in the media status response.

Value

NO_METADATA

Do not include metadsta flag.

NO_QUEUE_ITEMS

Do not include the queue items flag.

HdrType

static

string

Represents video High Dynamic Range (HDR) types.

Value

SDR

Standard Dynamic Range.

HDR

High Dynamic Range.

DV

Dolby Vision.

HlsSegmentFormat

static

string

Format of HLS audio segment.

Value

AAC

AC3

MP3

TS

TS_AAC

E_AC3

FMP4

HlsVideoSegmentFormat

static

string

Format of HLS video segment.

Value

MPEG2_TS

MPEG2 TS format.

FMP4

Fragmented MP4.

IdleReason

static

string

The reason for the player to be in IDLE state.

Value

CANCELLED

A sender requested to stop playback using the STOP command.

INTERRUPTED

A sender requested playing a different media using the LOAD command.

FINISHED

The media playback completed.

ERROR

The media was interrupted due to an error, this could happen if, for example, the player could not download media due to networking errors.

MessageType

static

string

Represents media message types.

Value

MEDIA_STATUS

Outgoing message of current media status. Message type is: cast.framework.messages.MediaStatus

CLOUD_STATUS

Outgoing message of media status to the cloud sender. Message type is: cast.framework.messages.CloudMediaStatus

QUEUE_CHANGE

Outgoing message of queue change. Message type is: cast.framework.messages.QueueChange

QUEUE_ITEMS

Outgoing message of queue item information. Message type is: cast.framework.messages.ItemsInfo

QUEUE_ITEM_IDS

Outgoing message of list of queue ids. Message type is: cast.framework.messages.QueueIds

GET_STATUS

Request for current media status. Message type is: cast.framework.messages.GetStatusRequestData

LOAD

Request to load media. Message type is: cast.framework.messages.LoadRequestData

PAUSE

Request to pause the player. Message type is: cast.framework.messages.RequestData

STOP

Request to stop the player. Message type is: cast.framework.messages.RequestData

PLAY

Request to continue playing. Message type is: cast.framework.messages.RequestData

SKIP_AD

Request to skip playing ad. Message type is: cast.framework.messages.RequestData

PLAY_AGAIN

Request to play again current media. Message type is: cast.framework.messages.RequestData

SEEK

Request to seek media. Message type is: cast.framework.messages.SeekRequestData

SET_PLAYBACK_RATE

The player is in IDLE stateRequest to change playback rate. Message type is: cast.framework.messages.SetPlaybackRateRequestData

SET_VOLUME

Request to change current media volume. Message type is: cast.framework.messages.VolumeRequestData

EDIT_TRACKS_INFO

Request to change playing text or audio tracks. Message type is: cast.framework.messages.EditTracksInfoRequestData

EDIT_AUDIO_TRACKS

Request to change playing audio track. Message type is: cast.framework.messages.EditAudioTrackRequestData

PRECACHE

Request to precache data. Message type is: cast.framework.messages.PrecahceRequestData

PRELOAD

Request to preload item. Message type is: cast.framework.messages.PreloadRequestData

QUEUE_LOAD

Request to load queue. Message type is: cast.framework.messages.QueueLoadRequestData

QUEUE_INSERT

Request to insert into queue. Message type is: cast.framework.messages.QueueInsertRequestData

QUEUE_UPDATE

Request to update queue. Message type is: cast.framework.messages.QueueUpdateRequestData

QUEUE_REMOVE

Request to remove from queue. Message type is: cast.framework.messages.QueueRemoveRequestData

QUEUE_REORDER

Request to reorder queue. Message type is: cast.framework.messages.QueueReorderRequestData

QUEUE_NEXT

Request next item in queue. When the receiver receives this from sender, the message maps to a cast.framework.messages.MessageType.QUEUE_UPDATE with a jump of 1. cast.framework.messages.MessageType.QUEUE_UPDATE should therefore be used as the message type when writing an interceptor for QUEUE_NEXT. Message type is: cast.framework.messages.RequestData

QUEUE_PREV

Request previous item in queue. When the receiver receives this from sender, the message maps to a cast.framework.messages.MessageType.QUEUE_UPDATE with a jump of -1. cast.framework.messages.MessageType.QUEUE_UPDATE should therefore be used as the message type when writing an interceptor for QUEUE_PREV. Message type is: cast.framework.messages.RequestData

QUEUE_GET_ITEM_RANGE

Request to fetch items in queue. Message type is: cast.framework.messages.FetchItemsRequestData

QUEUE_GET_ITEMS

Request to get items info. Message type is: cast.framework.messages.GetItemsInfoRequestData

QUEUE_GET_ITEM_IDS

Request to get queue ids. Message type is: cast.framework.messages.RequestData

QUEUE_SHUFFLE

This value was deprecated.
Use the flag {shuffle: true/false} and QUEUE_UPDATE message, which supports both shuffle and unshuffle instead.

Request to shuffle the queue. Message type is: cast.framework.messages.RequestData

SET_CREDENTIALS

Set user credential. Message type is: cast.framework.messages.SetCredentialsRequestData

LOAD_BY_ENTITY

Load media by entity id. Message type is: cast.framework.messages.LoadByEntityRequestData

USER_ACTION

Handle user action like follow. Message type is: cast.framework.messages.UserActionRequestData

DISPLAY_STATUS

Display media status on the screen. Message type is: cast.framework.messages.DisplayStatusRequestData

FOCUS_STATE

The receiver app focus state changed. Message type is: cast.framework.messages.FocusStateRequestData

CUSTOM_COMMAND

Handle custom app command. Message type is: cast.framework.messages.CustomCommandRequestData

STORE_SESSION

Store session command. Message type is: cast.framework.messages.StoreSessionRequestData

RESUME_SESSION

Resume session command. Message type is: cast.framework.messages.ResumeSessionRequestData

SESSION_STATE

Response type for StoreSession. Message type is: cast.framework.messages.StoreSessionResponseData

MetadataType

static

number

Possible types of media metadata.

Value

GENERIC

Generic template suitable for most media types. Used by cast.framework.messages.GenericMediaMetadata.

MOVIE

A full length movie. Used by cast.framework.messages.MovieMediaMetadata.

TV_SHOW

An episode of a TV series. Used by cast.framework.messages.TvShowMediaMetadata.

MUSIC_TRACK

A music track. Used by cast.framework.messages.MusicTrackMediaMetadata.

PHOTO

Photo. Used by cast.framework.messages.PhotoMediaMetadata.

AUDIOBOOK_CHAPTER

Audiobook chapter. Used by cast.framework.messages.AudiobookChapterMediaMetadata.

See also
cast.framework.messages.MediaInformation.metadata

PlayerState

static

string

Represents the player state.

Value

IDLE

The player is in IDLE state.

PLAYING

The player is in PLAYING state.

PAUSED

The player is in PAUSED state.

BUFFERING

The player is in BUFFERING state.

PlayStringId

static

string

String IDs used by playString.

Value

FREE_TRIAL_ABOUT_TO_EXPIRE

SUBSCRIPTION_ABOUT_TO_EXPIRE

STREAM_HIJACKED

PLAYING_ALTERNATE_MIX

QueueChangeType

static

string

Queue change types used by QUEUE_CHANGE outgoing message.

Value

INSERT

Queue had items inserted.

REMOVE

Queue had items removed.

ITEMS_CHANGE

A list of items changed.

UPDATE

The queue went through an update and a new ordered list is sent.

NO_CHANGE

The queue had no change. This is used to echo back when multiple senders ended up requesting the same data.

QueueType

static

string

Types of media container/queue.

Value

ALBUM

Music album.

PLAYLIST

Music playlist, such as private playlist, public playlist, pandora playlist, etc.

AUDIOBOOK

Audiobook.

RADIO_STATION

Traditional radio station, such as PBS, BBC etc.

PODCAST_SERIES

Podcast series.

TV_SERIES

TV Series.

VIDEO_PLAYLIST

Videos playlist, like youtube channel, or red bull channel.

LIVE_TV

Live TV channel.

MOVIE

Movie.

RepeatMode

static

string

Behavior of the queue when all items have been played.

Value

REPEAT_OFF

When the queue is completed the media session is terminated.

REPEAT_ALL

All the items in the queue will be played indefinitely, when the last item is played it will play the first item again.

REPEAT_SINGLE

The current item will be played repeatedly.

REPEAT_ALL_AND_SHUFFLE

All the items in the queue will be played indefinitely, when the last item is played it will play the first item again (the list will be shuffled by the receiver first).

SeekResumeState

static

string

Represents the playback state after a SEEK request.

Value

PLAYBACK_START

It will force media to start.

PLAYBACK_PAUSE

It will force media to pause.

StreamingProtocolType

static

number

The streaming protocol types.

Value

UNKNOWN

Unknown streaming protocol type.

MPEG_DASH

MPEG-DASH (Dynamic Adaptive Streaming over HTTP) protocol type.

HLS

HLS (Http Live Streaming) protocol type.

SMOOTH_STREAMING

Smooth Streaming protocol type.

StreamType

static

string

Represents the stream types.

Value

BUFFERED

LIVE

NONE

TextTrackEdgeType

static

string

Possible text track edge type.

Value

NONE

OUTLINE

DROP_SHADOW

RAISED

DEPRESSED

TextTrackFontGenericFamily

static

string

Text track font generic family.

Value

SANS_SERIF

MONOSPACED_SANS_SERIF

SERIF

MONOSPACED_SERIF

CASUAL

CURSIVE

SMALL_CAPITALS

TextTrackFontStyle

static

string

Possible text track font style.

Value

NORMAL

BOLD

BOLD_ITALIC

ITALIC

TextTrackType

static

string

Possible text track type (follows the HTML5 text track type definitions).

Value

SUBTITLES

Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g. because the user does not understand the language of the media resource's soundtrack).

CAPTIONS

Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when the soundtrack is unavailable (e.g. because it is muted or because the user is deaf). Displayed over the video; labeled as appropriate for the hard-of-hearing.

DESCRIPTIONS

Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is unavailable (e.g. because the user is interacting with the application without a screen, or because the user is blind). Synthesized as separate audio track.

CHAPTERS

Chapter titles, intended to be used for navigating the media resource.

METADATA

Tracks intended for use from script.

TextTrackWindowType

static

string

Text track window type.

Value

NONE

NORMAL

ROUNDED_CORNERS

TrackType

static

string

Possible media track type.

Value

TEXT

Text track.

AUDIO

Audio track.

VIDEO

Video track.

UserAction

static

string

User actions.

Value

LIKE

User indicates a like preference for the currently playing content.

DISLIKE

User indicates a dislike preference for the currently playing content.

FOLLOW

User wants to follow or star currently playing content.

UNFOLLOW

User wants to stop following currently playing content.

FLAG

User flags currently playing content as inappropriate.

SKIP_AD

User wants to skip currently playing ad.

UserActionContext

static

string

Context information for the user action.

Value

UNKNOWN_CONTEXT

TRACK

ALBUM

ARTIST

PLAYLIST

EPISODE

SERIES

MOVIE

CHANNEL

TEAM

PLAYER

COACH

Properties

CaptionMimeType

static

string

Possible caption mimetype of text track.

Value

CEA608

CEA 608

TTML

TTML

VTT

VTT

TTML_MP4

TTML MP4

Command

static

number

Commands supported by cast.framework.messages.MediaStatus#supportedMediaCommands.

Value

PAUSE

Pause Command.

SEEK

Seek Command.

STREAM_VOLUME

Stream Volume Command.

STREAM_MUTE

Stream Volume Command.

ALL_BASIC_MEDIA

All basic media. Includes the mandatory commands and PAUSE, SEEK, STREAM_VOLUME, STREAM_MUTE. EDIT_TRACKS, PLAYBACK_RATE

QUEUE_NEXT

Queue Next Command.

QUEUE_PREV

Queue Prev Command.

QUEUE_SHUFFLE

This value was deprecated.
Use the flag {shuffle: true/false} and QUEUE_UPDATE message, which supports both shuffle and unshuffle instead.

Queue Shuffle Command.

QUEUE_REPEAT_ALL

Queue Repeat All mode.

QUEUE_REPEAT_ONE

Queue Repeat One mode.

QUEUE_REPEAT

Queue Repeat modes.

SKIP_AD

Skip AD Command.

EDIT_TRACKS

Edit tracks Commands.

PLAYBACK_RATE

Pleyback Rate Command.

LIKE

User action Like command.

DISLIKE

User action Dislike command.

FOLLOW

User action Follow command.

UNFOLLOW

User action Unfollow command.

ContainerType

static

number

Possible types of container metadata.

Value

GENERIC_CONTAINER

Generic template suitable for most media types. Used by cast.framework.messages.ContainerMetadata.

AUDIOBOOK_CONTAINER

Metadata for an audiobook. Used by cast.framework.messages.AudiobookContainerMetadata.

See also
cast.framework.messages.QueueData.containerMetadata

ContentFilteringMode

static

string

Provides content filtering mode.

Value

FILTER_EXPLICIT

Do not play explicit content.

ErrorReason

static

string

Represents media error message reasons.

Value

INVALID_COMMAND

Returned when the command is not valid or not implemented.

INVALID_PARAMS

Returned when the params are not valid or a non optional param is missing.

INVALID_MEDIA_SESSION_ID

Returned when the media session does not exist.

SKIP_LIMIT_REACHED

Returned when cannot skip more items due to reaching skip limit.

NOT_SUPPORTED

Returned when the request is not supported by the application.

LANGUAGE_NOT_SUPPORTED

Returned when the requested language is not supported.

END_OF_QUEUE

Returned when skip is not possible due to going back beyond the first item or forward beyond the last item in the queue.

DUPLICATE_REQUEST_ID

Returned when the request ID is not unique (the receiver is processing a request with the same ID).

APP_ERROR

Returned when the application state is invalid to fulfill the request.

AUTHENTICATION_EXPIRED

Returned when a request cannot be performed because authentication has expired, e.g. user changed password or the token was revoked.

PREMIUM_ACCOUNT_REQUIRED

Returned when premium account is required for the request to succeed.

CONCURRENT_STREAM_LIMIT

Returned when too many concurrent streams are detected.

PARENTAL_CONTROL_RESTRICTED

Returned when the content is blocked due to parental controls.

CONTENT_FILTERED

Returned when the content is blocked due to filter.

NOT_AVAILABLE_IN_REGION

Returned when the content is blocked due to being regionally unavailable.

CONTENT_ALREADY_PLAYING

Returned when the requested content is already playing.

INVALID_REQUEST

Returned when the request is not valid.

GENERIC_LOAD_ERROR

Returned when the load request encounter intermittent issue.

ErrorType

static

string

Represents media error message types.

Value

INVALID_PLAYER_STATE

Returned when the player state is invalid to fulfill the request.

LOAD_FAILED

Returned when the LOAD request failed.

LOAD_CANCELLED

Returned when the LOAD request is cancelled by a second incoming LOAD request.

INVALID_REQUEST

Returned when the request is not valid.

ERROR

Generic error, for any other error case.

ExtendedPlayerState

static

string

Extended player state information.

Value

LOADING

The player is in LOADING state.

FocusState

static

string

Focus states.

Value

IN_FOCUS

Receiver is in focus.

NOT_IN_FOCUS

Receiver is not in focus, other activity is active.

GetStatusOptions

static

number

The Get Status flag options determine the amount of data that must be included in the media status response.

Value

NO_METADATA

Do not include metadsta flag.

NO_QUEUE_ITEMS

Do not include the queue items flag.

HdrType

static

string

Represents video High Dynamic Range (HDR) types.

Value

SDR

Standard Dynamic Range.

HDR

High Dynamic Range.

DV

Dolby Vision.

HlsSegmentFormat

static

string

Format of HLS audio segment.

Value

AAC

AC3

MP3

TS

TS_AAC

E_AC3

FMP4

HlsVideoSegmentFormat

static

string

Format of HLS video segment.

Value

MPEG2_TS

MPEG2 TS format.

FMP4

Fragmented MP4.

IdleReason

static

string

The reason for the player to be in IDLE state.

Value

CANCELLED

A sender requested to stop playback using the STOP command.

INTERRUPTED

A sender requested playing a different media using the LOAD command.

FINISHED

The media playback completed.

ERROR

The media was interrupted due to an error, this could happen if, for example, the player could not download media due to networking errors.

MessageType

static

string

Represents media message types.

Value

MEDIA_STATUS

Outgoing message of current media status. Message type is: cast.framework.messages.MediaStatus

CLOUD_STATUS

Outgoing message of media status to the cloud sender. Message type is: cast.framework.messages.CloudMediaStatus

QUEUE_CHANGE

Outgoing message of queue change. Message type is: cast.framework.messages.QueueChange

QUEUE_ITEMS

Outgoing message of queue item information. Message type is: cast.framework.messages.ItemsInfo

QUEUE_ITEM_IDS

Outgoing message of list of queue ids. Message type is: cast.framework.messages.QueueIds

GET_STATUS

Request for current media status. Message type is: cast.framework.messages.GetStatusRequestData

LOAD

Request to load media. Message type is: cast.framework.messages.LoadRequestData

PAUSE

Request to pause the player. Message type is: cast.framework.messages.RequestData

STOP

Request to stop the player. Message type is: cast.framework.messages.RequestData

PLAY

Request to continue playing. Message type is: cast.framework.messages.RequestData

SKIP_AD

Request to skip playing ad. Message type is: cast.framework.messages.RequestData

PLAY_AGAIN

Request to play again current media. Message type is: cast.framework.messages.RequestData

SEEK

Request to seek media. Message type is: cast.framework.messages.SeekRequestData

SET_PLAYBACK_RATE

The player is in IDLE stateRequest to change playback rate. Message type is: cast.framework.messages.SetPlaybackRateRequestData

SET_VOLUME

Request to change current media volume. Message type is: cast.framework.messages.VolumeRequestData

EDIT_TRACKS_INFO

Request to change playing text or audio tracks. Message type is: cast.framework.messages.EditTracksInfoRequestData

EDIT_AUDIO_TRACKS

Request to change playing audio track. Message type is: cast.framework.messages.EditAudioTrackRequestData

PRECACHE

Request to precache data. Message type is: cast.framework.messages.PrecahceRequestData

PRELOAD

Request to preload item. Message type is: cast.framework.messages.PreloadRequestData

QUEUE_LOAD

Request to load queue. Message type is: cast.framework.messages.QueueLoadRequestData

QUEUE_INSERT

Request to insert into queue. Message type is: cast.framework.messages.QueueInsertRequestData

QUEUE_UPDATE

Request to update queue. Message type is: cast.framework.messages.QueueUpdateRequestData

QUEUE_REMOVE

Request to remove from queue. Message type is: cast.framework.messages.QueueRemoveRequestData

QUEUE_REORDER

Request to reorder queue. Message type is: cast.framework.messages.QueueReorderRequestData

QUEUE_NEXT

Request next item in queue. When the receiver receives this from sender, the message maps to a cast.framework.messages.MessageType.QUEUE_UPDATE with a jump of 1. cast.framework.messages.MessageType.QUEUE_UPDATE should therefore be used as the message type when writing an interceptor for QUEUE_NEXT. Message type is: cast.framework.messages.RequestData

QUEUE_PREV

Request previous item in queue. When the receiver receives this from sender, the message maps to a cast.framework.messages.MessageType.QUEUE_UPDATE with a jump of -1. cast.framework.messages.MessageType.QUEUE_UPDATE should therefore be used as the message type when writing an interceptor for QUEUE_PREV. Message type is: cast.framework.messages.RequestData

QUEUE_GET_ITEM_RANGE

Request to fetch items in queue. Message type is: cast.framework.messages.FetchItemsRequestData

QUEUE_GET_ITEMS

Request to get items info. Message type is: cast.framework.messages.GetItemsInfoRequestData

QUEUE_GET_ITEM_IDS

Request to get queue ids. Message type is: cast.framework.messages.RequestData

QUEUE_SHUFFLE

This value was deprecated.
Use the flag {shuffle: true/false} and QUEUE_UPDATE message, which supports both shuffle and unshuffle instead.

Request to shuffle the queue. Message type is: cast.framework.messages.RequestData

SET_CREDENTIALS

Set user credential. Message type is: cast.framework.messages.SetCredentialsRequestData

LOAD_BY_ENTITY

Load media by entity id. Message type is: cast.framework.messages.LoadByEntityRequestData

USER_ACTION

Handle user action like follow. Message type is: cast.framework.messages.UserActionRequestData

DISPLAY_STATUS

Display media status on the screen. Message type is: cast.framework.messages.DisplayStatusRequestData

FOCUS_STATE

The receiver app focus state changed. Message type is: cast.framework.messages.FocusStateRequestData

CUSTOM_COMMAND

Handle custom app command. Message type is: cast.framework.messages.CustomCommandRequestData

STORE_SESSION

Store session command. Message type is: cast.framework.messages.StoreSessionRequestData

RESUME_SESSION

Resume session command. Message type is: cast.framework.messages.ResumeSessionRequestData

SESSION_STATE

Response type for StoreSession. Message type is: cast.framework.messages.StoreSessionResponseData

MetadataType

static

number

Possible types of media metadata.

Value

GENERIC

Generic template suitable for most media types. Used by cast.framework.messages.GenericMediaMetadata.

MOVIE

A full length movie. Used by cast.framework.messages.MovieMediaMetadata.

TV_SHOW

An episode of a TV series. Used by cast.framework.messages.TvShowMediaMetadata.

MUSIC_TRACK

A music track. Used by cast.framework.messages.MusicTrackMediaMetadata.

PHOTO

Photo. Used by cast.framework.messages.PhotoMediaMetadata.

AUDIOBOOK_CHAPTER

Audiobook chapter. Used by cast.framework.messages.AudiobookChapterMediaMetadata.

See also
cast.framework.messages.MediaInformation.metadata

PlayerState

static

string

Represents the player state.

Value

IDLE

The player is in IDLE state.

PLAYING

The player is in PLAYING state.

PAUSED

The player is in PAUSED state.

BUFFERING

The player is in BUFFERING state.

PlayStringId

static

string

String IDs used by playString.

Value

FREE_TRIAL_ABOUT_TO_EXPIRE

SUBSCRIPTION_ABOUT_TO_EXPIRE

STREAM_HIJACKED

PLAYING_ALTERNATE_MIX

QueueChangeType

static

string

Queue change types used by QUEUE_CHANGE outgoing message.

Value

INSERT

Queue had items inserted.

REMOVE

Queue had items removed.

ITEMS_CHANGE

A list of items changed.

UPDATE

The queue went through an update and a new ordered list is sent.

NO_CHANGE

The queue had no change. This is used to echo back when multiple senders ended up requesting the same data.

QueueType

static

string

Types of media container/queue.

Value

ALBUM

Music album.

PLAYLIST

Music playlist, such as private playlist, public playlist, pandora playlist, etc.

AUDIOBOOK

Audiobook.

RADIO_STATION

Traditional radio station, such as PBS, BBC etc.

PODCAST_SERIES

Podcast series.

TV_SERIES

TV Series.

VIDEO_PLAYLIST

Videos playlist, like youtube channel, or red bull channel.

LIVE_TV

Live TV channel.

MOVIE

Movie.

RepeatMode

static

string

Behavior of the queue when all items have been played.

Value

REPEAT_OFF

When the queue is completed the media session is terminated.

REPEAT_ALL

All the items in the queue will be played indefinitely, when the last item is played it will play the first item again.

REPEAT_SINGLE

The current item will be played repeatedly.

REPEAT_ALL_AND_SHUFFLE

All the items in the queue will be played indefinitely, when the last item is played it will play the first item again (the list will be shuffled by the receiver first).

SeekResumeState

static

string

Represents the playback state after a SEEK request.

Value

PLAYBACK_START

It will force media to start.

PLAYBACK_PAUSE

It will force media to pause.

StreamingProtocolType

static

number

The streaming protocol types.

Value

UNKNOWN

Unknown streaming protocol type.

MPEG_DASH

MPEG-DASH (Dynamic Adaptive Streaming over HTTP) protocol type.

HLS

HLS (Http Live Streaming) protocol type.

SMOOTH_STREAMING

Smooth Streaming protocol type.

StreamType

static

string

Represents the stream types.

Value

BUFFERED

LIVE

NONE

TextTrackEdgeType

static

string

Possible text track edge type.

Value

NONE

OUTLINE

DROP_SHADOW

RAISED

DEPRESSED

TextTrackFontGenericFamily

static

string

Text track font generic family.

Value

SANS_SERIF

MONOSPACED_SANS_SERIF

SERIF

MONOSPACED_SERIF

CASUAL

CURSIVE

SMALL_CAPITALS

TextTrackFontStyle

static

string

Possible text track font style.

Value

NORMAL

BOLD

BOLD_ITALIC

ITALIC

TextTrackType

static

string

Possible text track type (follows the HTML5 text track type definitions).

Value

SUBTITLES

Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g. because the user does not understand the language of the media resource's soundtrack).

CAPTIONS

Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when the soundtrack is unavailable (e.g. because it is muted or because the user is deaf). Displayed over the video; labeled as appropriate for the hard-of-hearing.

DESCRIPTIONS

Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is unavailable (e.g. because the user is interacting with the application without a screen, or because the user is blind). Synthesized as separate audio track.

CHAPTERS

Chapter titles, intended to be used for navigating the media resource.

METADATA

Tracks intended for use from script.

TextTrackWindowType

static

string

Text track window type.

Value

NONE

NORMAL

ROUNDED_CORNERS

TrackType

static

string

Possible media track type.

Value

TEXT

Text track.

AUDIO

Audio track.

VIDEO

Video track.

UserAction

static

string

User actions.

Value

LIKE

User indicates a like preference for the currently playing content.

DISLIKE

User indicates a dislike preference for the currently playing content.

FOLLOW

User wants to follow or star currently playing content.

UNFOLLOW

User wants to stop following currently playing content.

FLAG

User flags currently playing content as inappropriate.

SKIP_AD

User wants to skip currently playing ad.

UserActionContext

static

string

Context information for the user action.

Value

UNKNOWN_CONTEXT

TRACK

ALBUM

ARTIST

PLAYLIST

EPISODE

SERIES

MOVIE

CHANNEL

TEAM

PLAYER

COACH