chrome.
描述当前正在运行的 Cast 应用的状态。 通常，客户端不应创建这些对象。
构造函数
议程
new Session(sessionId, appId, displayName, appImages, Receiver)
参数 |
|
|---|---|
|
sessionId |
string 会话标识符。 |
|
appId |
string 接收器应用标识符。 |
|
displayName |
string 应用的显示名称。 |
|
appImages |
非 null chrome.cast.Image 数组 与应用关联的图片。 值不能为 null。 |
|
接收者 |
运行应用的接收器。 值不能为 null。 |
属性
appId
string
Cast 应用的标识符。不作展示。
appImages
non-null 非 null chrome.cast.Image 数组
描述应用的可用图片数组。
displayName
string
直观易懂的 Cast 应用名称，例如“YouTube”。
media
非 null 非 null chrome.cast.media.Media 数组
属于此 Cast 会话的媒体，包括其他发送器加载的媒体。
namespaces
{name: string} 的非 null 数组
接收器应用支持的命名空间列表。
接收者
非 null chrome.cast.Receiver
运行应用的接收器。
senderApps
非 null chrome.cast.SenderApplication 数组
接收方应用支持的发送方应用。此字段可用于提示用户安装或访问发送方应用。
sessionId
string
用于唯一标识接收器应用的此实例。
资质
非 null chrome.cast.SessionStatus
发送到接收设备应用的此 Cast 会话的状态。
statusText
可为 null 的字符串
当前应用内容的描述性文本，例如“我的婚礼幻灯片”。
transportId
string
用于在传输过程中唯一标识此会话的标识符。 这是信道内部的一种。
方法
addMediaListener
addMediaListener(listener)
添加在另一个发送者创建媒体会话时调用的监听器。
参数 |
|
|---|---|
|
监听器 |
function(non-null chrome.cast.media.Media) 要添加的监听器。 |
addMessageListener
addMessageListener(namespace, listener)
添加在收到来自接收器应用的消息时调用的监听器。系统在调用监听器时将命名空间作为第一个参数，将消息作为第二个参数。
参数 |
|
|---|---|
|
命名空间 |
string 要监听的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
监听器 |
function(string, string) 要添加的监听器。 |
addUpdateListener
addUpdateListener(listener)
添加在会话发生更改时调用的监听器。对以下属性的更改将触发监听器：statusText、命名空间、状态和接收器的音量。
监听器应检查会话的 status 属性，以确定其连接状态。布尔参数 isAlive 已弃用，取而代之的是 status Session 属性。为了向后兼容，仍会传入 isAlive 参数；除非 status =
chrome.cast.SessionStatus.STOPPED，否则该参数为 true。
参数 |
|
|---|---|
|
监听器 |
function(boolean) 要添加的监听器。 |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
获取 DIAL 应用信息。
参数 |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
leave
take(successCallback、errorCallback)
退出（断开）与与会话关联的正在运行的接收器应用。
此客户端的 AutoJoinPolicy 所定义范围内的现有客户端将断开连接。未来的客户端不会自动加入之前退出的会话。
所有断开连接的客户端都将使用 isAlive = true 调用其会话更新监听器。自 isAlive 弃用以来，监听器应检查会话的 status 属性，以确定其连接状态。在此示例中为 status = chrome.cast.SessionStatus.DISCONNECTED。
参数 |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
将媒体加载到正在运行的接收器应用中。
参数 |
|
|---|---|
|
loadRequest |
请求加载媒体。 值不能为 null。 |
|
successCallback |
function(non-null chrome.cast.media.Media) 在成功时使用加载的媒体进行调用。 |
|
errorCallback |
function(non-null chrome.cast.Error) 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
queueLoad
queueLoad(queueLoadRequest, successCallback, errorCallback)
将新的媒体内容队列加载到正在运行的接收器应用中，并可选择开始播放。
参数 |
|
|---|---|
|
queueLoadRequest |
chrome.cast.media.QueueLoadRequest 请求加载新的媒体内容队列。 值不能为 null。 |
|
successCallback |
function(non-null chrome.cast.media.Media) 在成功时使用加载的媒体进行调用。 |
|
errorCallback |
function(non-null chrome.cast.Error) 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
removeMediaListener
removeMediaListener(listener)
移除之前使用 addMediaListener 添加的监听器。
参数 |
|
|---|---|
|
监听器 |
function(non-null chrome.cast.media.Media) 要移除的监听器。 |
removeMessageListener
removeMessageListener(namespace, listener)
删除之前为消息添加的监听器。
参数 |
|
|---|---|
|
命名空间 |
string 监听的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
监听器 |
function(string, string) 要移除的监听器。 |
removeUpdateListener
removeUpdateListener(listener)
移除之前为此 Session 添加的监听器。
参数 |
|
|---|---|
|
监听器 |
function(boolean) 要移除的监听器。 |
sendMessage
sendMessage(namespace, message, successCallback, errorCallback)
向指定命名空间中的接收方应用发送消息。当消息提交到消息渠道后，系统将调用 SuccessCallback。我们会尽最大努力向接收方应用发送消息，但无法保证消息会传送给接收方应用。
参数 |
|
|---|---|
|
命名空间 |
string 发送消息时所在的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
信息 |
(non-null Object or string) |
|
successCallback |
function() 发送消息后调用。 |
|
errorCallback |
function(non-null chrome.cast.Error) 出错时调用。可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
设置接收器音量。
参数 |
|
|---|---|
|
已设为静音 |
boolean 新的静音状态。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
设置接收器音量。
参数 |
|
|---|---|
|
newLevel |
number 介于 0.0 到 1.0 之间的新音量级别。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
个经停点
stop(successCallback, errorCallback)
停止与会话关联的正在运行的接收器应用。
参数 |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |