命名空间：投放

chrome.投射

命名空间 静态

这是 chrome.cast 命名空间。

类

ApiConfig

初始化时保存 API 的配置。

凭据数据

用于标识发送者凭据的凭据数据。

拨号请求

启动 DIAL 应用的请求。

错误

描述 API 返回的错误。 通常，客户端不应创建这些对象。

Image

描述接收者应用或媒体项的图片。可以是应用图标、封面图片或缩略图。

接收器

描述运行应用的接收器。 通常，客户端不应创建这些对象。

ReceiverDisplayStatus

在扩展程序界面中向用户显示的接收器状态。 仅对自定义接收器有效。

发件人应用

描述发送者应用。 通常，客户端不应创建这些对象。

会话

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

SessionRequest

启动或连接到会话的请求。

超时

定义 API 方法的默认超时值（以毫秒为单位）。

Volume

设备或媒体流的音量。

命名空间

media

枚举

自动联接政策

静态

字符串

自动联接政策决定了在 API 初始化后，SDK 何时会自动将发送者应用连接到现有会话。

值
制表符和出发地名称	字符串 会话在同一标签页和页面来源中使用同一 appId 启动时自动自动连接。
出发地	字符串 当会话以相同的 appId 和相同的页面来源（无论标签页为何）启动时启动时自动连接。
已排除	字符串 没有自动连接。

能力

静态

字符串

接收端设备支持的功能。

值
视频输出	字符串 接收器支持视频输出。
音频输出	字符串 接收器支持音频输出。
视频	字符串 接收器支持视频输入（摄像头）。
音频	字符串 接收器支持音频输入（麦克风）。
多区	字符串 接收器代表多可用区组。

DefaultActionPolicy 类中的方法

静态

字符串

默认操作政策决定了 SDK 在初始化 API 后何时自动创建会话。此操作还可控制扩展程序弹出式窗口中标签页的默认操作。

值
创建会话	字符串 如果在 API 初始化时投射包含该应用的标签页，则 SDK 会停止标签页投放，并自动启动该应用。扩展程序弹出式窗口会提示用户投射应用。
投放 TIS_TAB	字符串 初始化该 API 后，不会执行自动启动，即使正在转换标签页。该扩展程序弹出式窗口会提示用户投射该标签页。

DialAppState

静态

字符串

DIAL 应用的可能状态。

值
正在运行	字符串
已停止	字符串
错误	字符串 不属于规范，用于指示错误。

ErrorCode

静态

字符串

SDK 可能返回的错误。

值
取消	字符串 操作已被用户取消。
TIMEOUT	字符串 操作超时。
API_未初始化	字符串 该 API 未初始化。
参数无效	字符串 运算的参数无效。
扩展_不兼容	字符串 API 脚本与已安装的 Cast 扩展程序不兼容。
附加信息缺失	字符串 Cast 扩展程序不可用。
收到	字符串 没有接收器与会话请求兼容。
会话出错	字符串 会话无法创建，或者会话无效。
频道出错	字符串 接收者无法获得频道。
加载媒体失败	字符串 未能加载媒体。

接收器操作

静态

字符串

用户可以对扩展程序中的接收器执行的操作。这些类型可用于在投射操作完成（或失败）之前在发送者应用界面中显示过渡效果。

值
CAST	字符串 用户选择了接收者，以便使用发送者应用向其投放内容。接收者的确切身份可能未知。
停止	字符串 用户要求停止在接收器上运行的会话。

接收器可用性

静态

字符串

说明 Cast 接收器的可用性。

值
可用	字符串 至少有一个接收器与会话请求兼容。
目前无法购买	字符串 没有可用的接收器。

接收器类型

静态

字符串

值
CAST	字符串 Cast 接收器，例如 Chromecast
DIAL	字符串 拨号设备，例如智能电视
环聊	字符串 闲荡
自定义	字符串 客户端提供的自定义接收器

发送者平台

静态

字符串

描述发送者应用平台。

值
Chrome	字符串
iOS	字符串
ANDROID	字符串

会话状态

静态

字符串

用于说明与其接收端应用投放的 Cast 会话的状态。

值
融会贯通	字符串 会话连接到接收者应用。
已断开连接	字符串 会话与接收者应用已断开连接。接收者应用不一定正在运行。
已停止	字符串 接收器应用已停止。

音量控制类型

静态

字符串

描述音量控制的类型。

值
衰减	字符串 投放设备音量可以更改。
修复	字符串 投放设备音量固定，无法更改。
大师	字符串 主系统音量控制，即电视或音频设备的音量发生变化。

属性

自动联接政策

静态

字符串

自动联接政策决定了在 API 初始化后，SDK 何时会自动将发送者应用连接到现有会话。

值
制表符和出发地名称	字符串 会话在同一标签页和页面来源中使用同一 appId 启动时自动自动连接。
出发地	字符串 当会话以相同的 appId 和相同的页面来源（无论标签页为何）启动时启动时自动连接。
已排除	字符串 没有自动连接。

能力

静态

字符串

接收端设备支持的功能。

值
视频输出	字符串 接收器支持视频输出。
音频输出	字符串 接收器支持音频输出。
视频	字符串 接收器支持视频输入（摄像头）。
音频	字符串 接收器支持音频输入（麦克风）。
多区	字符串 接收器代表多可用区组。

DefaultActionPolicy 类中的方法

静态

字符串

默认操作政策决定了 SDK 在初始化 API 后何时自动创建会话。此操作还可控制扩展程序弹出式窗口中标签页的默认操作。

值
创建会话	字符串 如果在 API 初始化时投射包含该应用的标签页，则 SDK 会停止标签页投放，并自动启动该应用。扩展程序弹出式窗口会提示用户投射应用。
投放 TIS_TAB	字符串 初始化该 API 后，不会执行自动启动，即使正在转换标签页。该扩展程序弹出式窗口会提示用户投射该标签页。

DialAppState

静态

字符串

DIAL 应用的可能状态。

值
正在运行	字符串
已停止	字符串
错误	字符串 不属于规范，用于指示错误。

ErrorCode

静态

字符串

SDK 可能返回的错误。

值
取消	字符串 操作已被用户取消。
TIMEOUT	字符串 操作超时。
API_未初始化	字符串 该 API 未初始化。
参数无效	字符串 运算的参数无效。
扩展_不兼容	字符串 API 脚本与已安装的 Cast 扩展程序不兼容。
附加信息缺失	字符串 Cast 扩展程序不可用。
收到	字符串 没有接收器与会话请求兼容。
会话出错	字符串 会话无法创建，或者会话无效。
频道出错	字符串 接收者无法获得频道。
加载媒体失败	字符串 未能加载媒体。

可用

静态

布尔值

供客户端检查 API 是否已加载的标志。

接收器操作

静态

字符串

用户可以对扩展程序中的接收器执行的操作。这些类型可用于在投射操作完成（或失败）之前在发送者应用界面中显示过渡效果。

值
CAST	字符串 用户选择了接收者，以便使用发送者应用向其投放内容。接收者的确切身份可能未知。
停止	字符串 用户要求停止在接收器上运行的会话。

接收器可用性

静态

字符串

说明 Cast 接收器的可用性。

值
可用	字符串 至少有一个接收器与会话请求兼容。
目前无法购买	字符串 没有可用的接收器。

接收器类型

静态

字符串

值
CAST	字符串 Cast 接收器，例如 Chromecast
DIAL	字符串 拨号设备，例如智能电视
环聊	字符串 闲荡
自定义	字符串 客户端提供的自定义接收器

发送者平台

静态

字符串

描述发送者应用平台。

值
Chrome	字符串
iOS	字符串
ANDROID	字符串

会话状态

静态

字符串

用于说明与其接收端应用投放的 Cast 会话的状态。

值
融会贯通	字符串 会话连接到接收者应用。
已断开连接	字符串 会话与接收者应用已断开连接。接收者应用不一定正在运行。
已停止	字符串 接收器应用已停止。

timeout

静态

非 null chrome.cast.Timeout

API 方法的默认超时值（以毫秒为单位）。

版本

常量 静态

非 null 数组

API 版本。第一个数字是主要版本，第二个数字是次要版本。

音量控制类型

静态

字符串

描述音量控制的类型。

值
衰减	字符串 投放设备音量可以更改。
修复	字符串 投放设备音量固定，无法更改。
大师	字符串 主系统音量控制，即电视或音频设备的音量发生变化。

方法

addReceiverActionListener

静态

addReceiverActionListener(listener)

添加了一个监听器函数，当用户通过界面执行操作以开始或停止投射时，系统会调用该函数。投射应用可以使用此操作在投射操作完成或失败之前，在其界面中显示过渡效果（即暂停本地播放媒体）。

• 系统不能保证该监听器会被调用，应用不应依赖它来正常运行。
• 该监听器将传递给对其执行操作的接收器（如果有）。不过，接收器可能未知，系统会改为传递 null。
• 用户执行操作后，系统会立即调用监听器。应在系统通过 API 通知生成的状态更改之前调用该方法。

如果使用 Framework API，请改用 cast.framework.CastContext#addEventListener 并监听 cast.framework.CastContextEventType#CAST_STATE_CHANGED 事件。

参数
监听器	chrome.cast.ReceiverActionListener 要添加的监听器函数。监听器的第一个参数是已对其执行操作的接收器。监听器的第二个参数是所请求的操作（请参阅 chrome.cast.ReceiverAction）。 值不能为 null。

initialize

静态

初始化（apiConfig、successCallback、errorCallback）

初始化 API。请注意，在 API 完成初始化后，系统会立即调用 successCallback 和 errorCallback。sessionListener 和 receiveListener 之后可能会随时被调用，而且可能会调用多次。

如果使用的是 Framework API，请使用 cast.framework.CastContext#setOptions（而非此函数）。

参数
apiConfig	chrome.cast.ApiConfig 用于初始化 API 的参数的对象。 值不能为 null。
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能出现的错误包括 TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING。

logMessage

静态

logMessage(消息)

从应用中记录调试消息。如果用户明确选择包含精细日志，此消息可能会以反馈报告的形式发送给 Google。

参数
私信	字符串 要记录的消息。

已弃用

基于 Presentation API 的 Cast SDK 不支持。

预缓存

静态

预缓存（数据）

发送请求以预缓存数据。如果连接成功，会话就会发送直接请求，否则会发送至网络中的所有设备。

参数
数据	字符串 要预缓存的数据。

removeReceiverActionListener

静态

removeReceiverActionListener(listener)

移除之前使用 addReceiverActionListener 添加的监听器函数。

参数
监听器	chrome.cast.ReceiverActionListener 要移除的监听器函数。 值不能为 null。

requestSession

静态

requestSession(successCallback, errorCallback, sessionRequest)

请求创建或加入接收器应用会话。默认情况下，系统会使用初始化时传递给 API 的 SessionRequest；通过在 sessionRequest 中传递不同的会话请求，可以替换此设置。

如果使用的是 Framework API，请使用 cast.framework.CastContext#requestSession，而不是此函数。

参数
成功回调	函数（非 null chrome.cast.Session）
errorCallback	函数（非 null chrome.cast.Error） 可能出现的错误包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESSION_ERROR、RECEIVER_UNAVAILABLE 和 EXTENSION_MISSING。 请注意，超时计时器在用户选择接收器后开始计时。 选择接收器需要用户执行操作，该操作没有超时。如果会话请求已在进行中，系统将调用 errorCallback 并返回错误代码 INVALID_PARAMETER 和错误说明。
会话请求	选填 chrome.cast.SessionRequest 值不能为 null。

requestSessionById

静态

requestSessionById(sessionId)

请求加入具有指定 ID 的现有会话。连接后，会话将传递给由 chrome.cast.initialize 设置的 sessionListener。

如果调用此函数时已知具有给定 sessionId 的会话，则会立即调用 sessionListener。否则，在发现具有指定 sessionId 的会话后，系统将调用 sessionListener。

参数
sessionId	字符串 要加入的会话的 ID。

setCustomReceiver

静态

setCustomReceivers(receivers, successfulCallback, errorCallback)

设置自定义接收器列表

参数
接收器	非 null chrome.cast.Receiver 的数组 新列表。 值不能为 null。
成功回调	函数()
errorCallback	函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR 和 EXTENSION_MISSRING。

已弃用

基于 Presentation API 的 Cast SDK 不支持。

setPageContext

静态

setPageContext(win)

为在 iframe 中加载 Cast SDK 的网页初始化 Cast 功能。 应在 SDK 初始化后调用。

参数
胜	窗口 页面窗口对象。 值不能为 null。

setReceiverDisplayStatus

静态

setReceiverDisplayStatus(receiver, successfulCallback, errorCallback)

设置接收器名称和显示状态。如需将接收器显示为空闲，请将 displayStatus 设置为 null。

仅对自定义接收器有效。如果接收器是 CAST，接收器的 displayStatus 会被忽略；投放接收器状态由接收器应用更新。

参数
接收者	chrome.cast.Receiver 接收器。 值不能为 null。
成功回调	函数() 设置状态成功时的回调。
errorCallback	函数（非 null chrome.cast.Error） 可能出现的错误有 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED 和 EXTENSION_MISSING。

已弃用

基于 Presentation API 的 Cast SDK 不支持。

不转义

静态

不转义（转义）字符串返回

用于取消转义 URI 转义字符串的实用程序方法。例如，接收器易记的名称以 URI 转义字符串的形式返回。如果需要，请使用此方法取消转义该字符串。

参数
转义	字符串 要反转义的字符串

返回

string 未转义字符串

抽象类型

接收器操作监听器

静态

ReceiverActionListener()