Namespace: messages

Stay organized with collections Save and categorize content based on your preferences.

Classes

Enumerations

CaptionMimeType

static

string

Caption MIME type of text track.

Value

CEA608

string

CEA 608

TTML

string

TTML

VTT

string

VTT

TTML_MP4

string

TTML MP4

Command

static

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 PAUSE, SEEK, STREAM_VOLUME, STREAM_MUTE, EDIT_TRACKS, and PLAYBACK_RATE.

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.

ContainerType

static

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

static

string

Represents the content-filtering mode.

Value

FILTER_EXPLICIT

string

Do not play explicit content.

ErrorReason

static

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.

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

static

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

static

string

Extended player state information.

Value

LOADING

string

The player is in LOADING state.

FocusState

static

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

static

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

static

string

Represents video High Dynamic Range (HDR) types.

Value

SDR

string

Standard Dynamic Range.

HDR

string

High Dynamic Range.

DV

string

Dolby Vision.

HlsSegmentFormat

static

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

static

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

static

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

static

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

static

string

Represents media message types.

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 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

string

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

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

static

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

static

string

Represents the player state.

Value

IDLE

string

The player is in IDLE state.

PLAYING

string

The player is in PLAYING state.

PAUSED

string

The player is in PAUSED state.

BUFFERING

string

The player is in BUFFERING state.

PlayStringId

static

string

String IDs used by cast.framework.PlayerManager#playString

Value

FREE_TRIAL_ABOUT_TO_EXPIRE

string

String that contains a message for when a free trial is about to expire.

SUBSCRIPTION_ABOUT_TO_EXPIRE

string

String that contains a message for when a subscription is about to expire.

STREAM_HIJACKED

string

String that contains a message for when the resource or account is playing content on another device.

PLAYING_ALTERNATE_MIX

string

String that contains a message for when the requested media is not available to play due to content filters.

QueueChangeType

static

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

static

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

static

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

static

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

static

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

static

string

Represents the stream types.

Value

BUFFERED

string

VOD and DVR content.

LIVE

string

Live linear stream content.

NONE

string

TextTrackEdgeType

static

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

static

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

static

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

static

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

static

string

Text track window type.

Value

NONE

string

NORMAL

string

ROUNDED_CORNERS

string

TrackType

static

string

Media track type.

Value

TEXT

string

Text track.

AUDIO

string

Audio track.

VIDEO

string

Video track.

UserAction

static

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.

UserActionContext

static

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

static

string

Caption MIME type of text track.

Value

CEA608

string

CEA 608

TTML

string

TTML

VTT

string

VTT

TTML_MP4

string

TTML MP4

Command

static

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 PAUSE, SEEK, STREAM_VOLUME, STREAM_MUTE, EDIT_TRACKS, and PLAYBACK_RATE.

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.

ContainerType

static

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

static

string

Represents the content-filtering mode.

Value

FILTER_EXPLICIT

string

Do not play explicit content.

ErrorReason

static

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.

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

static

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

static

string

Extended player state information.

Value

LOADING

string

The player is in LOADING state.

FocusState

static

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

static

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

static

string

Represents video High Dynamic Range (HDR) types.

Value

SDR

string

Standard Dynamic Range.

HDR

string

High Dynamic Range.

DV

string

Dolby Vision.

HlsSegmentFormat

static

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

static

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

static

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

static

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

static

string

Represents media message types.

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 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

string

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

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

static

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

static

string

Represents the player state.

Value

IDLE

string

The player is in IDLE state.

PLAYING

string

The player is in PLAYING state.

PAUSED

string

The player is in PAUSED state.

BUFFERING

string

The player is in BUFFERING state.

PlayStringId

static

string

String IDs used by cast.framework.PlayerManager#playString

Value

FREE_TRIAL_ABOUT_TO_EXPIRE

string

String that contains a message for when a free trial is about to expire.

SUBSCRIPTION_ABOUT_TO_EXPIRE

string

String that contains a message for when a subscription is about to expire.

STREAM_HIJACKED

string

String that contains a message for when the resource or account is playing content on another device.

PLAYING_ALTERNATE_MIX

string

String that contains a message for when the requested media is not available to play due to content filters.

QueueChangeType

static

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

static

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

static

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

static

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

static

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

static

string

Represents the stream types.

Value

BUFFERED

string

VOD and DVR content.

LIVE

string

Live linear stream content.

NONE

string

TextTrackEdgeType

static

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

static

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

static

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

static

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

static

string

Text track window type.

Value

NONE

string

NORMAL

string

ROUNDED_CORNERS

string

TrackType

static

string

Media track type.

Value

TEXT

string

Text track.

AUDIO

string

Audio track.

VIDEO

string

Video track.

UserAction

static

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.

UserActionContext

static

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