命名空间：cast

chrome.投射

命名空间   静态

这是 chrome.cast 命名空间。

类

ApiConfig

在初始化时保留 API 的配置。

CredentialsData

凭据数据，用于识别发件人的凭据。

DialRequest

启动 DIAL 应用的请求。

错误

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

图片

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

接收器

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

ReceiverDisplayStatus

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

SenderApplication

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

会话

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

SessionRequest

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

超时

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

Volume

设备或媒体流的音量。

命名空间

media

枚举

AutoJoinPolicy

静态

string

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

值
TAB_AND_ORIGIN_SCOPED	string 当会话开始且在同一标签页和页面来源中使用相同的 appId 时自动连接。
ORIGIN_SCOPED	string 在会话开始时使用同一 appId 和同一网页来源（无论制表符如何）时自动连接。
PAGE_SCOPED	string 无自动连接。

能力

静态

string

接收方设备支持的功能。

值
VIDEO_OUT	string 接收器支持视频输出。
AUDIO_OUT	string 接收器支持音频输出。
VIDEO_IN	string 接收器支持视频输入（摄像头）。
AUDIO_IN	string 接收器支持音频输入（麦克风）。
MULTIZONE_GROUP	string 接收器代表一个多可用区群组。

DefaultActionPolicy

静态

string

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

值
CREATE_SESSION	string 如果在 API 初始化时投射包含应用的标签页，则 SDK 会停止标签页投射并自动启动该应用。扩展程序弹出式窗口会提示用户投射应用。
CAST_THIS_TAB	string 初始化 API 后，系统不会自动启动，即使正在投放标签页也是如此。扩展程序弹出式窗口会提示用户投放标签页。

DialAppState

静态

string

DIAL 应用的可能状态。

值
正在运行	string
已停止	string
错误	string 不属于规范的一部分，用于指示错误。

ErrorCode

静态

string

SDK 可能返回的错误。

值
取消	string 操作已被用户取消。
TIMEOUT	string 操作超时。
API_NOT_INITIALIZED	string API 未初始化。
INVALID_PARAMETER	string 操作的参数无效。
EXTENSION_NOT_COMPATIBLE	string 此 API 脚本与已安装的 Cast 扩展程序不兼容。
EXTENSION_MISSING	string Cast 扩展程序不可用。
RECEIVER_UNAVAILABLE	string 没有接收器与此会话请求兼容。
SESSION_ERROR	string 无法创建会话，或者会话无效。
CHANNEL_ERROR	string 接收方的频道不可用。
LOAD_MEDIA_FAILED	string 加载媒体失败。

ReceiverAction

静态

string

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

值
CAST	string 用户选择了接收器，以便与发送器应用一起投放到该接收器。接收者的确切身份可能未知。
停止	string 用户请求停止在接收器上运行会话。

ReceiverAvailability

静态

string

说明 Cast 接收器的可用性。

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

ReceiverType

静态

string

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

SenderPlatform

静态

string

描述发送者应用平台。

值
Chrome	string
iOS	string
ANDROID	string

SessionStatus

静态

string

向接收器应用说明 Cast 会话的状态。

值
融会贯通	string 会话已连接到接收方应用。
已断开连接	string 会话与接收方应用断开连接。接收器应用可能正在运行，也可能未运行。
已停止	string 接收器应用已停止。

VolumeControlType

静态

string

描述音量控制的类型。

值
吸引	string Cast 设备的音量可以更改。
修复	string 投放设备的音量是固定的，无法更改。
大师	string 主系统音量控制，即电视或音频设备的音量更改。

属性

AutoJoinPolicy

静态

string

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

值
TAB_AND_ORIGIN_SCOPED	string 当会话开始且在同一标签页和页面来源中使用相同的 appId 时自动连接。
ORIGIN_SCOPED	string 在会话开始时使用同一 appId 和同一网页来源（无论制表符如何）时自动连接。
PAGE_SCOPED	string 无自动连接。

能力

静态

string

接收方设备支持的功能。

值
VIDEO_OUT	string 接收器支持视频输出。
AUDIO_OUT	string 接收器支持音频输出。
VIDEO_IN	string 接收器支持视频输入（摄像头）。
AUDIO_IN	string 接收器支持音频输入（麦克风）。
MULTIZONE_GROUP	string 接收器代表一个多可用区群组。

DefaultActionPolicy

静态

string

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

值
CREATE_SESSION	string 如果在 API 初始化时投射包含应用的标签页，则 SDK 会停止标签页投射并自动启动该应用。扩展程序弹出式窗口会提示用户投射应用。
CAST_THIS_TAB	string 初始化 API 后，系统不会自动启动，即使正在投放标签页也是如此。扩展程序弹出式窗口会提示用户投放标签页。

DialAppState

静态

string

DIAL 应用的可能状态。

值
正在运行	string
已停止	string
错误	string 不属于规范的一部分，用于指示错误。

ErrorCode

静态

string

SDK 可能返回的错误。

值
取消	string 操作已被用户取消。
TIMEOUT	string 操作超时。
API_NOT_INITIALIZED	string API 未初始化。
INVALID_PARAMETER	string 操作的参数无效。
EXTENSION_NOT_COMPATIBLE	string 此 API 脚本与已安装的 Cast 扩展程序不兼容。
EXTENSION_MISSING	string Cast 扩展程序不可用。
RECEIVER_UNAVAILABLE	string 没有接收器与此会话请求兼容。
SESSION_ERROR	string 无法创建会话，或者会话无效。
CHANNEL_ERROR	string 接收方的频道不可用。
LOAD_MEDIA_FAILED	string 加载媒体失败。

isAvailable

静态

boolean

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

ReceiverAction

静态

string

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

值
CAST	string 用户选择了接收器，以便与发送器应用一起投放到该接收器。接收者的确切身份可能未知。
停止	string 用户请求停止在接收器上运行会话。

ReceiverAvailability

静态

string

说明 Cast 接收器的可用性。

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

ReceiverType

静态

string

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

SenderPlatform

静态

string

描述发送者应用平台。

值
Chrome	string
iOS	string
ANDROID	string

SessionStatus

静态

string

向接收器应用说明 Cast 会话的状态。

值
融会贯通	string 会话已连接到接收方应用。
已断开连接	string 会话与接收方应用断开连接。接收器应用可能正在运行，也可能未运行。
已停止	string 接收器应用已停止。

超时

静态

非 null chrome.cast.Timeout

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

版本

常量   静态

非 null 数字数组

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

VolumeControlType

静态

string

描述音量控制的类型。

值
吸引	string Cast 设备的音量可以更改。
修复	string 投放设备的音量是固定的，无法更改。
大师	string 主系统音量控制，即电视或音频设备的音量更改。

方法

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

静态

initialize(apiConfig, SuccessCallback, errorCallback)

初始化 API。请注意，当 API 完成初始化后，系统将调用 SuccessCallback 和 errorCallback。此后，您可以随时调用 sessionListener 和 ReceiveListenerListener，还可以多次调用。

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

参数
apiConfig	chrome.cast.ApiConfig 包含用于初始化 API 的参数的对象。 值不能为 null。
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING。

logMessage

静态

logMessage(message)

记录来自应用的调试消息。如果用户明确选择包含精细日志，则此消息可以通过反馈报告发送给 Google。

参数
信息	string 要记录的消息。

已弃用

不支持基于 Presentation API 的 Cast SDK。

预缓存

静态

precache(数据)

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

参数
data	string 要预缓存的数据。

已弃用

不支持。

removeReceiverActionListener

静态

removeReceiverActionListener(listener)

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

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

requestSession

静态

requestSession(successCallback, errorCallback, sessionRequest)

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

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

参数
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESSION_ERROR、RECEIVER_UNAVAILABLE 和 EXTENSION_MISSING。 请注意，超时计时器在用户选择接收者后开始计时。 选择接收者需要用户执行操作，没有超时。如果会话请求已在进行中，系统将调用 errorCallback，其中包含 INVALID_PARAMETER 错误代码和对错误进行说明的说明。
sessionRequest	可选 chrome.cast.SessionRequest 值不能为 null。

requestSessionById

静态

requestSessionById(sessionId)

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

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

参数
sessionId	string 要加入的会话的 ID。

setCustomReceivers

静态

setCustomReceivers(receivers, successCallback, errorCallback)

设置自定义接收器列表

参数
接收者	非 null chrome.cast.Receiver 数组 新列表。 值不能为 null。
successCallback	function()
errorCallback	function(non-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, successCallback, errorCallback)

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

仅对 CUSTOM 接收器有效。如果此接收器为 CAST，则接收器的 displayStatus 将被忽略；Cast 接收器状态由接收器应用更新。

参数
接收者	chrome.cast.Receiver 接收方。 值不能为 null。
successCallback	function() 设置状态成功时的回调。
errorCallback	function(non-null chrome.cast.Error) 可能的错误包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED 和 EXTENSION_MISSING。

已弃用

不支持基于 Presentation API 的 Cast SDK。

unescape

静态

unEsc(escaped) 会返回字符串

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

参数
已转义	string 要取消转义的字符串

返回

string 非转义字符串

抽象类型

ReceiverActionListener

静态

ReceiverActionListener()