chrome.
这是 chrome.cast 命名空间。
类
ApiConfig
初始化时保留 API 的配置。
CredentialsData
用于标识发送者凭据的凭据数据。
拨号请求
启动 DIAL 应用的请求。
错误
描述 API 返回的错误。 通常，客户端不应创建这些对象。
Image
描述接收器应用或媒体项的图片。可以是应用图标、封面图片或缩略图。
接收器
描述运行应用的接收器。 通常，客户端不应创建这些对象。
ReceiverDisplayStatus
在扩展程序界面中向用户显示的接收器状态。 仅对自定义接收器有效。
SenderApplication（发件人应用）
描述发送者的应用。 通常，客户端不应创建这些对象。
会话
描述当前正在运行的 Cast 应用的状态。 通常，客户端不应创建这些对象。
SessionRequest
启动或连接到会话的请求。
超时
定义 API 方法的默认超时值（以毫秒为单位）。
Volume
设备或媒体流的音量。
命名空间
media
枚举
自动联接政策
string
自动联接政策决定 SDK 在 API 初始化后何时自动将发送者应用连接到现有会话。
值 |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
string 自动在会话启动时使用相同的 appId，在同一标签页和页面来源中连接。 |
|
来源_SCOPED |
string 当会话使用同一 appId 和同一页面来源（无论标签页如何）启动时启动时自动连接。 |
|
已列入网页 |
string 没有自动连接。 |
功能
string
接收设备支持的功能。
值 |
|
|---|---|
|
视频输出 |
string 接收器支持视频输出。 |
|
音频输出 |
string 接收器支持音频输出。 |
|
VIDEO_IN |
string 接收器支持视频输入（摄像头）。 |
|
音频（IN） |
string 接收器支持音频输入（麦克风）。 |
|
多可用区群组 |
string 接收器代表多可用区群组。 |
DefaultActionPolicy
string
默认操作政策决定了 SDK 初始化 API 后何时自动创建会话。还可控制扩展程序弹出式窗口中标签页的默认操作。
值 |
|
|---|---|
|
创建会话 |
string 如果在 API 初始化时投射包含应用的标签页，则 SDK 会停止标签页投放并自动启动应用。扩展程序会提示用户投射应用。 |
|
CAST_THIS_TAB |
string 初始化 API 后，系统不会执行自动启动（即使正在投放标签页）。该扩展程序弹出式窗口会提示用户投放标签页。 |
拨号应用状态
string
DIAL 应用的可能状态。
值 |
|
|---|---|
|
正在运行 |
string |
|
已停止 |
string |
|
错误 |
string 不在规范中，用于指示错误。 |
ErrorCode
string
SDK 可能会返回的错误。
值 |
|
|---|---|
|
取消 |
string 操作已被用户取消。 |
|
TIMEOUT |
string 操作超时。 |
|
API 未启用 |
string 此 API 未初始化。 |
|
参数无效 |
string 操作的参数无效。 |
|
扩展不兼容 |
string 该 API 脚本与已安装的 Cast 扩展程序不兼容。 |
|
附加信息缺失 |
string Cast 扩展程序不可用。 |
|
未收到 |
string 没有接收器与会话请求兼容。 |
|
SESSION_ERROR |
string 无法创建会话，或者会话无效。 |
|
频道错误 |
string 接收者的频道不可用。 |
|
加载_媒体失败 |
string 未能加载媒体。 |
接收者操作
string
用户可以对扩展程序中的接收器执行的操作。这些内容可以用于在投射操作完成（或失败）之前在发送者应用界面中显示过渡效果。
值 |
|
|---|---|
|
CAST |
string 用户选择了接收设备，意在通过发送者应用投屏到该接收设备。收件人的确切身份可能未知。 |
|
停止 |
string 用户请求停止在接收器上运行的会话。 |
接收器可用性
string
用于描述 Cast 接收器的可用性。
值 |
|
|---|---|
|
可用 |
string 至少有一个可用接收器与会话请求兼容。 |
|
目前无法购买 |
string 没有可用的接收器。 |
接收器类型
string
值 |
|
|---|---|
|
CAST |
string Cast 接收器，例如 Chromecast |
|
DIAL |
string 拨号设备，例如智能电视 |
|
环聊 |
string 闲荡 |
|
自定义 |
string 客户端提供的自定义接收器 |
发件人平台
string
描述发送者应用平台。
值 |
|
|---|---|
|
Chrome |
string |
|
iOS |
string |
|
ANDROID |
string |
会话状态
string
描述 Cast 会话与其接收器应用的状态。
值 |
|
|---|---|
|
融会贯通 |
string 会话已连接到接收端应用。 |
|
已断开连接 |
string 会话与接收者应用断开连接。接收器应用不一定正在运行。 |
|
已停止 |
string 接收器应用已停止。 |
音量控制类型
string
描述音量控制的类型。
值 |
|
|---|---|
|
衰减 |
string 投放设备音量可以更改。 |
|
修复 |
string 投放设备音量固定不变，无法更改。 |
|
大型 |
string 主系统音量控制，即电视或音频设备的音量发生变化。 |
属性
自动联接政策
string
自动联接政策决定 SDK 在 API 初始化后何时自动将发送者应用连接到现有会话。
值 |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
string 自动在会话启动时使用相同的 appId，在同一标签页和页面来源中连接。 |
|
来源_SCOPED |
string 当会话使用同一 appId 和同一页面来源（无论标签页如何）启动时启动时自动连接。 |
|
已列入网页 |
string 没有自动连接。 |
功能
string
接收设备支持的功能。
值 |
|
|---|---|
|
视频输出 |
string 接收器支持视频输出。 |
|
音频输出 |
string 接收器支持音频输出。 |
|
VIDEO_IN |
string 接收器支持视频输入（摄像头）。 |
|
音频（IN） |
string 接收器支持音频输入（麦克风）。 |
|
多可用区群组 |
string 接收器代表多可用区群组。 |
DefaultActionPolicy
string
默认操作政策决定了 SDK 初始化 API 后何时自动创建会话。还可控制扩展程序弹出式窗口中标签页的默认操作。
值 |
|
|---|---|
|
创建会话 |
string 如果在 API 初始化时投射包含应用的标签页，则 SDK 会停止标签页投放并自动启动应用。扩展程序会提示用户投射应用。 |
|
CAST_THIS_TAB |
string 初始化 API 后，系统不会执行自动启动（即使正在投放标签页）。该扩展程序弹出式窗口会提示用户投放标签页。 |
拨号应用状态
string
DIAL 应用的可能状态。
值 |
|
|---|---|
|
正在运行 |
string |
|
已停止 |
string |
|
错误 |
string 不在规范中，用于指示错误。 |
ErrorCode
string
SDK 可能会返回的错误。
值 |
|
|---|---|
|
取消 |
string 操作已被用户取消。 |
|
TIMEOUT |
string 操作超时。 |
|
API 未启用 |
string 此 API 未初始化。 |
|
参数无效 |
string 操作的参数无效。 |
|
扩展不兼容 |
string 该 API 脚本与已安装的 Cast 扩展程序不兼容。 |
|
附加信息缺失 |
string Cast 扩展程序不可用。 |
|
未收到 |
string 没有接收器与会话请求兼容。 |
|
SESSION_ERROR |
string 无法创建会话，或者会话无效。 |
|
频道错误 |
string 接收者的频道不可用。 |
|
加载_媒体失败 |
string 未能加载媒体。 |
可用
boolean
供客户端检查 API 是否已加载的标志。
接收者操作
string
用户可以对扩展程序中的接收器执行的操作。这些内容可以用于在投射操作完成（或失败）之前在发送者应用界面中显示过渡效果。
值 |
|
|---|---|
|
CAST |
string 用户选择了接收设备，意在通过发送者应用投屏到该接收设备。收件人的确切身份可能未知。 |
|
停止 |
string 用户请求停止在接收器上运行的会话。 |
接收器可用性
string
用于描述 Cast 接收器的可用性。
值 |
|
|---|---|
|
可用 |
string 至少有一个可用接收器与会话请求兼容。 |
|
目前无法购买 |
string 没有可用的接收器。 |
接收器类型
string
值 |
|
|---|---|
|
CAST |
string Cast 接收器，例如 Chromecast |
|
DIAL |
string 拨号设备，例如智能电视 |
|
环聊 |
string 闲荡 |
|
自定义 |
string 客户端提供的自定义接收器 |
发件人平台
string
描述发送者应用平台。
值 |
|
|---|---|
|
Chrome |
string |
|
iOS |
string |
|
ANDROID |
string |
会话状态
string
描述 Cast 会话与其接收器应用的状态。
值 |
|
|---|---|
|
融会贯通 |
string 会话已连接到接收端应用。 |
|
已断开连接 |
string 会话与接收者应用断开连接。接收器应用不一定正在运行。 |
|
已停止 |
string 接收器应用已停止。 |
超时
非 null chrome.cast.Timeout
API 方法的默认超时值（以毫秒为单位）。
版本
非 null 值数组
API 版本。第一个数字是主要版本，第二个数字是次要版本。
音量控制类型
string
描述音量控制的类型。
值 |
|
|---|---|
|
衰减 |
string 投放设备音量可以更改。 |
|
修复 |
string 投放设备音量固定不变，无法更改。 |
|
大型 |
string 主系统音量控制，即电视或音频设备的音量发生变化。 |
方法
addReceiverActionListener
addReceiverActionListener（监听器）
添加一个监听器函数，当用户通过界面开始或停止投射时，系统会调用该函数。在投射操作完成或失败之前，发送者应用可以使用此方法在其界面中显示过渡画面（即暂停本地播放的媒体）。
- 不能保证一定会调用监听器，应用不应依赖于它才能正常运行。
- 系统将向监听器传递已对其执行操作的接收器（如果有）。不过，接收器可能未知，系统会改为传递 null。
- 系统会在用户采取行动后尽快调用监听器。应通过 API 通知应用生成的状态变化之前应调用该方法。
如果使用的是 Framework API，请改用 cast.framework.CastContext#addEventListener，并监听 cast.framework.CastContextEventType#CAST_STATE_CHANGED 事件。
参数 |
|
|---|---|
|
监听器 |
chrome.cast.ReceiverActionListener 要添加的监听器函数。监听器的第一个参数是对其执行操作的接收器。监听器的第二个参数是所请求的操作（请参阅 chrome.cast.ReceiverAction）。 值不能为 null。 |
initialize
initialize（apiConfig、successCallback、errorCallback）
初始化 API。请注意，API 完成初始化后，系统会调用 successfulCallback 和 errorCallback。此后可能会调用 sessionListener 和接收器监听器，但可能会多次调用。
如果使用的是 Framework API，请使用 cast.framework.CastContext#setOptions，而不是此函数。
参数 |
|
|---|---|
|
API |
用于初始化 API 的参数的对象。 值不能为 null。 |
|
成功回调 |
函数() |
|
错误回调 |
函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING。 |
logMessage
logMessage(message)
记录应用的调试消息。如果用户明确选择包含精细日志，系统可能会在反馈报告中向 Google 发送此消息。
参数 |
|
|---|---|
|
信息 |
string 要记录的消息。 |
- 已弃用
- 基于 Presentation API 的 Cast SDK 不支持此功能。
预缓存
precache(数据)
发送请求以预缓存数据。连接后，会话将发送直接请求，否则系统将发送至网络中的所有设备。
参数 |
|
|---|---|
|
data |
string 要预缓存的数据。 |
- 已弃用
- 不支持。
removeReceiverActionListener
removeReceiverActionListener（监听器）
移除之前使用 addReceiverActionListener 添加的监听器函数。
参数 |
|
|---|---|
|
监听器 |
chrome.cast.ReceiverActionListener 要移除的监听器函数。 值不能为 null。 |
requestSession
requestSession(successCallback, errorCallback, sessionRequest)
请求创建或加入接收器应用会话。 默认情况下，系统会使用初始化期间传递给 API 的 SessionRequest；可通过在 sessionRequest 中传递不同的会话请求进行替换。
如果使用 Framework API，请使用 cast.framework.CastContext#requestSession 而不是此函数。
参数 |
|
|---|---|
|
成功回调 |
函数（非 null chrome.cast.Session） |
|
错误回调 |
函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESSION_ERROR、RECEIVER_UNAVAILABLE 和 EXTENSION_MISSING。 请注意，超时计时器在用户选择接收器后启动。选择接收器需要用户执行操作，而且没有超时时间。 如果会话请求已在处理中，则系统会调用 errorCallback 并返回 INVALID_PARAMETER 错误代码和对错误进行说明的说明。 |
|
会话请求 |
可选 值不能为 null。 |
requestSessionById
requestSessionById(sessionId)
请求加入具有指定 ID 的现有会话。加入后，该会话将传递给由 chrome.cast.initialize 设置的 sessionListener。
如果调用此函数时具有给定 sessionId 的会话已知，系统会立即调用 sessionListener。否则，一旦发现具有指定 sessionId 的会话，系统就会调用 sessionListener。
参数 |
|
|---|---|
|
sessionId |
string 要加入的会话的 ID。 |
setCustomReceiver
setCustomReceivers(receivers, successfulCallback, errorCallback)
设置自定义接收器列表
参数 |
|
|---|---|
|
接球员 |
非 null chrome.cast.Receiver 的数组 新列表。 值不能为 null。 |
|
成功回调 |
函数() |
|
错误回调 |
函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR 和 EXTENSION_MISSRING。 |
- 已弃用
- 基于 Presentation API 的 Cast SDK 不支持此功能。
setPageContext
setPageContext（胜出）
为在 iframe 中加载 Cast SDK 的网页初始化 Cast 功能。 应在 SDK 初始化后调用。
参数 |
|
|---|---|
|
胜 |
窗口 页面窗口对象。 值不能为 null。 |
setReceiverDisplayStatus
setReceiverDisplayStatus(receiver, successfulCallback, errorCallback)
设置接收器名称和显示状态。如需将接收器显示为空闲，请将 displayStatus 设为 null。
仅对自定义接收器有效。如果此接收器是 CAST，接收器的 displayStatus 会被忽略；Cast 接收器的状态由接收器应用更新。
参数 |
|
|---|---|
|
接收者 |
接收者。 值不能为 null。 |
|
成功回调 |
函数() 设置状态成功时的回调。 |
|
错误回调 |
函数（非 null chrome.cast.Error） 可能的错误包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED 和 EXTENSION_MISSING。 |
- 已弃用
- 基于 Presentation API 的 Cast SDK 不支持此功能。
取消转义
unescape（转义）返回字符串
用于取消转义 URI 转义字符串的实用程序方法。例如，接收器可读名称以 URI 转义字符串形式返回。如果需要，请使用此方法取消转义该字符串。
参数 |
|
|---|---|
|
转义 |
string 要解除转义的字符串 |
- 返回
-
string未转义的字符串
抽象类型
ReceiverActionListener
ReceiverActionListener()