chrome.
cast
.
media
This is the chrome.cast.media namespace.
Classes
AudiobookChapterMediaMetadata
An audiobook chapter description.
AudiobookContainerMetadata
An audiobook container description.
Break
Represents a break (e.g. ad break) included in the main video.
BreakClip
Represents a break clip (e.g. a clip of an ad during an ad break).
BreakStatus
Represents current status of break.
ContainerMetadata
Common container metadata used as part of QueueData.
EditTracksInfoRequest
A request to modify the text tracks style or change the tracks status. If a trackId does not match the existing trackIds the whole request will fail and no status will change. It is acceptable to change the text track style even if no text track is currently active.
GenericMediaMetadata
A generic media description.
GetStatusRequest
A request to get the media status.
LiveSeekableRange
Provides the live seekable range with start and end time in seconds.
LoadRequest
A request to load new media into the player.
Media
Represents a media item that has been loaded into the receiver application.
MediaInfo
Describes a media item.
MediaMetadata
Common media metadata used as part of MediaInformation or to describe a media section as part of the container metadata.
MovieMediaMetadata
A movie media description.
MusicTrackMediaMetadata
A music track media description.
PauseRequest
A request to pause the currently playing media.
PhotoMediaMetadata
A photo media description.
PlayRequest
A request to play the currently paused media.
QueueData
Queue data as part of the LOAD request.
QueueInsertItemsRequest
A request to insert a list of new media items into the queue.
QueueItem
Represents an item in a media queue.
QueueLoadRequest
A request to load and optionally start playback of a new ordered list of media items.
QueueRemoveItemsRequest
A request to remove a list of items from the queue. If the remaining queue is empty, the media session will be terminated.
QueueReorderItemsRequest
A request to reorder a list of media items in the queue.
QueueUpdateItemsRequest
A request to update properties of the existing items in the media queue.
SeekRequest
A request to seek the current media.
StopRequest
A request to stop the media player.
TextTrackStyle
Describes style information for a text track. Colors are represented as strings “#RRGGBBAA” where XX are the two hexadecimal symbols that represent the 0-255 value for the specific channel/color. It follows CSS 8-digit hex color notation. (See http://dev.w3.org/csswg/css-color/#hex-notation).
Track
Describes track metadata information.
TvShowMediaMetadata
A TV episode media description.
UserActionState
Represent User Action state for media.
VastAdsRequest
VAST ad request configuration.
VideoInformation
Video information such as video resolution and High Dynamic Range (HDR).
VolumeRequest
A request to set the stream volume of the playing media.
Namespace
timeout
Enumerations
ContainerType
number
Possible types of container metadata.
Value
GENERIC_CONTAINER
number
Generic template suitable for most media types. Used by chrome.cast.media.ContainerMetadata.
AUDIOBOOK_CONTAINER
number
Metadata for an audiobook. Used by chrome.cast.media.AudiobookContainerMetadata.
- See also
- chrome.cast.media.QueueData.containerMetadata
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
Format of an HLS audio segment.
Value
AAC
string
AC3
string
MP3
string
TS
string
TS_AAC
string
E_AC3
string
FMP4
string
HlsVideoSegmentFormat
string
Format of HLS video segment.
Value
MPEG2_TS
string
MPEG2 TS format.
FMP4
string
Fragmented MP4.
IdleReason
string
Possible reason why a media is idle.
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 be for example if the player could not download media due to networking errors.
MediaCommand
string
Possible media commands supported by the receiver application.
Value
PAUSE
string
SEEK
string
STREAM_VOLUME
string
STREAM_MUTE
string
MetadataType
number
Possible types of media metadata.
Value
GENERIC
number
Generic template suitable for most media types. Used by chrome.cast.media.GenericMediaMetadata.
MOVIE
number
A full length movie. Used by chrome.cast.media.MovieMediaMetadata.
TV_SHOW
number
An episode of a TV series. Used by chrome.cast.media.TvShowMediaMetadata.
MUSIC_TRACK
number
A music track. Used by chrome.cast.media.MusicTrackMediaMetadata.
PHOTO
number
Photo. Used by chrome.cast.media.PhotoMediaMetadata.
AUDIOBOOK_CHAPTER
number
Audiobook chapter. Used by chrome.cast.media.AudiobookChapterMediaMetadata.
PlayerState
string
Possible states of the media player.
Value
IDLE
string
No media is loaded into the player.
PLAYING
string
The media is playing.
PAUSED
string
The media is not playing.
BUFFERING
string
Player is in PLAY mode but not actively playing content. currentTime will not change.
QueueType
string
Types of media container/queue.
Value
ALBUM
string
Music album.
PLAYLIST
string
Music playlist, such as private playlist, public playlist, auto-generated playlist, etc.
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
Possible states of queue repeat mode.
Value
OFF
string
Items are played in order, and when the queue is completed (the last item has ended) the media session is terminated.
ALL
string
The items in the queue will be played indefinitely. When the last item has ended, the first item will be played again.
SINGLE
string
The current item will be repeated indefinitely.
ALL_AND_SHUFFLE
string
The items in the queue will be played indefinitely. When the last item has ended, the list of items will be randomly shuffled by the receiver, and the queue will continue to play starting from the first item of the shuffled items.
ResumeState
string
States of the media player after resuming.
Value
PLAYBACK_START
string
Force media to start.
PLAYBACK_PAUSE
string
Force media to pause.
StreamType
string
Possible media stream types.
Value
BUFFERED
string
Stored media streamed from an existing data store.
LIVE
string
Live media generated on the fly.
OTHER
string
None of the above.
TextTrackEdgeType
string
Possible text track edge types.
Value
NONE
string
OUTLINE
string
DROP_SHADOW
string
RAISED
string
DEPRESSED
string
TextTrackFontGenericFamily
string
Possible text track font generic family.
Value
SANS_SERIF
string
MONOSPACED_SANS_SERIF
string
SERIF
string
MONOSPACED_SERIF
string
CASUAL
string
CURSIVE
string
SMALL_CAPITALS
string
TextTrackFontStyle
string
Possible text track font style.
Value
NORMAL
string
BOLD
string
BOLD_ITALIC
string
ITALIC
string
TextTrackType
string
Possible text track types.
Value
SUBTITLES
string
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
string
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
string
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
string
Chapter titles, intended to be used for navigating the media resource.
METADATA
string
Tracks intended for use from script.
TextTrackWindowType
string
Possible text track window types.
Value
NONE
string
NORMAL
string
ROUNDED_CORNERS
string
TrackType
string
Possible media track types.
Value
TEXT
string
AUDIO
string
VIDEO
string
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.
Properties
ContainerType
number
Possible types of container metadata.
Value
GENERIC_CONTAINER
number
Generic template suitable for most media types. Used by chrome.cast.media.ContainerMetadata.
AUDIOBOOK_CONTAINER
number
Metadata for an audiobook. Used by chrome.cast.media.AudiobookContainerMetadata.
- See also
- chrome.cast.media.QueueData.containerMetadata
DEFAULT_MEDIA_RECEIVER_APP_ID
string
The app ID of the default media player.
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
Format of an HLS audio segment.
Value
AAC
string
AC3
string
MP3
string
TS
string
TS_AAC
string
E_AC3
string
FMP4
string
HlsVideoSegmentFormat
string
Format of HLS video segment.
Value
MPEG2_TS
string
MPEG2 TS format.
FMP4
string
Fragmented MP4.
IdleReason
string
Possible reason why a media is idle.
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 be for example if the player could not download media due to networking errors.
MediaCommand
string
Possible media commands supported by the receiver application.
Value
PAUSE
string
SEEK
string
STREAM_VOLUME
string
STREAM_MUTE
string
MetadataType
number
Possible types of media metadata.
Value
GENERIC
number
Generic template suitable for most media types. Used by chrome.cast.media.GenericMediaMetadata.
MOVIE
number
A full length movie. Used by chrome.cast.media.MovieMediaMetadata.
TV_SHOW
number
An episode of a TV series. Used by chrome.cast.media.TvShowMediaMetadata.
MUSIC_TRACK
number
A music track. Used by chrome.cast.media.MusicTrackMediaMetadata.
PHOTO
number
Photo. Used by chrome.cast.media.PhotoMediaMetadata.
AUDIOBOOK_CHAPTER
number
Audiobook chapter. Used by chrome.cast.media.AudiobookChapterMediaMetadata.
PlayerState
string
Possible states of the media player.
Value
IDLE
string
No media is loaded into the player.
PLAYING
string
The media is playing.
PAUSED
string
The media is not playing.
BUFFERING
string
Player is in PLAY mode but not actively playing content. currentTime will not change.
QueueType
string
Types of media container/queue.
Value
ALBUM
string
Music album.
PLAYLIST
string
Music playlist, such as private playlist, public playlist, auto-generated playlist, etc.
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
Possible states of queue repeat mode.
Value
OFF
string
Items are played in order, and when the queue is completed (the last item has ended) the media session is terminated.
ALL
string
The items in the queue will be played indefinitely. When the last item has ended, the first item will be played again.
SINGLE
string
The current item will be repeated indefinitely.
ALL_AND_SHUFFLE
string
The items in the queue will be played indefinitely. When the last item has ended, the list of items will be randomly shuffled by the receiver, and the queue will continue to play starting from the first item of the shuffled items.
ResumeState
string
States of the media player after resuming.
Value
PLAYBACK_START
string
Force media to start.
PLAYBACK_PAUSE
string
Force media to pause.
StreamType
string
Possible media stream types.
Value
BUFFERED
string
Stored media streamed from an existing data store.
LIVE
string
Live media generated on the fly.
OTHER
string
None of the above.
TextTrackEdgeType
string
Possible text track edge types.
Value
NONE
string
OUTLINE
string
DROP_SHADOW
string
RAISED
string
DEPRESSED
string
TextTrackFontGenericFamily
string
Possible text track font generic family.
Value
SANS_SERIF
string
MONOSPACED_SANS_SERIF
string
SERIF
string
MONOSPACED_SERIF
string
CASUAL
string
CURSIVE
string
SMALL_CAPITALS
string
TextTrackFontStyle
string
Possible text track font style.
Value
NORMAL
string
BOLD
string
BOLD_ITALIC
string
ITALIC
string
TextTrackType
string
Possible text track types.
Value
SUBTITLES
string
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
string
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
string
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
string
Chapter titles, intended to be used for navigating the media resource.
METADATA
string
Tracks intended for use from script.
TextTrackWindowType
string
Possible text track window types.
Value
NONE
string
NORMAL
string
ROUNDED_CORNERS
string
TrackType
string
Possible media track types.
Value
TEXT
string
AUDIO
string
VIDEO
string
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.