类：CastSession

cast.framework。CastSession

class   static

管理投放会话。

构造函数

CastSession

new CastSession(sessionObj, state)

参数

sessionObj

chrome.cast.Session

会话数据。

值不能为 null。

state

cast.framework.SessionState

会话状态。

值不能为 null。

方法

addEventListener

addEventListener(type, handler)

添加事件侦听器。

参数

类型

cast.framework.SessionEventType

事件类型。

值不能为 null。

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

addMessageListener

addMessageListener(namespace, listener)

添加在收到来自接收器应用的消息时调用的监听器。系统在调用监听器时，将命名空间作为第一个参数，将消息作为第二个参数。

参数

命名空间

string

要监听的命名空间，例如“urn:x-cast:com.example.namespace”。

监听器

function(string, string)

要添加的监听器。

endSession

endSession(stopCasting)

结束当前会话。

参数

stopCasting

boolean

接收端应用是否应在结束当前会话时停止。

getActiveInputState

getActiveInputState() 返回 cast.framework.ActiveInputState

返回

non-null cast.framework.ActiveInputState：接收器有效输入状态。

getApplicationMetadata

getApplicationMetadata() 返回 cast.framework.ApplicationMetadata

返回

non-null cast.framework.ApplicationMetadata 应用元数据。

getApplicationStatus

getApplicationStatus() 返回字符串

返回

nullable string 应用状态字符串。

getCastDevice

getCastDevice() 返回 chrome.cast.Receiver

返回

non-null chrome.cast.Receiver 投放设备元数据。

getMediaSession

getMediaSession() 会返回 chrome.cast.media.Media

返回当前媒体会话（如果有）。

返回

nullable chrome.cast.media.Media 当前媒体会话。

getSessionId

getSessionId() 返回字符串

返回

string 此会话的唯一 ID。

getSessionObj

getSessionObj() 会返回 chrome.cast.Session

返回

non-null chrome.cast.Session 会话数据。

getSessionState

getSessionState() 会返回 cast.framework.SessionState

返回

cast.framework.SessionState：当前会话状态。

getVolume

getVolume() 返回数字

返回

nullable number 接收器音量（如果有）。

isMute

isMute() 返回布尔值

返回

nullable boolean 接收器静音状态（如果有）。

loadMedia

loadMedia(loadRequest) 会返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise

将媒体加载到正在运行的接收器应用中。

参数

loadRequest

chrome.cast.media.LoadRequest

值不能为 null。
返回

non-null Promise containing nullable chrome.cast.ErrorCode 承诺向接收者发送加载成功或失败（会话将传递到 media_session 事件）。

removeEventListener

removeEventListener(type, handler)

删除事件监听器。

参数

类型

cast.framework.SessionEventType

事件类型。

值不能为 null。

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

removeMessageListener

removeMessageListener(namespace, listener)

删除之前为消息添加的监听器。

参数

命名空间

string

监听的命名空间，例如“urn:x-cast:com.example.namespace”。

监听器

function(string, string)

要移除的监听器。

sendMessage

sendMessage(namespace, data) 会返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise

向接收者发送消息。

参数

命名空间

string

发送消息时所在的命名空间，例如“urn:x-cast:com.example.namespace”。

data

(non-null Object or string)

要发送的数据。
返回

non-null Promise containing nullable chrome.cast.ErrorCode 消息发送时解析了 promise，如发送失败，则拒绝并返回错误代码。

setMute

setMute(isMute) 会返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise

将接收者静音或按音。

参数

isMute

boolean

新的静音状态。
返回

non-null Promise containing nullable chrome.cast.ErrorCode 解析的 promise 接收器已更新；如果失败，则会拒绝并返回错误代码。

setVolume

setVolume(volume) 会返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise

设置接收器音量。

参数

卷

number

介于 0.0 到 1.0 之间的新音量级别。
返回

non-null Promise containing nullable chrome.cast.ErrorCode 解析的 promise 接收器已更新；如果失败，则会拒绝并返回错误代码。