Classes

Namespaces

Enumerations

AutoJoinPolicy

static

string

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

Value

TAB_AND_ORIGIN_SCOPED

Automatically connects when the session was started with the same appId, in the same tab and page origin.

ORIGIN_SCOPED

Automatically connects when the session was started with the same appId and the same page origin (regardless of tab).

PAGE_SCOPED

No automatic connection.

Capability

static

string

Capabilities that are supported by the receiver device.

Value

VIDEO_OUT

The receiver supports video output.

AUDIO_OUT

The receiver supports audio output.

VIDEO_IN

The receiver supports video input (camera).

AUDIO_IN

The receiver supports audio input (microphone).

MULTIZONE_GROUP

The receiver represents a multi-zone group.

DefaultActionPolicy

static

string

Default action policy determines when the SDK will automatically create a session after initializing the API. This also controls the default action for the tab in the extension popup.

Value

CREATE_SESSION

If the tab containing the app is being casted when the API initializes, the SDK stops tab casting and automatically launches the app. The extension popup prompts the user to cast the app.

CAST_THIS_TAB

No automatic launch is done after initializing the API, even if the tab is being cast. The extension popup prompts the user to cast the tab.

DialAppState

static

string

Possible states of a DIAL application.

Value

RUNNING

STOPPED

ERROR

Not part of the spec, used to signal errors.

ErrorCode

static

string

Errors that may be returned by the SDK.

Value

CANCEL

The operation was canceled by the user.

TIMEOUT

The operation timed out.

API_NOT_INITIALIZED

The API is not initialized.

INVALID_PARAMETER

The parameters to the operation were not valid.

EXTENSION_NOT_COMPATIBLE

The API script is not compatible with the installed Cast extension.

EXTENSION_MISSING

The Cast extension is not available.

RECEIVER_UNAVAILABLE

No receiver was compatible with the session request.

SESSION_ERROR

A session could not be created, or a session was invalid.

CHANNEL_ERROR

A channel to the receiver is not available.

LOAD_MEDIA_FAILED

Load media failed.

ReceiverAction

static

string

Actions that the user can take on a receiver in the extension. These can be used to show a transition in the sender application UI before the casting action has fully completed (or failed).

Value

CAST

The user selected a receiver with the intent of casting to it with the sender application. The exact identity of the receiver may not be known.

STOP

The user requested to stop the session running on a receiver.

ReceiverAvailability

static

string

Describes availability of a Cast receiver.

Value

AVAILABLE

At least one receiver is available that is compatible with the session request.

UNAVAILABLE

No receivers are available.

ReceiverType

static

string

Value

CAST

Cast receiver, e.g. Chromecast

DIAL

DIAL device, e.g. smart TV

HANGOUT

Hangout

CUSTOM

Custom receiver provided by client

SenderPlatform

static

string

Describes a sender application platform.

Value

CHROME

IOS

ANDROID

SessionStatus

static

string

Describes status of a Cast session to its receiver application.

Value

CONNECTED

The session is connected to the receiver application.

DISCONNECTED

The session is disconnected from the receiver application. The receiver application may or may not still be running.

STOPPED

The receiver application has been stopped.

VolumeControlType

static

string

Describes types of volume control.

Value

ATTENUATION

Cast device volume can be changed.

FIXED

Cast device volume is fixed and cannot be changed.

MASTER

Master system volume control, i.e. TV or Audio device volume is changed.

Properties

AutoJoinPolicy

static

string

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

Value

TAB_AND_ORIGIN_SCOPED

Automatically connects when the session was started with the same appId, in the same tab and page origin.

ORIGIN_SCOPED

Automatically connects when the session was started with the same appId and the same page origin (regardless of tab).

PAGE_SCOPED

No automatic connection.

Capability

static

string

Capabilities that are supported by the receiver device.

Value

VIDEO_OUT

The receiver supports video output.

AUDIO_OUT

The receiver supports audio output.

VIDEO_IN

The receiver supports video input (camera).

AUDIO_IN

The receiver supports audio input (microphone).

MULTIZONE_GROUP

The receiver represents a multi-zone group.

DefaultActionPolicy

static

string

Default action policy determines when the SDK will automatically create a session after initializing the API. This also controls the default action for the tab in the extension popup.

Value

CREATE_SESSION

If the tab containing the app is being casted when the API initializes, the SDK stops tab casting and automatically launches the app. The extension popup prompts the user to cast the app.

CAST_THIS_TAB

No automatic launch is done after initializing the API, even if the tab is being cast. The extension popup prompts the user to cast the tab.

DialAppState

static

string

Possible states of a DIAL application.

Value

RUNNING

STOPPED

ERROR

Not part of the spec, used to signal errors.

ErrorCode

static

string

Errors that may be returned by the SDK.

Value

CANCEL

The operation was canceled by the user.

TIMEOUT

The operation timed out.

API_NOT_INITIALIZED

The API is not initialized.

INVALID_PARAMETER

The parameters to the operation were not valid.

EXTENSION_NOT_COMPATIBLE

The API script is not compatible with the installed Cast extension.

EXTENSION_MISSING

The Cast extension is not available.

RECEIVER_UNAVAILABLE

No receiver was compatible with the session request.

SESSION_ERROR

A session could not be created, or a session was invalid.

CHANNEL_ERROR

A channel to the receiver is not available.

LOAD_MEDIA_FAILED

Load media failed.

isAvailable

static

boolean

Flag for clients to check whether the API is loaded.

ReceiverAction

static

string

Actions that the user can take on a receiver in the extension. These can be used to show a transition in the sender application UI before the casting action has fully completed (or failed).

Value

CAST

The user selected a receiver with the intent of casting to it with the sender application. The exact identity of the receiver may not be known.

STOP

The user requested to stop the session running on a receiver.

ReceiverAvailability

static

string

Describes availability of a Cast receiver.

Value

AVAILABLE

At least one receiver is available that is compatible with the session request.

UNAVAILABLE

No receivers are available.

ReceiverType

static

string

Value

CAST

Cast receiver, e.g. Chromecast

DIAL

DIAL device, e.g. smart TV

HANGOUT

Hangout

CUSTOM

Custom receiver provided by client

SenderPlatform

static

string

Describes a sender application platform.

Value

CHROME

IOS

ANDROID

SessionStatus

static

string

Describes status of a Cast session to its receiver application.

Value

CONNECTED

The session is connected to the receiver application.

DISCONNECTED

The session is disconnected from the receiver application. The receiver application may or may not still be running.

STOPPED

The receiver application has been stopped.

timeout

static

non-null chrome.cast.Timeout

Default timeout values in milliseconds for API methods.

VERSION

constant   static

non-null Array of number

The API version. The first number is the major version, and the second the minor version.

VolumeControlType

static

string

Describes types of volume control.

Value

ATTENUATION

Cast device volume can be changed.

FIXED

Cast device volume is fixed and cannot be changed.

MASTER

Master system volume control, i.e. TV or Audio device volume is changed.

Methods

addReceiverActionListener

static

addReceiverActionListener(listener)

Adds a listener function that will be invoked when the user has acted through the UI to start or stop casting. The sender application can use this to show a transition in its user interface (i.e., pause locally playing media) before the casting action has completed or failed.

  • The listener is not guaranteed to be invoked and applications should not rely on it to function correctly.
  • The listener will be passed the receiver that was acted upon, if available. However the receiver may not be known and null will be passed instead.
  • The listener will be called as soon as possible after the user has acted. It should be invoked before the application is notified of the resulting state change through the API.

If using Framework API, use cast.framework.CastContext#addEventListener instead and listen to cast.framework.CastContextEventType#CAST_STATE_CHANGED events.

Parameter

listener

chrome.cast.ReceiverActionListener

The listener function to add. The first argument to the listener is the receiver that was acted on. The second argument to the listener is the action that was requested (see chrome.cast.ReceiverAction).

initialize

static

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.

If using Framework API, use cast.framework.CastContext#setOptions instead of this function.

Parameter

apiConfig

chrome.cast.ApiConfig

The object with parameters to initialize the API.

Value must not be null.

successCallback

function()

errorCallback

function(chrome.cast.Error)

The possible errors are TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

static

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.

Parameter

message

string

The message to log.

Deprecated
Not supported with Presentation API based Cast SDK.

precache

static

precache(data)

Send a request to precache data. If a session is connected it will send a direct request, otherwise it will send to all devices in the network.

Parameter

data

string

Data to precache.

removeReceiverActionListener

static

removeReceiverActionListener(listener)

Removes a listener function that was previously added with addReceiverActionListener.

Parameter

listener

chrome.cast.ReceiverActionListener

The listener function to remove.

requestSession

static

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.

If using Framework API, use cast.framework.CastContext#requestSession instead of this function.

Parameter

successCallback

function(non-null chrome.cast.Session)

errorCallback

function(chrome.cast.Error)

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. If a session request is already in progress, errorCallback is invoked with INVALID_PARAMETER error code and a description explaining the error.

opt_sessionRequest

Optional

chrome.cast.SessionRequest

requestSessionById

static

requestSessionById(sessionId)

Requests to join an existing session with the given id. Once joined, the session will be passed to the sessionListener set by chrome.cast.initialize.

If the session with the given sessionId is already known when this function is called, then sessionListener is called immediately. Otherwise, once a session with the given sessionId is discovered, sessionListener will be called.

Parameter

sessionId

string

The id of the session to join.

setCustomReceivers

static

setCustomReceivers(receivers, successCallback, errorCallback)

Sets custom receiver list

Parameter

receivers

Array of chrome.cast.Receiver

The new list.

Value must not be null.

successCallback

function()

errorCallback

function(chrome.cast.Error)

The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, and EXTENSION_MISSRING.

Deprecated
Not supported with Presentation API based Cast SDK.

setPageContext

static

setPageContext(win)

Initializes Cast functionality for a page that loads Cast SDK in an iframe. Should be called after the SDK was initialized.

Parameter

win

Window

Page window object.

Value must not be null.

setReceiverDisplayStatus

static

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Sets the receiver name and display status. To show the receiver as idle, set displayStatus to null.

Only valid for CUSTOM receivers. The receiver's displayStatus is ignored if this receiver is CAST; Cast receiver status is updated by the receiver application.

Parameter

receiver

chrome.cast.Receiver

The receiver.

Value must not be null.

successCallback

function()

Callback when setting status succeeds.

errorCallback

function(chrome.cast.Error)

The possible errors are TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, and EXTENSION_MISSING.

Deprecated
Not supported with Presentation API based Cast SDK.

unescape

static

unescape(escaped) returns string

Utility method to unescape URI-escaped strings. For example, the receiver friendly name is returned as an URI-escaped string. Use this method to unescape that string if needed.

Parameter

escaped

string

A string to unescape

Returns

string Unescaped string

Abstract type

ReceiverActionListener

static

ReceiverActionListener()