Namespace: framework

Classes

Enumerations

ActiveInputState

static

number

The possible states of the receiver active-input.

Value

ACTIVE_INPUT_STATE_UNKNOWN

number

Indicates that it is not known (and/or not possible to know) whether the Google cast device is the currently active video input. Active input state can only be reported when the Google cast device is connected to a TV or AVR with CEC support.

ACTIVE_INPUT_STATE_NO

number

Indicates that the Google cast device is not the currently active video input.

ACTIVE_INPUT_STATE_YES

number

Indicates that the Google cast device is the currently active video input.

CastContextEventType

static

string

The events that cast.framework.CastContext supports.

Value

CAST_STATE_CHANGED

string

Event to track cast icon state. Event data is of type cast.framework.CastStateEventData.

SESSION_STATE_CHANGED

string

Event to track current cast session. Event data is of type cast.framework.SessionStateEventData.

CastState

static

string

The possible casting states.

Value

NO_DEVICES_AVAILABLE

string

No cast devices are available.

NOT_CONNECTED

string

Cast devices are available, but a cast session is not established.

CONNECTING

string

Cast session is being established.

CONNECTED

string

Cast session is established.

LoggerLevel

static

number

Logging levels for cast framework.

Value

DEBUG

number

Debug logging (all messages).

INFO

number

Info logging (events, general logs).

WARNING

number

warning logging (warnings).

ERROR

number

Error logging (errors).

NONE

number

No logging.

RemotePlayerEventType

static

string

Event types for changes of cast.framework.RemotePlayer data.

Value

ANY_CHANGE

string

Any property has changed. Useful for an Angular binding application, where angular needs to be notified everytime a property is changed.

IS_CONNECTED_CHANGED

string

Property isConnected has changed.

IS_MEDIA_LOADED_CHANGED

string

Property isMediaLoaded has changed.

QUEUE_DATA_CHANGED

string

Property queueData has changed.

VIDEO_INFO_CHANGED

string

Property videoInfo has changed.

DURATION_CHANGED

string

Property duration has changed.

CURRENT_TIME_CHANGED

string

Property currentTime has changed.

IS_PAUSED_CHANGED

string

Property isPaused has changed.

VOLUME_LEVEL_CHANGED

string

Property volumeLevel has changed.

CAN_CONTROL_VOLUME_CHANGED

string

Property canControlVolume has changed.

IS_MUTED_CHANGED

string

Property isMuted has changed.

CAN_PAUSE_CHANGED

string

Property canPause has changed.

CAN_SEEK_CHANGED

string

Property canSeek has changed.

DISPLAY_NAME_CHANGED

string

Property displayName has changed.

STATUS_TEXT_CHANGED

string

Property statusText has changed.

TITLE_CHANGED

string

Property title has changed.

DISPLAY_STATUS_CHANGED

string

Property displayStatus has changed.

MEDIA_INFO_CHANGED

string

Property mediaInfo has changed.

IMAGE_URL_CHANGED

string

Property imageUrl has changed.

PLAYER_STATE_CHANGED

string

Property playerState has changed.

IS_PLAYING_BREAK_CHANGED

string

Property isPlayingBreak has changed.

NUMBER_BREAK_CLIPS_CHANGED

string

Property numberBreakClips has changed.

CURRENT_BREAK_CLIP_NUMBER_CHANGED

string

Property currentBreakClipNumber has changed.

CURRENT_BREAK_TIME_CHANGED

string

Property currentBreakTime has changed.

CURRENT_BREAK_CLIP_TIME_CHANGED

string

Property currentBreakClipTime has changed.

BREAK_ID_CHANGED

string

Property breakId has changed.

BREAK_CLIP_ID_CHANGED

string

Property breakClipId has changed.

WHEN_SKIPPABLE_CHANGED

string

Property whenSkippable has changed.

LIVE_SEEKABLE_RANGE_CHANGED

string

Property liveSeekableRange has changed.

SessionEventType

static

string

The events that cast.framework.CastSession supports.

Value

APPLICATION_STATUS_CHANGED

string

Application status text has changed. Event data is of type cast.framework.ApplicationStatusEventData.

APPLICATION_METADATA_CHANGED

string

Application metadata has changed. Event data is of type cast.framework.ApplicationMetadataEventData.

ACTIVE_INPUT_STATE_CHANGED

string

Receiver active input state has changed. Event data is of type cast.framework.ActiveInputStateEventData.

VOLUME_CHANGED

string

Receiver volume or mute status has changed. Event data is of type cast.framework.VolumeEventData.

MEDIA_SESSION

string

Started a new media session. Event data is of type cast.framework.MediaSessionEventData.

SessionState

static

string

The possible cast session states.

Value

NO_SESSION

string

Cast session is not established.

SESSION_STARTING

string

Cast session is being established.

SESSION_STARTED

string

Cast session is established.

SESSION_START_FAILED

string

Cast session failed to start. Failure reason is provided in the event data cast.framework.SessionStateEventData#errorCode field.

SESSION_ENDING

string

Cast session is being disconnected.

SESSION_ENDED

string

Cast session is disconnected.

SESSION_RESUMED

string

Connection to an already existing session is established.

Properties

ActiveInputState

static

number

The possible states of the receiver active-input.

Value

ACTIVE_INPUT_STATE_UNKNOWN

number

Indicates that it is not known (and/or not possible to know) whether the Google cast device is the currently active video input. Active input state can only be reported when the Google cast device is connected to a TV or AVR with CEC support.

ACTIVE_INPUT_STATE_NO

number

Indicates that the Google cast device is not the currently active video input.

ACTIVE_INPUT_STATE_YES

number

Indicates that the Google cast device is the currently active video input.

CastContextEventType

static

string

The events that cast.framework.CastContext supports.

Value

CAST_STATE_CHANGED

string

Event to track cast icon state. Event data is of type cast.framework.CastStateEventData.

SESSION_STATE_CHANGED

string

Event to track current cast session. Event data is of type cast.framework.SessionStateEventData.

CastState

static

string

The possible casting states.

Value

NO_DEVICES_AVAILABLE

string

No cast devices are available.

NOT_CONNECTED

string

Cast devices are available, but a cast session is not established.

CONNECTING

string

Cast session is being established.

CONNECTED

string

Cast session is established.

LoggerLevel

static

number

Logging levels for cast framework.

Value

DEBUG

number

Debug logging (all messages).

INFO

number

Info logging (events, general logs).

WARNING

number

warning logging (warnings).

ERROR

number

Error logging (errors).

NONE

number

No logging.

RemotePlayerEventType

static

string

Event types for changes of cast.framework.RemotePlayer data.

Value

ANY_CHANGE

string

Any property has changed. Useful for an Angular binding application, where angular needs to be notified everytime a property is changed.

IS_CONNECTED_CHANGED

string

Property isConnected has changed.

IS_MEDIA_LOADED_CHANGED

string

Property isMediaLoaded has changed.

QUEUE_DATA_CHANGED

string

Property queueData has changed.

VIDEO_INFO_CHANGED

string

Property videoInfo has changed.

DURATION_CHANGED

string

Property duration has changed.

CURRENT_TIME_CHANGED

string

Property currentTime has changed.

IS_PAUSED_CHANGED

string

Property isPaused has changed.

VOLUME_LEVEL_CHANGED

string

Property volumeLevel has changed.

CAN_CONTROL_VOLUME_CHANGED

string

Property canControlVolume has changed.

IS_MUTED_CHANGED

string

Property isMuted has changed.

CAN_PAUSE_CHANGED

string

Property canPause has changed.

CAN_SEEK_CHANGED

string

Property canSeek has changed.

DISPLAY_NAME_CHANGED

string

Property displayName has changed.

STATUS_TEXT_CHANGED

string

Property statusText has changed.

TITLE_CHANGED

string

Property title has changed.

DISPLAY_STATUS_CHANGED

string

Property displayStatus has changed.

MEDIA_INFO_CHANGED

string

Property mediaInfo has changed.

IMAGE_URL_CHANGED

string

Property imageUrl has changed.

PLAYER_STATE_CHANGED

string

Property playerState has changed.

IS_PLAYING_BREAK_CHANGED

string

Property isPlayingBreak has changed.

NUMBER_BREAK_CLIPS_CHANGED

string

Property numberBreakClips has changed.

CURRENT_BREAK_CLIP_NUMBER_CHANGED

string

Property currentBreakClipNumber has changed.

CURRENT_BREAK_TIME_CHANGED

string

Property currentBreakTime has changed.

CURRENT_BREAK_CLIP_TIME_CHANGED

string

Property currentBreakClipTime has changed.

BREAK_ID_CHANGED

string

Property breakId has changed.

BREAK_CLIP_ID_CHANGED

string

Property breakClipId has changed.

WHEN_SKIPPABLE_CHANGED

string

Property whenSkippable has changed.

LIVE_SEEKABLE_RANGE_CHANGED

string

Property liveSeekableRange has changed.

SessionEventType

static

string

The events that cast.framework.CastSession supports.

Value

APPLICATION_STATUS_CHANGED

string

Application status text has changed. Event data is of type cast.framework.ApplicationStatusEventData.

APPLICATION_METADATA_CHANGED

string

Application metadata has changed. Event data is of type cast.framework.ApplicationMetadataEventData.

ACTIVE_INPUT_STATE_CHANGED

string

Receiver active input state has changed. Event data is of type cast.framework.ActiveInputStateEventData.

VOLUME_CHANGED

string

Receiver volume or mute status has changed. Event data is of type cast.framework.VolumeEventData.

MEDIA_SESSION

string

Started a new media session. Event data is of type cast.framework.MediaSessionEventData.

SessionState

static

string

The possible cast session states.

Value

NO_SESSION

string

Cast session is not established.

SESSION_STARTING

string

Cast session is being established.

SESSION_STARTED

string

Cast session is established.

SESSION_START_FAILED

string

Cast session failed to start. Failure reason is provided in the event data cast.framework.SessionStateEventData#errorCode field.

SESSION_ENDING

string

Cast session is being disconnected.

SESSION_ENDED

string

Cast session is disconnected.

SESSION_RESUMED

string

Connection to an already existing session is established.

VERSION

constant   static

string

Current sender Cast Framework version.

Method

setLoggerLevel

static

setLoggerLevel(level)

Set the logging level for cast.

Parameter

level

cast.framework.LoggerLevel

Logging level.

Value must not be null.

Abstract type

EventType

static

(non-null cast.framework.CastContextEventType, non-null cast.framework.SessionEventType, or non-null cast.framework.RemotePlayerEventType)

The supported event types.