Google Cast Receiver API Reference

cast.receiver.VERSION

Version of the cast SDK.

cast.receiver.logger

The Cast receiver logger object.

cast.receiver.logger.setLevelValue

static void cast.receiver.logger.setLevelValue(value)

Sets the log verbosity level.

Parameters:
cast.receiver.LoggerLevel value: The logging level.

cast.receiver.media.MEDIA_NAMESPACE

The media namespace.

cast.receiver.CastChannel

Handles cast messages for a specific sender and namespace (it is a point to point communications channel).

Classes	Event
Functions	getNamespace getSenderId send
Properties	onClose onMessage
Enums	EventType

cast.receiver.CastChannel.Event

Event raised by the CastChannel.

Properties	message

cast.receiver.CastChannel.EventType

System events dispatched by {@code cast.receiver.CastChannel}.

Values	CLOSE MESSAGE

cast.receiver.CastMessageBus

Handles cast messages for a specific namespace.

Classes	Event
Functions	getNamespace getMessageType send broadcast getCastChannel
Properties	deserializeMessage onMessage serializeMessage
Enums	EventType MessageType

cast.receiver.CastMessageBus.Event

Event raised when a new message is received on the message bus for a specific namespace.

Properties	data senderId

cast.receiver.CastMessageBus.EventType

Events dispatched by {@code cast.receiver.CastMessageBus}.

Values	MESSAGE

cast.receiver.CastMessageBus.MessageType

Message types used by {@code cast.receiver.CastMessageBus}.

Values	CUSTOM JSON STRING

cast.receiver.CastReceiverManager

The receiver manager allows communication with the platform and is used to to send/receive system messages/events.

Classes	Config Event ReadyEvent SenderConnectedEvent SenderDisconnectedEvent ShutdownEvent StandbyChangedEvent SystemVolumeChangedEvent VisibilityChangedEvent
Functions	start stop isSystemReady getSenders getSender getVisibilityState getStandbyState getApplicationData getDeviceCapabilities setApplicationState setInactivityTimeout getCastMessageBus getInstance
Properties	onReady onSenderConnected onSenderDisconnected onShutdown onStandbyChanged onSystemVolumeChanged onVisibilityChanged
Enums	EventType

cast.receiver.CastReceiverManager.Config

Application configuration parameters.

Properties	maxInactivity statusText

cast.receiver.CastReceiverManager.Event

Event dispatched by {@code cast.receiver.CastReceiverManager} which contains system information.

Properties	data

cast.receiver.CastReceiverManager.EventType

System events dispatched by {@code cast.receiver.CastReceiverManager}.

Values	ERROR READY SENDER_CONNECTED SENDER_DISCONNECTED SHUTDOWN STANDBY_CHANGED SYSTEM_VOLUME_CHANGED VISIBILITY_CHANGED

cast.receiver.CastReceiverManager.ReadyEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when the system is ready.

Properties	data

cast.receiver.CastReceiverManager.SenderConnectedEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when a sender is connected.

Properties	senderId userAgent

cast.receiver.CastReceiverManager.SenderDisconnectedEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when a sender is disconnected.

Properties	reason senderId userAgent

cast.receiver.CastReceiverManager.ShutdownEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when the application is shutdown.

cast.receiver.CastReceiverManager.StandbyChangedEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when the TV enters/leaves the standby state.

Properties	isStandby

cast.receiver.CastReceiverManager.SystemVolumeChangedEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when the system volume changes.

Properties	data

cast.receiver.CastReceiverManager.VisibilityChangedEvent

Event dispatched by {@code cast.receiver.CastReceiverManager} when the visibility of the application changes (HDMI input change, TV is turned off).

Properties	isVisible

cast.receiver.LoggerLevel

Represents logger levels.

Values	DEBUG ERROR INFO NONE VERBOSE WARNING

cast.receiver.media.Command

Commands supported by {@code cast.receiver.MediaManager}.

Values	ALL_BASIC_MEDIA PAUSE QUEUE_NEXT QUEUE_PREV SEEK STREAM_MUTE STREAM_VOLUME

cast.receiver.media.ErrorReason

Represents media error message reasons.

Values	DUPLICATE_REQUEST_ID INVALID_COMMAND INVALID_MEDIA_SESSION_ID INVALID_PARAMS

cast.receiver.media.ErrorType

Represents media error message types.

Values	INVALID_PLAYER_STATE INVALID_REQUEST LOAD_CANCELLED LOAD_FAILED

cast.receiver.media.IdleReason

The reason for the player to be in IDLE state.

Values	CANCELLED ERROR FINISHED INTERRUPTED

cast.receiver.media.MediaInformation

Represents the media information.

Properties	contentId contentType customData duration metadata streamType textTrackStyle tracks

cast.receiver.media.MediaStatus

Represents the status of a media session.

Properties	activeTrackIds currentTime customData idleReason media mediaSessionId playbackRate playerState supportedMediaCommands volume

cast.receiver.media.Player

A generic player interface.

Functions	registerErrorCallback registerEndedCallback registerLoadCallback unregisterErrorCallback unregisterEndedCallback unregisterLoadCallback load reset play seek pause getState getCurrentTimeSec getDurationSec getVolume setVolume editTracksInfo

cast.receiver.media.PlayerState

Represents the player state.

Values	BUFFERING IDLE PAUSED PLAYING

cast.receiver.media.SeekResumeState

Represents the playback state after a SEEK request.

Values	PLAYBACK_PAUSE PLAYBACK_START

cast.receiver.media.StreamType

Represents the stream types.

Values	BUFFERED LIVE NONE

cast.receiver.media.TextTrackEdgeType

Possible text track edge type.

Values	DEPRESSED DROP_SHADOW NONE OUTLINE RAISED

cast.receiver.media.TextTrackFontGenericFamily

Text track font generic family.

Values	CASUAL CURSIVE MONOSPACED_SANS_SERIF MONOSPACED_SERIF SANS_SERIF SERIF SMALL_CAPITALS

cast.receiver.media.TextTrackFontStyle

Possible text track font style.

Values	BOLD BOLD_ITALIC ITALIC NORMAL

cast.receiver.media.TextTrackStyle

Describes style information for a text track.

Properties	backgroundColor customData edgeColor edgeType fontFamily fontGenericFamily fontScale fontStyle foregroundColor windowColor windowRoundedCornerRadius windowType

cast.receiver.media.TextTrackType

Possible text track type (follows the HTML5 text track type definitions).

Values	CAPTIONS CHAPTERS DESCRIPTIONS METADATA SUBTITLES

cast.receiver.media.TextTrackWindowType

Text track window type.

Values	NONE NORMAL ROUNDED_CORNERS

cast.receiver.media.Track

Describes track metadata information.

Properties	customData language name subtype trackContentId trackContentType trackId type

cast.receiver.media.TracksInfo

Tracks information.

Properties	activeTrackIds textTrackStyle tracks

cast.receiver.media.TrackType

Possible media track type.

Values	AUDIO TEXT VIDEO

cast.receiver.media.Volume

Represents the volume of a media session stream.

Properties	level muted

cast.receiver.MediaManager

Creates a media manager instance.

Classes	EditTracksInfoData Event LoadInfo LoadRequestData QueueUpdateRequestData RequestData SeekRequestData VolumeRequestData
Functions	getMediaInformation setMediaInformation broadcastStatus setIdleReason sendError sendStatus loadTracksInfo setMediaElement sendLoadError sendLoadComplete resetMediaElement
Properties	customizedStatusCallback onEditTracksInfo onEnded onError onGetStatus onLoad onLoadMetadataError onMetadataLoaded onPause onPlay onQueueUpdate onSeek onSetVolume onStop
Enums	EventType

cast.receiver.MediaManager.EditTracksInfoData

Media event EDIT_TRACKS_INFO request data.

Properties	activeTrackIds textTrackStyle

cast.receiver.MediaManager.Event

Event dispatched by {@code cast.receiver.MediaManager} which contains system information.

Properties	data senderId

cast.receiver.MediaManager.EventType

System events dispatched by {@code cast.receiver.MediaManager}.

Values	EDIT_TRACKS_INFO GET_STATUS LOAD PAUSE PLAY QUEUE_UPDATE SEEK SET_VOLUME STOP

cast.receiver.MediaManager.LoadInfo

Load Request Information.

Properties	message senderId

cast.receiver.MediaManager.LoadRequestData

Media event LOAD request data.

Properties	activeTrackIds autoplay currentTime media

cast.receiver.MediaManager.QueueUpdateRequestData

Media event queue UPDATE request data.

Properties	jump

cast.receiver.MediaManager.RequestData

Media event request data.

Properties	customData mediaSessionId requestId

cast.receiver.MediaManager.SeekRequestData

Media event SEEK request data.

Properties	currentTime resumeState

cast.receiver.MediaManager.VolumeRequestData

Media event SET_VOLUME request data.

Properties	volume

cast.receiver.system.ApplicationData

Represents the data of the launched application.

Properties	id launchingSenderId name namespaces sessionId

cast.receiver.system.DisconnectReason

Represents the disconnect reason.

Values	ERROR REQUESTED_BY_SENDER UNKNOWN

cast.receiver.system.Sender

Represents the data of a connected sender device.

Properties	id userAgent

cast.receiver.system.StandbyState

Represents the current standby state reported by the platform.

Values	NOT_STANDBY STANDBY UNKNOWN

cast.receiver.system.SystemVolumeData

Represents the system volume data.

Properties	level muted

cast.receiver.system.VisibilityState

Represents the current visibility state reported by the platform.

Values	NOT_VISIBLE UNKNOWN VISIBLE

Index of all classes and functions

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 March 18, 2015.