Google Cast Media Player Library Reference (Beta)

cast.player.api.VERSION

Version of the cast media player library.

cast.player.api.setLoggerLevel

static void cast.player.api.setLoggerLevel(level)

Sets logging verbosity level.

Parameters:
cast.player.api.LoggerLevel level: The logging level.

player.StreamingProtocol#getStreamCount

number getStreamCount()

Gets the stream count for the media.

Returns:: number Stream count.

player.StreamingProtocol#getStreamInfo

cast.player.api.StreamInfo getStreamInfo(streamIndex)

Gets stream information that includes codecs, mime type, and bitrates.
Must not be null.

Parameters:
number streamIndex: Stream index.

Returns:: cast.player.api.StreamInfo Stream information. Must not be null.

player.StreamingProtocol#enableStream

void enableStream(streamIndex, enable)

Sets the enabled state of the stream.

Parameters:
number streamIndex: Stream index.
boolean enable: Whether to enable or disable the stream.

player.StreamingProtocol#isStreamEnabled

boolean isStreamEnabled(streamIndex)

Gets the enabled state of the stream.

Parameters:
number streamIndex: Stream index.

Returns:: boolean Whether the stream is enabled or disabled.

player.StreamingProtocol#getQualityLevel

number getQualityLevel(streamIndex)

Gets the quality level used to play the stream.

Parameters:
number streamIndex: Stream index.

Returns:: number Adaptive bitrate quality level.

cast.player.api.CaptionsType

Captions type.

Values	CEA608 TTML WEBVTT

cast.player.api.ContentProtection

Content protection type.

Values	CLEARKEY PLAYREADY WIDEVINE

cast.player.api.ErrorCode

Errors that can be reported by the player to the host.

Values	MANIFEST MEDIAKEYS NETWORK PLAYBACK

cast.player.api.HlsSegmentFormat

The format of HLS media segment.

Values	MPEG2_TS MPEG_AUDIO_ES

cast.player.api.Host

Host is used by the player for interacting with the application.

Functions
Properties	autoPauseDuration autoResumeDuration getQualityLevel initialBandwidth licenseCustomData licenseUrl mediaElement onError prepareLicenseRequest processLicense processMetadata trackBandwidth updateCaptionsRequestInfo updateLicenseRequestInfo updateManifestRequestInfo updateSegmentRequestInfo url

cast.player.api.LoggerLevel

Represents logger levels.

Values	DEBUG ERROR INFO NONE

cast.player.api.Player

Communicates with the media element and media source.

Functions	load unload reload getState getBufferDuration startLicenseRequest enableCaptions

cast.player.api.RequestInfo

XML HTTP request information.

Properties	content contentProtection headers timeoutInterval url withCredentials

cast.player.api.RequestStatus

Network request status information.

Properties	errorCode status url

Properties	bitrates codecs language mimeType

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated July 16, 2014.

Google Cast