类：会话

chrome.投射。会话

class static

描述当前正在运行的 Cast 应用的状态。 通常，客户端不应创建这些对象。

构造函数

会话

new Session(sessionId, appId, displayName, appImages, receiver)

参数
sessionId	字符串 会话标识符。
appId	字符串 接收者应用标识符。
displayName	字符串 应用的显示名称。
appImages	非 null chrome.cast.Image 数组 与应用关联的图片。 值不能为 null。
接收者	chrome.cast.Receiver 运行应用的接收器。 值不能为 null。

属性

appId

字符串

Cast 应用的标识符。不适用于展示广告。

appImages

非 null 的 chrome.cast.Image 数组

描述应用的可用图像数组。

displayName

字符串

人类可读的 Cast 应用名称，例如“YouTube”。

media

非 null 的 chrome.cast.media.Media 数组

属于此投放会话的媒体，包括由其他发送者加载的媒体。

namespaces

{name: string} 的非 null 数组

接收器应用支持的命名空间列表。

接收者

非 null chrome.cast.Receiver

运行应用的接收器。

发送者应用

非 null 的 chrome.cast.SenderApplication 数组

接收者应用支持的发送器应用。此字段可用于提示用户安装或访问发送者应用。

sessionId

字符串

唯一标识接收者应用的此实例。

status

非 null chrome.cast.SessionStatus

此接收会话与接收设备应用之间的状态。

状态文本

可为 null 的字符串

当前应用内容的描述性文字，例如“我的婚礼幻灯片”。

传输 ID

字符串

唯一标识此会话以进行传输的标识符。这是内部通信信道。

方法

addMediaListener

addMediaListener(listener)

添加由其他发送者创建媒体会话时调用的监听器。

参数
监听器	函数（非 null chrome.cast.media） 要添加的监听器。

addMessageListener

addMessageListener(命名空间, 监听器)

添加从接收方应用收到消息时调用的监听器。调用监听器时，命名空间为第一个参数，消息为第二个参数。

参数
命名空间	字符串 要监听的命名空间，例如“urn:x-cast:com.example.namespace”。
监听器	函数（字符串、字符串） 要添加的监听器。

addUpdateListener

addUpdateListener(监听器)

添加在会话发生变化时调用的监听器。对以下属性进行更改将触发监听器：statusText、命名空间、状态和接收器的音量。

监听器应检查会话的 status 属性以确定其连接状态。布尔值参数 isAlive 已弃用，取而代之的是 status Session 属性。为了向后兼容，系统仍会传入 isAlive 参数，除非 status = chrome.cast.SessionStatus.STOPPED，否则该参数为 true。

参数
监听器	函数（布尔值） 要添加的监听器。

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

获取拨号应用信息。

参数
成功回调	函数（非 null chrome.cast.DialLaunchData）
errorCallback	函数（非 null chrome.cast.Error）

leave

留言（成功回调、错误回调）

离开与会话关联的运行中的接收器应用（断开连接）。

此客户端的 AutoJoinPolicy 定义的范围内的现有客户端将断开连接。未来的客户端不会自动加入已经退出的会话。

所有断开连接的客户端都将使用 isAlive = true 调用其会话更新监听器。由于 isAlive 已废弃，监听器应检查会话的 status 属性以确定其连接状态。在此示例中为 status = chrome.cast.SessionStatus.DISCONNECTED。

参数
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

加载媒体

loadMedia(loadRequest、successCallback、errorCallback)

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

参数
loadRequest	chrome.cast.media.LoadRequest 请求加载媒体。 值不能为 null。
成功回调	函数（非 null chrome.cast.media） 在成功时通过已加载的媒体调用。
errorCallback	函数（非 null chrome.cast.Error） 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

队列加载

queueLoad(queueLoadRequest、successCallback、errorCallback)

将新的媒体项队列加载并视需要开始播放到正在运行的接收器应用中。

参数
队列加载请求	chrome.cast.media.QueueLoadRequest 请求加载新的媒体队列队列。 值不能为 null。
成功回调	函数（非 null chrome.cast.media） 在成功时通过已加载的媒体调用。
errorCallback	函数（非 null chrome.cast.Error） 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

已弃用

使用 cast.framework.CastSession#loadMedia 并提供相关的 chrome.cast.media.LoadRequest#queueData。

移除 MediaListener

removeMediaListener(listener)

移除之前使用 addMediaListener 添加的监听器。

参数
监听器	函数（非 null chrome.cast.media） 要移除的监听器。

移除消息监听器

removeMessageListener(命名空间, 监听器)

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

参数
命名空间	字符串 被监听的命名空间，例如“urn:x-cast:com.example.namespace”。
监听器	函数（字符串、字符串） 要移除的监听器。

removeUpdateListener

removeUpdateListener(listener)

移除之前为该会话添加的监听器。

参数
监听器	函数（布尔值） 要移除的监听器。

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

向指定命名空间中的接收器应用发送消息。消息提交到消息通道后，系统会调用 successCallback。系统会尽最大努力向接收器应用传送消息，但不保证一定能。

参数
命名空间	字符串 要发送消息的命名空间，例如“urn:x-cast:com.example.namespace”。
私信	（非 null 对象或字符串）
成功回调	函数() 发送消息后进行调用。
errorCallback	函数（非 null chrome.cast.Error） 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

setReceiver 已静音

setReceiverMuted(muted, successfulCallback, errorCallback)

设置接收器音量。

参数
已设为静音	布尔值 新的静音状态。
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

设置接收器音量。

参数
新等级	number 介于 0.0 和 1.0 之间的新音量。
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

停止

stop(successCallback, errorCallback)

停止与会话相关联的正在运行的接收方应用。

参数
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。