Google Cast Chrome Sender API Reference

chrome.cast.VERSION

The API version.

chrome.cast.timeout

Default timeout values in milliseconds for API methods.

chrome.cast.isAvailable

Flag for clients to check whether the API is loaded.

chrome.cast.initialize

static void chrome.cast.initialize(apiConfig, successCallback, errorCallback)

Initializes the API. Note that either successCallback and errorCallback will be invoked once the API has finished initialization. The sessionListener and receiverListener may be invoked at any time afterwards, and possibly more than once.

Parameters:
chrome.cast.ApiConfig apiConfig: The object with parameters to initialize the API. Must not be null.
function() successCallback
function(chrome.cast.Error) errorCallback: The possible errors are TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

chrome.cast.requestSession

static void chrome.cast.requestSession(successCallback, errorCallback, opt_sessionRequest)

Requests that a receiver application session be created or joined. By default, the SessionRequest passed to the API at initialization time is used; this may be overridden by passing a different session request in opt_sessionRequest.

Parameters:
function(chrome.cast.Session) successCallback
function(chrome.cast.Error) errorCallback: The possible errors are TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE, and EXTENSION_MISSING. Note that the timeout timer starts after users select a receiver. Selecting a receiver requires user's action, which has no timeout.
chrome.cast.SessionRequest opt_sessionRequest: Optional.

chrome.cast.logMessage

static void chrome.cast.logMessage(message)

Logs a debug message from the app. This message may be sent in a feedback report to Google if users explicitly choose to include fine logs.

Parameters:
string message: The message to log.

chrome.cast.setCustomReceivers

static void chrome.cast.setCustomReceivers(receivers, successCallback, errorCallback)

Sets custom receiver list

Parameters:
Array of chrome.cast.Receiver receivers: The new list. Must not be null.
function() successCallback
function(chrome.cast.Error) errorCallback: The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, and EXTENSION_MISSRING.

chrome.cast.ApiConfig

Holds the configuraton for the API when initialized.

Properties	autoJoinPolicy customDialLaunchCallback defaultActionPolicy receiverListener sessionListener sessionRequest

chrome.cast.AutoJoinPolicy

Auto-join policy determines when the SDK will automatically connect a sender application to an existing session after API initialization.

Values	ORIGIN_SCOPED PAGE_SCOPED TAB_AND_ORIGIN_SCOPED

chrome.cast.Capability

Capabilities that are supported by the receiver device.

Values	AUDIO_IN AUDIO_OUT VIDEO_IN VIDEO_OUT

chrome.cast.DefaultActionPolicy

Default action policy determines when the SDK will automatically create a session after initializing the API.

Values	CAST_THIS_TAB CREATE_SESSION

chrome.cast.DialAppState

Possible states of a DIAL application.

Values	ERROR RUNNING STOPPED

chrome.cast.DialLaunchData

An object passed to customDialLaunchCallback after users select a DIAL receiver.

Properties	appState extraData receiver

chrome.cast.DialLaunchResponse

An object returned by customDialLaunchCallback to indicate whether app wants extension to do a DIAL launch or not.

Properties	doLaunch launchParameter

chrome.cast.DialRequest

A request to start a DIAL app.

Properties	appName launchParameter

chrome.cast.Error

Describes an error returned by the API.

Properties	code description details

chrome.cast.ErrorCode

Errors that may be returned by the SDK.

Values	API_NOT_INITIALIZED CANCEL CHANNEL_ERROR EXTENSION_MISSING EXTENSION_NOT_COMPATIBLE INVALID_PARAMETER LOAD_MEDIA_FAILED RECEIVER_UNAVAILABLE SESSION_ERROR TIMEOUT

chrome.cast.Image

An image that describes a receiver application or media item.

Properties	height url width

chrome.cast.media.GenericMediaMetadata

A generic media description.

Properties	images metadataType releaseDate releaseYear subtitle title type

chrome.cast.media.IdleReason

Possible reason why a media is idle.

Values	CANCELLED ERROR FINISHED INTERRUPTED

chrome.cast.media.LoadRequest

A request to load new media into the player.

Properties	autoplay currentTime customData media requestId type

chrome.cast.media.Media

Represents a media item that has been loaded into the receiver application.

Functions	play pause seek stop setVolume supportsCommand getEstimatedTime addUpdateListener removeUpdateListener
Properties	currentTime customData idleReason lastCurrentTimeUpdate media mediaSessionId playbackRate playerState sessionId supportedMediaCommands volume

chrome.cast.media.MediaCommand

Possible media commands supported by the receiver application.

Values	PAUSE SEEK STREAM_MUTE STREAM_VOLUME

chrome.cast.media.MediaInfo

Describes a media item.

Properties	contentId contentType customData duration metadata streamType

chrome.cast.media.MetadataType

Possible types of media metadata.

Values	GENERIC MOVIE MUSIC_TRACK PHOTO TV_SHOW

chrome.cast.media.MovieMediaMetadata

A movie media description.

Properties	images metadataType releaseDate releaseYear studio subtitle title type

chrome.cast.media.MusicTrackMediaMetadata

A music track media description.

Properties	albumArtist albumName artist artistName composer discNumber images metadataType releaseDate releaseYear songName title trackNumber type

chrome.cast.media.PauseRequest

A request to pause the currently playing media.

Properties	customData

chrome.cast.media.PhotoMediaMetadata

A photo media description.

Properties	artist creationDateTime height images latitude location longitude metadataType title type width

chrome.cast.media.PlayerState

Possible states of the media player.

Values	BUFFERING IDLE PAUSED PLAYING

chrome.cast.media.PlayRequest

A request to play the currently paused media.

Properties	customData

chrome.cast.media.ResumeState

States of the media player after resuming.

Values	PLAYBACK_PAUSE PLAYBACK_START

chrome.cast.media.SeekRequest

A request to seek the current media.

Properties	currentTime customData resumeState

chrome.cast.media.StopRequest

A request to stop the media player.

Properties	customData

chrome.cast.media.StreamType

Possible media stream types.

Values	BUFFERED LIVE OTHER

chrome.cast.media.timeout

Default timeout values in milliseconds for media API methods.

Properties	load pause play seek setVolume stop

chrome.cast.media.TvShowMediaMetadata

A TV episode media description.

Properties	episode episodeNumber episodeTitle images metadataType originalAirdate releaseYear season seasonNumber seriesTitle title type

chrome.cast.media.VolumeRequest

A request to set the stream volume of the playing media.

Properties	customData volume

chrome.cast.Receiver

Describes the receiver running an application.

Properties	capabilities friendlyName isActiveInput label receiverType volume

chrome.cast.ReceiverAvailability

Describes availability of a Cast receiver.

Values	AVAILABLE UNAVAILABLE

chrome.cast.ReceiverType

Values	CAST CUSTOM DIAL

chrome.cast.SenderApplication

Describes a sender application.

Properties	packageId platform url

chrome.cast.SenderPlatform

Describes a sender application platform.

Values	ANDROID CHROME IOS

chrome.cast.Session

Describes the state of a currently running Cast application.

Functions	setReceiverVolumeLevel setReceiverMuted stop sendMessage addUpdateListener removeUpdateListener addMessageListener removeMessageListener addMediaListener removeMediaListener loadMedia
Properties	appId appImages customData displayName media namespaces receiver senderApps sessionId statusText CUSTOM_RECEIVER_SESSION_ID