cast.framework. messages
This is the cast.framework.messages namespace.
Classes
AudiobookChapterMediaMetadata
An audiobook chapter description.
AudiobookContainerMetadata
An audiobook container description.
AudioTrackInfo
Describes audio track information for an audio track.
Break
Represents a break (an ad break, for example) included in the main video.
BreakClip
Represents a break clip (for example, a clip of an ad during an ad break)
BreakStatus
Represents the status of a break.
CloudMediaStatus
A MediaStatus that is only sent to the cloud sender, for example, Google
Assistant.
ContainerMetadata
Common container metadata used as part of QueueData.
ContentRating
The content rating (parental rating, maturity rating).
CustomCommandRequestData
CustomCommand request data.
DisplayStatusRequestData
DisplayStatusRequest data.
EditAudioTracksRequestData
Media event EDIT_AUDIO_TRACKS request data. If language is not provided, the default audio track for the media will be enabled.
EditTracksInfoRequestData
Media event EDIT_TRACKS_INFO request data.
ErrorData
Represents error information.
ExtendedMediaStatus
Extended media status information
FetchItemsRequestData
Fetch items request data.
FocusStateRequestData
Focus state change message.
GenericMediaMetadata
A generic media description.
GetItemsInfoRequestData
Get items info request data.
GetStatusRequestData
Media event GET_STATUS request data.
Image
An image that describes a receiver application or media item. This could be an application icon, cover art, or a thumbnail.
ItemsInfo
Represents a data message containing item information for each requested IDs.
LiveSeekableRange
Provides the live seekable range with start and end time in seconds.
LoadByEntityRequestData
LoadByEntity request data.
LoadOptions
Provides additional options for load requests.
LoadRequestData
Media event LOAD request data.
MediaInformation
Represents the media information.
MediaMetadata
Common media metadata used as part of MediaInformation or to describe
a media section as part of the container metadata.
MediaStatus
Represents the status of a media session.
MediaStatusMessage
A message that wraps a MediaStatus object for sending it over the media channel. This structure exists for backward-compatibility reasons.
MovieMediaMetadata
A movie media description.
MusicTrackMediaMetadata
A music track media description.
PhotoMediaMetadata
A photo media description.
PrecacheRequestData
Media event PRECACHE request data. (Some fields of the load request, like autoplay and queueData, are ignored).
PreloadRequestData
Media event PRELOAD request data.
QueueChange
Represents a queue change message, such as insert, remove, and update.
QueueData
Queue data as part of the LOAD request.
QueueIds
Represents a data message containing the full list of queue IDs.
QueueInsertRequestData
Media event queue INSERT request data.
QueueItem
Queue item information. Application developers may need to create a QueueItem to insert a queue element using cast.framework.messages.InsertQueueItems. In this case they should not provide an itemId (as the actual itemId will be assigned when the item is inserted in the queue). This prevents ID collisions with items added from a sender app.
QueueLoadRequestData
Media event queue LOAD request data.
QueueRemoveRequestData
Media event queue REMOVE request data.
QueueReorderRequestData
Media event queue REORDER request data.
QueueUpdateRequestData
Media event UPDATE queue request data.
RefreshCredentialsRequestData
RefreshCredentials request data.
RequestData
Media event request data.
ResumeSessionRequestData
RESUME_SESSION request data
SeekableRange
Provides the seekable range in seconds.
SeekRequestData
Media event SEEK request data.
SessionState
A state object containing all data to be stored in StoreSession and to be recovered in ResumeSession.
SetCredentialsRequestData
SetCredentials request data.
SetPlaybackRateRequestData
Media event playback rate request data.
StoreSessionRequestData
STORE_SESSION request data
StoreSessionResponseData
Response data for STORE_SESSION command.
TextTrackStyle
Describes style information for a text track.
Track
Describes track metadata information.
TracksInfo
Tracks information.
TvShowMediaMetadata
A TV episode media description.
UserActionRequestData
UserAction request data.
UserActionState
Represents User Action state for media.
VastAdsRequest
VAST ad request configuration.
VideoInformation
Video information such as video resolution and High Dynamic Range (HDR).
Volume
Represents the volume of a media session stream.
VolumeRequestData
Media event SET_VOLUME request data.
Enumerations
CaptionMimeType
string
Caption MIME type of text track.
Value |
|
|---|---|
|
CEA608 |
string CEA 608 |
|
TTML |
string TTML |
|
VTT |
string VTT |
|
TTML_MP4 |
string TTML MP4 |
Command
number
A list of bit mask values to set or retrieve a media command supported by an application for the cast.framework.messages.MediaStatus#supportedMediaCommands.
Value |
|
|---|---|
|
PAUSE |
number Pause Command. |
|
SEEK |
number Seek Command. |
|
STREAM_VOLUME |
number Stream Volume Command. |
|
STREAM_MUTE |
number Stream Volume Command. |
|
ALL_BASIC_MEDIA |
number All basic media. Includes the mandatory commands |
|
QUEUE_NEXT |
number Queue Next Command. |
|
QUEUE_PREV |
number Queue Prev Command. |
|
QUEUE_SHUFFLE |
number Queue Shuffle Command. |
|
QUEUE_REPEAT_ALL |
number Queue Repeat All mode. |
|
QUEUE_REPEAT_ONE |
number Queue Repeat One mode. |
|
QUEUE_REPEAT |
number Queue Repeat modes. |
|
SKIP_AD |
number Skip AD Command. |
|
EDIT_TRACKS |
number Edit tracks Commands. |
|
PLAYBACK_RATE |
number Playback Rate Command. |
|
LIKE |
number User action Like command. |
|
DISLIKE |
number User action Dislike command. |
|
FOLLOW |
number User action Follow command. |
|
UNFOLLOW |
number User action Unfollow command. |
|
STREAM_TRANSFER |
number Stream transfer commands. |
|
LYRICS |
number Lyrics commands. |
ContainerType
number
Types of container metadata.
Value |
|
|---|---|
|
GENERIC_CONTAINER |
number Generic template suitable for most media types. Used by cast.framework.messages.ContainerMetadata. |
|
AUDIOBOOK_CONTAINER |
number Metadata for an audiobook. Used by cast.framework.messages.AudiobookContainerMetadata. |
- See also
- cast.framework.messages.QueueData.containerMetadata
ContentFilteringMode
string
Represents the content-filtering mode.
Value |
|
|---|---|
|
FILTER_EXPLICIT |
string Do not play explicit content. |
ErrorReason
string
Represents media error message reasons.
Value |
|
|---|---|
|
INVALID_COMMAND |
string Returned when the command is not valid or not implemented. |
|
INVALID_PARAMS |
string Returned when the parameters are not valid or a required parameter is missing. |
|
INVALID_MEDIA_SESSION_ID |
string Returned when the media session does not exist. |
|
INVALID_REQUEST_ID |
string Returned when the requestId is invalid. |
|
SKIP_LIMIT_REACHED |
string Returned when cannot skip more items due to reaching skip limit. |
|
NOT_SUPPORTED |
string Returned when the request is not supported by the application. |
|
LANGUAGE_NOT_SUPPORTED |
string Returned when the requested language is not supported. |
|
END_OF_QUEUE |
string 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 |
string Returned when the request ID is not unique (the receiver is processing a request with the same ID). |
|
VIDEO_DEVICE_REQUIRED |
string Returned when the request cannot be completed because a video-capable device is required. |
|
PREMIUM_ACCOUNT_REQUIRED |
string Returned when premium account is required for the request to succeed. |
|
APP_ERROR |
string Returned when the application state is invalid to fulfill the request. |
|
AUTHENTICATION_EXPIRED |
string Returned when a request cannot be performed because authentication has expired, for example, when the user changed their password or when the token was revoked. |
|
CONCURRENT_STREAM_LIMIT |
string Returned when too many concurrent streams are detected. |
|
PARENTAL_CONTROL_RESTRICTED |
string Returned when the content is blocked due to parental controls. |
|
CONTENT_FILTERED |
string Returned when the content is blocked due to filter. |
|
NOT_AVAILABLE_IN_REGION |
string Returned when the content is blocked due to being regionally unavailable. |
|
CONTENT_ALREADY_PLAYING |
string Returned when the requested content is already playing. |
|
INVALID_REQUEST |
string Returned when the request is not valid. |
|
GENERIC_LOAD_ERROR |
string Returned when the load request encounter intermittent issue. |
ErrorType
string
Represents media error message types.
Value |
|
|---|---|
|
INVALID_PLAYER_STATE |
string Returned when the player state is invalid to fulfill the request. |
|
LOAD_FAILED |
string Returned when the LOAD request failed. |
|
LOAD_CANCELLED |
string Returned when the LOAD request is cancelled by a second incoming LOAD request. |
|
INVALID_REQUEST |
string Returned when the request is not valid. |
|
ERROR |
string Generic error, for any other error case. |
ExtendedPlayerState
string
Extended player state information.
Value |
|
|---|---|
|
LOADING |
string The player is in LOADING state. |
FocusState
string
Focus states.
Value |
|
|---|---|
|
IN_FOCUS |
string Receiver is in focus. |
|
NOT_IN_FOCUS |
string Receiver is not in focus, other activity is active. |
GetStatusOptions
number
The GetStatusOptions determine the amount of data that must be
included in the media status response to the GET_STATUS message.
Value |
|
|---|---|
|
NO_METADATA |
number Do not include metadata flag. |
|
NO_QUEUE_ITEMS |
number Do not include the queue items flag. |
HdrType
string
Represents video High Dynamic Range (HDR) types.
Value |
|
|---|---|
|
SDR |
string Standard Dynamic Range. |
|
HDR |
string High Dynamic Range. |
|
DV |
string Dolby Vision. |
HlsSegmentFormat
string
The format of an HLS audio segment.
Value |
|
|---|---|
|
AAC |
string AAC Packed audio elementary stream. |
|
AC3 |
string AC3 packed audio elementary stream. |
|
MP3 |
string MP3 packed audio elementary stream. |
|
TS |
string MPEG-2 transport stream. |
|
TS_AAC |
string AAC low complexity packed MPEG-2 transport stream (AAC-LC). |
|
TS_HE_AAC |
string AAC high efficiency packed MPEG-2 transport stream (HE-AAC). |
|
E_AC3 |
string E-AC3 packed audio elementary stream. |
|
FMP4 |
string Audio packed in ISO BMFF CMAF Fragmented MP4. |
HlsVideoSegmentFormat
string
The format of an HLS video segment.
Value |
|
|---|---|
|
MPEG2_TS |
string MPEG-2 Transport Stream. Supports AVC. |
|
FMP4 |
string Video packed in ISO BMFF CMAF Fragmented MP4. Supports AVC and HEVC. |
IdleReason
string
The reason for the player to be in IDLE state.
Value |
|
|---|---|
|
CANCELLED |
string A sender requested to stop playback using the STOP command. |
|
INTERRUPTED |
string A sender requested playing a different media using the LOAD command. |
|
FINISHED |
string The media playback completed. |
|
ERROR |
string The media was interrupted due to an error, this could happen if, for example, the player could not download media due to networking errors. |
MediaCategory
string
The media category.
Value |
|
|---|---|
|
AUDIO |
string Media is audio only. |
|
VIDEO |
string Media is video and audio (the default). |
|
IMAGE |
string Media is a picture. |
MessageType
string
Represents media message types to be intercepted by cast.framework.PlayerManager. Message types are categorized as requests or outgoing messages. Requests allow the application to modify any data before it is processed by the Web Receiver SDK. Outgoing messages allow the application to modify any data before the message is sent to connected systems and Sender Applications.
Value |
|
|---|---|
|
MEDIA_STATUS |
string Outgoing message of current media status. The message type is: cast.framework.messages.MediaStatus. |
|
CLOUD_STATUS |
string Outgoing message of media status to the cloud sender. The message type is: cast.framework.messages.CloudMediaStatus. |
|
QUEUE_CHANGE |
string Outgoing message of queue change. The message type is: cast.framework.messages.QueueChange. |
|
QUEUE_ITEMS |
string Outgoing message of queue item information. The message type is: cast.framework.messages.ItemsInfo. |
|
QUEUE_ITEM_IDS |
string Outgoing message of list of queue IDs. The message type is: cast.framework.messages.QueueIds. |
|
GET_STATUS |
string Request for current media status. The message type is: cast.framework.messages.GetStatusRequestData. |
|
LOAD |
string Request to load media. The message type is: cast.framework.messages.LoadRequestData. |
|
PAUSE |
string Request to pause the player. The message type is: cast.framework.messages.RequestData |
|
STOP |
string Request to stop the player. The message type is: cast.framework.messages.RequestData. |
|
PLAY |
string Request to continue playing. The message type is: cast.framework.messages.RequestData. |
|
SKIP_AD |
string Request to skip playing ad. The message type is: cast.framework.messages.RequestData. |
|
PLAY_AGAIN |
string Request to play again current media. The message type is: cast.framework.messages.RequestData. |
|
SEEK |
string Request to seek media. The message type is: cast.framework.messages.SeekRequestData. |
|
SET_PLAYBACK_RATE |
string Request to change playback rate. The message type is: cast.framework.messages.SetPlaybackRateRequestData. |
|
SET_VOLUME |
string Request to change current media volume. The message type is: cast.framework.messages.VolumeRequestData. |
|
EDIT_TRACKS_INFO |
string Request to change playing text or audio tracks. The message type is: cast.framework.messages.EditTracksInfoRequestData. |
|
EDIT_AUDIO_TRACKS |
string Request to change playing audio track. The message type is: cast.framework.messages.EditAudioTracksRequestData. |
|
PRECACHE |
string Request to precache data. The message type is: cast.framework.messages.PrecacheRequestData. |
|
PRELOAD |
string Request to preload item. The message type is: cast.framework.messages.PreloadRequestData. |
|
QUEUE_LOAD |
string Request to load queue. The message type is: cast.framework.messages.QueueLoadRequestData. |
|
QUEUE_INSERT |
string Request to insert into queue. The message type is: cast.framework.messages.QueueInsertRequestData. |
|
QUEUE_UPDATE |
string Request to update queue. The message type is: cast.framework.messages.QueueUpdateRequestData. |
|
QUEUE_REMOVE |
string Request to remove from queue. The message type is: cast.framework.messages.QueueRemoveRequestData. |
|
QUEUE_REORDER |
string Request to reorder queue. The message type is: cast.framework.messages.QueueReorderRequestData. |
|
QUEUE_NEXT |
string Request next item in queue. When the receiver receives this from
sender, the message maps to a
|
|
QUEUE_PREV |
string Request previous item in queue. When the receiver receives this from
sender, the message maps to a
|
|
QUEUE_GET_ITEM_RANGE |
string Request to fetch items in queue. The message type is: cast.framework.messages.FetchItemsRequestData. |
|
QUEUE_GET_ITEMS |
string Request to get items info. The message type is: cast.framework.messages.GetItemsInfoRequestData. |
|
QUEUE_GET_ITEM_IDS |
string Request to get queue IDs. The message type is: cast.framework.messages.RequestData. |
|
QUEUE_SHUFFLE |
string Request to shuffle the queue. The message type is: cast.framework.messages.RequestData. |
|
SET_CREDENTIALS |
string Set user credential. The message type is: cast.framework.messages.SetCredentialsRequestData. |
|
LOAD_BY_ENTITY |
string Load media by entity ID. The message type is: cast.framework.messages.LoadByEntityRequestData. |
|
USER_ACTION |
string Handle user action like follow. The message type is: cast.framework.messages.UserActionRequestData. |
|
DISPLAY_STATUS |
string Display media status on the screen. The message type is: cast.framework.messages.DisplayStatusRequestData. |
|
FOCUS_STATE |
string The receiver app focus state changed. The message type is: cast.framework.messages.FocusStateRequestData. |
|
CUSTOM_COMMAND |
string Handle custom app command. The message type is: cast.framework.messages.CustomCommandRequestData. |
|
STORE_SESSION |
string Store session command. The message type is: cast.framework.messages.StoreSessionRequestData. |
|
RESUME_SESSION |
string Resume session command. The message type is: cast.framework.messages.ResumeSessionRequestData. |
|
SESSION_STATE |
string Response type for StoreSession. The message type is: cast.framework.messages.StoreSessionResponseData. |
MetadataType
number
Types of media metadata.
Value |
|
|---|---|
|
GENERIC |
number Generic template suitable for most media types. Used by cast.framework.messages.GenericMediaMetadata. |
|
MOVIE |
number A full length movie. Used by cast.framework.messages.MovieMediaMetadata. |
|
TV_SHOW |
number An episode of a TV series. Used by cast.framework.messages.TvShowMediaMetadata. |
|
MUSIC_TRACK |
number A music track. Used by cast.framework.messages.MusicTrackMediaMetadata. |
|
PHOTO |
number Photo. Used by cast.framework.messages.PhotoMediaMetadata. |
|
AUDIOBOOK_CHAPTER |
number Audiobook chapter. Used by cast.framework.messages.AudiobookChapterMediaMetadata. |
- See also
- cast.framework.messages.MediaInformation.metadata
PlayerState
string
Represents the player state.
Value |
|
|---|---|
|
IDLE |
string The player is in IDLE state. An IDLE state means that there is no active playback. The player is usually in this state right after Cast application launch before it gets the LOAD request or after the playback has finished. The player transitions to this state based on the cast.framework.messages.IdleReason set in the cast.framework.messages.MediaStatus. |
|
PLAYING |
string The player is in PLAYING state. |
|
PAUSED |
string The player is in PAUSED state. |
|
BUFFERING |
string The player is in BUFFERING state. |
QueueChangeType
string
Queue change types used by QUEUE_CHANGE outgoing message.
Value |
|
|---|---|
|
INSERT |
string Queue had items inserted. |
|
REMOVE |
string Queue had items removed. |
|
ITEMS_CHANGE |
string A list of items changed. |
|
UPDATE |
string The queue went through an update and a new ordered list is sent. |
|
NO_CHANGE |
string The queue had no change. This is used to echo back when multiple senders ended up requesting the same data. |
QueueType
string
Types of media container/queue.
Value |
|
|---|---|
|
ALBUM |
string Music album. |
|
PLAYLIST |
string Music playlist, such as a private playlist, a public playlist, or an auto-generated playlist. |
|
AUDIOBOOK |
string Audiobook. |
|
RADIO_STATION |
string Traditional radio station. |
|
PODCAST_SERIES |
string Podcast series. |
|
TV_SERIES |
string TV Series. |
|
VIDEO_PLAYLIST |
string Videos playlist. |
|
LIVE_TV |
string Live TV channel. |
|
MOVIE |
string Movie. |
RepeatMode
string
Behavior of the queue when all items have been played.
Value |
|
|---|---|
|
REPEAT_OFF |
string When the queue is completed the media session is terminated. |
|
REPEAT_ALL |
string 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 |
string The current item will be played repeatedly. |
|
REPEAT_ALL_AND_SHUFFLE |
string 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
string
Represents the playback state after a SEEK request.
Value |
|
|---|---|
|
PLAYBACK_START |
string This forces the media to start. |
|
PLAYBACK_PAUSE |
string This forces the media to pause. |
StreamingProtocolType
number
The streaming protocol types.
Value |
|
|---|---|
|
UNKNOWN |
number Unknown streaming protocol type. |
|
MPEG_DASH |
number MPEG-DASH (Dynamic Adaptive Streaming over HTTP) protocol type. |
|
HLS |
number HLS (HTTP Live Streaming) protocol type. |
|
SMOOTH_STREAMING |
number Smooth Streaming protocol type. |
StreamType
string
Represents the stream types.
Value |
|
|---|---|
|
BUFFERED |
string VOD and DVR content. |
|
LIVE |
string Live linear stream content. |
|
NONE |
string |
TextTrackEdgeType
string
Defines the text track edge (border) type.
Value |
|
|---|---|
|
NONE |
string No edge is displayed around text. |
|
OUTLINE |
string A solid outline is displayed around text. |
|
DROP_SHADOW |
string A fading shadow is rendered around text. |
|
RAISED |
string Text appears embossed or raised in relation to the background. |
|
DEPRESSED |
string Text appears to be debossed on the background. |
TextTrackFontGenericFamily
string
Generic font family to be used if the font is not defined in the text track.
Value |
|
|---|---|
|
SANS_SERIF |
string Uses a sans-serif font. |
|
MONOSPACED_SANS_SERIF |
string Uses a monospaced, sans-serif font. |
|
SERIF |
string Uses a serif font. |
|
MONOSPACED_SERIF |
string Uses a monospaced serif font. |
|
CASUAL |
string Uses a casual, handwritten-style font. |
|
CURSIVE |
string Uses a cursive font. |
|
SMALL_CAPITALS |
string Uses a small capitals font. |
TextTrackFontStyle
string
Text track font style.
Value |
|
|---|---|
|
NORMAL |
string The unmodified typeface. |
|
BOLD |
string The bolded style. |
|
BOLD_ITALIC |
string The simultaneously bolded and italicized style. |
|
ITALIC |
string The italicized style. |
TextTrackType
string
Text track type (follows the HTML5 text track type definitions).
Value |
|
|---|---|
|
SUBTITLES |
string Transcription or translation of the dialogue, suitable for when the sound is available but not understood by the viewer, for example, because the viewer does not understand the language of the media resource's soundtrack. |
|
CAPTIONS |
string A transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when the soundtrack is unavailable (for example because it is muted or because the user is hearing-impaired). Captioning is displayed over the video. |
|
DESCRIPTIONS |
string Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is unavailable (for example because the user is interacting with the application without a screen, or because the user is visually-impaired). Descriptions are synthesized as a separate audio track. |
|
CHAPTERS |
string Chapter titles, intended to be used for navigating the media resource. |
|
METADATA |
string Tracks intended for use from a script. |
TextTrackWindowType
string
Text track window type.
Value |
|
|---|---|
|
NONE |
string |
|
NORMAL |
string |
|
ROUNDED_CORNERS |
string |
TrackType
string
Media track type.
Value |
|
|---|---|
|
TEXT |
string Text track. |
|
AUDIO |
string Audio track. |
|
VIDEO |
string Video track. |
UserAction
string
User actions.
Value |
|
|---|---|
|
LIKE |
string User indicates a like preference for the currently playing content. |
|
DISLIKE |
string User indicates a dislike preference for the currently playing content. |
|
FOLLOW |
string User wants to follow or star currently playing content. |
|
UNFOLLOW |
string User wants to stop following currently playing content. |
|
FLAG |
string User flags currently playing content as inappropriate. |
|
SKIP_AD |
string User wants to skip currently playing ad. |
|
LYRICS |
string User wants to display lyrics for the currently playing song. |
UserActionContext
string
Context information for UserAction.
Value |
|
|---|---|
|
UNKNOWN_CONTEXT |
string |
|
TRACK |
string |
|
ALBUM |
string |
|
ARTIST |
string |
|
PLAYLIST |
string |
|
EPISODE |
string |
|
SERIES |
string |
|
MOVIE |
string |
|
CHANNEL |
string |
|
TEAM |
string |
|
PLAYER |
string |
|
COACH |
string |
Properties
CaptionMimeType
string
Caption MIME type of text track.
Value |
|
|---|---|
|
CEA608 |
string CEA 608 |
|
TTML |
string TTML |
|
VTT |
string VTT |
|
TTML_MP4 |
string TTML MP4 |
Command
number
A list of bit mask values to set or retrieve a media command supported by an application for the cast.framework.messages.MediaStatus#supportedMediaCommands.
Value |
|
|---|---|
|
PAUSE |
number Pause Command. |
|
SEEK |
number Seek Command. |
|
STREAM_VOLUME |
number Stream Volume Command. |
|
STREAM_MUTE |
number Stream Volume Command. |
|
ALL_BASIC_MEDIA |
number All basic media. Includes the mandatory commands |
|
QUEUE_NEXT |
number Queue Next Command. |
|
QUEUE_PREV |
number Queue Prev Command. |
|
QUEUE_SHUFFLE |
number Queue Shuffle Command. |
|
QUEUE_REPEAT_ALL |
number Queue Repeat All mode. |
|
QUEUE_REPEAT_ONE |
number Queue Repeat One mode. |
|
QUEUE_REPEAT |
number Queue Repeat modes. |
|
SKIP_AD |
number Skip AD Command. |
|
EDIT_TRACKS |
number Edit tracks Commands. |
|
PLAYBACK_RATE |
number Playback Rate Command. |
|
LIKE |
number User action Like command. |
|
DISLIKE |
number User action Dislike command. |
|
FOLLOW |
number User action Follow command. |
|
UNFOLLOW |
number User action Unfollow command. |
|
STREAM_TRANSFER |
number Stream transfer commands. |
|
LYRICS |
number Lyrics commands. |
ContainerType
number
Types of container metadata.
Value |
|
|---|---|
|
GENERIC_CONTAINER |
number Generic template suitable for most media types. Used by cast.framework.messages.ContainerMetadata. |
|
AUDIOBOOK_CONTAINER |
number Metadata for an audiobook. Used by cast.framework.messages.AudiobookContainerMetadata. |
- See also
- cast.framework.messages.QueueData.containerMetadata
ContentFilteringMode
string
Represents the content-filtering mode.
Value |
|
|---|---|
|
FILTER_EXPLICIT |
string Do not play explicit content. |
ErrorReason
string
Represents media error message reasons.
Value |
|
|---|---|
|
INVALID_COMMAND |
string Returned when the command is not valid or not implemented. |
|
INVALID_PARAMS |
string Returned when the parameters are not valid or a required parameter is missing. |
|
INVALID_MEDIA_SESSION_ID |
string Returned when the media session does not exist. |
|
INVALID_REQUEST_ID |
string Returned when the requestId is invalid. |
|
SKIP_LIMIT_REACHED |
string Returned when cannot skip more items due to reaching skip limit. |
|
NOT_SUPPORTED |
string Returned when the request is not supported by the application. |
|
LANGUAGE_NOT_SUPPORTED |
string Returned when the requested language is not supported. |
|
END_OF_QUEUE |
string 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 |
string Returned when the request ID is not unique (the receiver is processing a request with the same ID). |
|
VIDEO_DEVICE_REQUIRED |
string Returned when the request cannot be completed because a video-capable device is required. |
|
PREMIUM_ACCOUNT_REQUIRED |
string Returned when premium account is required for the request to succeed. |
|
APP_ERROR |
string Returned when the application state is invalid to fulfill the request. |
|
AUTHENTICATION_EXPIRED |
string Returned when a request cannot be performed because authentication has expired, for example, when the user changed their password or when the token was revoked. |
|
CONCURRENT_STREAM_LIMIT |
string Returned when too many concurrent streams are detected. |
|
PARENTAL_CONTROL_RESTRICTED |
string Returned when the content is blocked due to parental controls. |
|
CONTENT_FILTERED |
string Returned when the content is blocked due to filter. |
|
NOT_AVAILABLE_IN_REGION |
string Returned when the content is blocked due to being regionally unavailable. |
|
CONTENT_ALREADY_PLAYING |
string Returned when the requested content is already playing. |
|
INVALID_REQUEST |
string Returned when the request is not valid. |
|
GENERIC_LOAD_ERROR |
string Returned when the load request encounter intermittent issue. |
ErrorType
string
Represents media error message types.
Value |
|
|---|---|
|
INVALID_PLAYER_STATE |
string Returned when the player state is invalid to fulfill the request. |
|
LOAD_FAILED |
string Returned when the LOAD request failed. |
|
LOAD_CANCELLED |
string Returned when the LOAD request is cancelled by a second incoming LOAD request. |
|
INVALID_REQUEST |
string Returned when the request is not valid. |
|
ERROR |
string Generic error, for any other error case. |
ExtendedPlayerState
string
Extended player state information.
Value |
|
|---|---|
|
LOADING |
string The player is in LOADING state. |
FocusState
string
Focus states.
Value |
|
|---|---|
|
IN_FOCUS |
string Receiver is in focus. |
|
NOT_IN_FOCUS |
string Receiver is not in focus, other activity is active. |
GetStatusOptions
number
The GetStatusOptions determine the amount of data that must be
included in the media status response to the GET_STATUS message.
Value |
|
|---|---|
|
NO_METADATA |
number Do not include metadata flag. |
|
NO_QUEUE_ITEMS |
number Do not include the queue items flag. |
HdrType
string
Represents video High Dynamic Range (HDR) types.
Value |
|
|---|---|
|
SDR |
string Standard Dynamic Range. |
|
HDR |
string High Dynamic Range. |
|
DV |
string Dolby Vision. |
HlsSegmentFormat
string
The format of an HLS audio segment.
Value |
|
|---|---|
|
AAC |
string AAC Packed audio elementary stream. |
|
AC3 |
string AC3 packed audio elementary stream. |
|
MP3 |
string MP3 packed audio elementary stream. |
|
TS |
string MPEG-2 transport stream. |
|
TS_AAC |
string AAC low complexity packed MPEG-2 transport stream (AAC-LC). |
|
TS_HE_AAC |
string AAC high efficiency packed MPEG-2 transport stream (HE-AAC). |
|
E_AC3 |
string E-AC3 packed audio elementary stream. |
|
FMP4 |
string Audio packed in ISO BMFF CMAF Fragmented MP4. |
HlsVideoSegmentFormat
string
The format of an HLS video segment.
Value |
|
|---|---|
|
MPEG2_TS |
string MPEG-2 Transport Stream. Supports AVC. |
|
FMP4 |
string Video packed in ISO BMFF CMAF Fragmented MP4. Supports AVC and HEVC. |
IdleReason
string
The reason for the player to be in IDLE state.
Value |
|
|---|---|
|
CANCELLED |
string A sender requested to stop playback using the STOP command. |
|
INTERRUPTED |
string A sender requested playing a different media using the LOAD command. |
|
FINISHED |
string The media playback completed. |
|
ERROR |
string The media was interrupted due to an error, this could happen if, for example, the player could not download media due to networking errors. |
MediaCategory
string
The media category.
Value |
|
|---|---|
|
AUDIO |
string Media is audio only. |
|
VIDEO |
string Media is video and audio (the default). |
|
IMAGE |
string Media is a picture. |
MessageType
string
Represents media message types to be intercepted by cast.framework.PlayerManager. Message types are categorized as requests or outgoing messages. Requests allow the application to modify any data before it is processed by the Web Receiver SDK. Outgoing messages allow the application to modify any data before the message is sent to connected systems and Sender Applications.
Value |
|
|---|---|
|
MEDIA_STATUS |
string Outgoing message of current media status. The message type is: cast.framework.messages.MediaStatus. |
|
CLOUD_STATUS |
string Outgoing message of media status to the cloud sender. The message type is: cast.framework.messages.CloudMediaStatus. |
|
QUEUE_CHANGE |
string Outgoing message of queue change. The message type is: cast.framework.messages.QueueChange. |
|
QUEUE_ITEMS |
string Outgoing message of queue item information. The message type is: cast.framework.messages.ItemsInfo. |
|
QUEUE_ITEM_IDS |
string Outgoing message of list of queue IDs. The message type is: cast.framework.messages.QueueIds. |
|
GET_STATUS |
string Request for current media status. The message type is: cast.framework.messages.GetStatusRequestData. |
|
LOAD |
string Request to load media. The message type is: cast.framework.messages.LoadRequestData. |
|
PAUSE |
string Request to pause the player. The message type is: cast.framework.messages.RequestData |
|
STOP |
string Request to stop the player. The message type is: cast.framework.messages.RequestData. |
|
PLAY |
string Request to continue playing. The message type is: cast.framework.messages.RequestData. |
|
SKIP_AD |
string Request to skip playing ad. The message type is: cast.framework.messages.RequestData. |
|
PLAY_AGAIN |
string Request to play again current media. The message type is: cast.framework.messages.RequestData. |
|
SEEK |
string Request to seek media. The message type is: cast.framework.messages.SeekRequestData. |
|
SET_PLAYBACK_RATE |
string Request to change playback rate. The message type is: cast.framework.messages.SetPlaybackRateRequestData. |
|
SET_VOLUME |
string Request to change current media volume. The message type is: cast.framework.messages.VolumeRequestData. |
|
EDIT_TRACKS_INFO |
string Request to change playing text or audio tracks. The message type is: cast.framework.messages.EditTracksInfoRequestData. |
|
EDIT_AUDIO_TRACKS |
string Request to change playing audio track. The message type is: cast.framework.messages.EditAudioTracksRequestData. |
|
PRECACHE |
string Request to precache data. The message type is: cast.framework.messages.PrecacheRequestData. |
|
PRELOAD |
string Request to preload item. The message type is: cast.framework.messages.PreloadRequestData. |
|
QUEUE_LOAD |
string Request to load queue. The message type is: cast.framework.messages.QueueLoadRequestData. |
|
QUEUE_INSERT |
string Request to insert into queue. The message type is: cast.framework.messages.QueueInsertRequestData. |
|
QUEUE_UPDATE |
string Request to update queue. The message type is: cast.framework.messages.QueueUpdateRequestData. |
|
QUEUE_REMOVE |
string Request to remove from queue. The message type is: cast.framework.messages.QueueRemoveRequestData. |
|
QUEUE_REORDER |
string Request to reorder queue. The message type is: cast.framework.messages.QueueReorderRequestData. |
|
QUEUE_NEXT |
string Request next item in queue. When the receiver receives this from
sender, the message maps to a
|
|
QUEUE_PREV |
string Request previous item in queue. When the receiver receives this from
sender, the message maps to a
|
|
QUEUE_GET_ITEM_RANGE |
string Request to fetch items in queue. The message type is: cast.framework.messages.FetchItemsRequestData. |
|
QUEUE_GET_ITEMS |
string Request to get items info. The message type is: cast.framework.messages.GetItemsInfoRequestData. |
|
QUEUE_GET_ITEM_IDS |
string Request to get queue IDs. The message type is: cast.framework.messages.RequestData. |
|
QUEUE_SHUFFLE |
string Request to shuffle the queue. The message type is: cast.framework.messages.RequestData. |
|
SET_CREDENTIALS |
string Set user credential. The message type is: cast.framework.messages.SetCredentialsRequestData. |
|
LOAD_BY_ENTITY |
string Load media by entity ID. The message type is: cast.framework.messages.LoadByEntityRequestData. |
|
USER_ACTION |
string Handle user action like follow. The message type is: cast.framework.messages.UserActionRequestData. |
|
DISPLAY_STATUS |
string Display media status on the screen. The message type is: cast.framework.messages.DisplayStatusRequestData. |
|
FOCUS_STATE |
string The receiver app focus state changed. The message type is: cast.framework.messages.FocusStateRequestData. |
|
CUSTOM_COMMAND |
string Handle custom app command. The message type is: cast.framework.messages.CustomCommandRequestData. |
|
STORE_SESSION |
string Store session command. The message type is: cast.framework.messages.StoreSessionRequestData. |
|
RESUME_SESSION |
string Resume session command. The message type is: cast.framework.messages.ResumeSessionRequestData. |
|
SESSION_STATE |
string Response type for StoreSession. The message type is: cast.framework.messages.StoreSessionResponseData. |
MetadataType
number
Types of media metadata.
Value |
|
|---|---|
|
GENERIC |
number Generic template suitable for most media types. Used by cast.framework.messages.GenericMediaMetadata. |
|
MOVIE |
number A full length movie. Used by cast.framework.messages.MovieMediaMetadata. |
|
TV_SHOW |
number An episode of a TV series. Used by cast.framework.messages.TvShowMediaMetadata. |
|
MUSIC_TRACK |
number A music track. Used by cast.framework.messages.MusicTrackMediaMetadata. |
|
PHOTO |
number Photo. Used by cast.framework.messages.PhotoMediaMetadata. |
|
AUDIOBOOK_CHAPTER |
number Audiobook chapter. Used by cast.framework.messages.AudiobookChapterMediaMetadata. |
- See also
- cast.framework.messages.MediaInformation.metadata
PlayerState
string
Represents the player state.
Value |
|
|---|---|
|
IDLE |
string The player is in IDLE state. An IDLE state means that there is no active playback. The player is usually in this state right after Cast application launch before it gets the LOAD request or after the playback has finished. The player transitions to this state based on the cast.framework.messages.IdleReason set in the cast.framework.messages.MediaStatus. |
|
PLAYING |
string The player is in PLAYING state. |
|
PAUSED |
string The player is in PAUSED state. |
|
BUFFERING |
string The player is in BUFFERING state. |
QueueChangeType
string
Queue change types used by QUEUE_CHANGE outgoing message.
Value |
|
|---|---|
|
INSERT |
string Queue had items inserted. |
|
REMOVE |
string Queue had items removed. |
|
ITEMS_CHANGE |
string A list of items changed. |
|
UPDATE |
string The queue went through an update and a new ordered list is sent. |
|
NO_CHANGE |
string The queue had no change. This is used to echo back when multiple senders ended up requesting the same data. |
QueueType
string
Types of media container/queue.
Value |
|
|---|---|
|
ALBUM |
string Music album. |
|
PLAYLIST |
string Music playlist, such as a private playlist, a public playlist, or an auto-generated playlist. |
|
AUDIOBOOK |
string Audiobook. |
|
RADIO_STATION |
string Traditional radio station. |
|
PODCAST_SERIES |
string Podcast series. |
|
TV_SERIES |
string TV Series. |
|
VIDEO_PLAYLIST |
string Videos playlist. |
|
LIVE_TV |
string Live TV channel. |
|
MOVIE |
string Movie. |
RepeatMode
string
Behavior of the queue when all items have been played.
Value |
|
|---|---|
|
REPEAT_OFF |
string When the queue is completed the media session is terminated. |
|
REPEAT_ALL |
string 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 |
string The current item will be played repeatedly. |
|
REPEAT_ALL_AND_SHUFFLE |
string 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
string
Represents the playback state after a SEEK request.
Value |
|
|---|---|
|
PLAYBACK_START |
string This forces the media to start. |
|
PLAYBACK_PAUSE |
string This forces the media to pause. |
StreamingProtocolType
number
The streaming protocol types.
Value |
|
|---|---|
|
UNKNOWN |
number Unknown streaming protocol type. |
|
MPEG_DASH |
number MPEG-DASH (Dynamic Adaptive Streaming over HTTP) protocol type. |
|
HLS |
number HLS (HTTP Live Streaming) protocol type. |
|
SMOOTH_STREAMING |
number Smooth Streaming protocol type. |
StreamType
string
Represents the stream types.
Value |
|
|---|---|
|
BUFFERED |
string VOD and DVR content. |
|
LIVE |
string Live linear stream content. |
|
NONE |
string |
TextTrackEdgeType
string
Defines the text track edge (border) type.
Value |
|
|---|---|
|
NONE |
string No edge is displayed around text. |
|
OUTLINE |
string A solid outline is displayed around text. |
|
DROP_SHADOW |
string A fading shadow is rendered around text. |
|
RAISED |
string Text appears embossed or raised in relation to the background. |
|
DEPRESSED |
string Text appears to be debossed on the background. |
TextTrackFontGenericFamily
string
Generic font family to be used if the font is not defined in the text track.
Value |
|
|---|---|
|
SANS_SERIF |
string Uses a sans-serif font. |
|
MONOSPACED_SANS_SERIF |
string Uses a monospaced, sans-serif font. |
|
SERIF |
string Uses a serif font. |
|
MONOSPACED_SERIF |
string Uses a monospaced serif font. |
|
CASUAL |
string Uses a casual, handwritten-style font. |
|
CURSIVE |
string Uses a cursive font. |
|
SMALL_CAPITALS |
string Uses a small capitals font. |
TextTrackFontStyle
string
Text track font style.
Value |
|
|---|---|
|
NORMAL |
string The unmodified typeface. |
|
BOLD |
string The bolded style. |
|
BOLD_ITALIC |
string The simultaneously bolded and italicized style. |
|
ITALIC |
string The italicized style. |
TextTrackType
string
Text track type (follows the HTML5 text track type definitions).
Value |
|
|---|---|
|
SUBTITLES |
string Transcription or translation of the dialogue, suitable for when the sound is available but not understood by the viewer, for example, because the viewer does not understand the language of the media resource's soundtrack. |
|
CAPTIONS |
string A transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when the soundtrack is unavailable (for example because it is muted or because the user is hearing-impaired). Captioning is displayed over the video. |
|
DESCRIPTIONS |
string Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is unavailable (for example because the user is interacting with the application without a screen, or because the user is visually-impaired). Descriptions are synthesized as a separate audio track. |
|
CHAPTERS |
string Chapter titles, intended to be used for navigating the media resource. |
|
METADATA |
string Tracks intended for use from a script. |
TextTrackWindowType
string
Text track window type.
Value |
|
|---|---|
|
NONE |
string |
|
NORMAL |
string |
|
ROUNDED_CORNERS |
string |
TrackType
string
Media track type.
Value |
|
|---|---|
|
TEXT |
string Text track. |
|
AUDIO |
string Audio track. |
|
VIDEO |
string Video track. |
UserAction
string
User actions.
Value |
|
|---|---|
|
LIKE |
string User indicates a like preference for the currently playing content. |
|
DISLIKE |
string User indicates a dislike preference for the currently playing content. |
|
FOLLOW |
string User wants to follow or star currently playing content. |
|
UNFOLLOW |
string User wants to stop following currently playing content. |
|
FLAG |
string User flags currently playing content as inappropriate. |
|
SKIP_AD |
string User wants to skip currently playing ad. |
|
LYRICS |
string User wants to display lyrics for the currently playing song. |
UserActionContext
string
Context information for UserAction.
Value |
|
|---|---|
|
UNKNOWN_CONTEXT |
string |
|
TRACK |
string |
|
ALBUM |
string |
|
ARTIST |
string |
|
PLAYLIST |
string |
|
EPISODE |
string |
|
SERIES |
string |
|
MOVIE |
string |
|
CHANNEL |
string |
|
TEAM |
string |
|
PLAYER |
string |
|
COACH |
string |