类：CastReceiverContext

cast.framework。CastReceiverContext

class   static

管理底层库的加载并初始化底层 Cast 接收器 SDK。

抛出

non-null Error 如果未在文档正文中创建 MediaElement。如果创建了多个媒体元素，开发者应将“castMediaElement”类设置为其中一个，供 CAF 接收器使用。

方法

getInstance

静态

getInstance() returns cast.framework.CastReceiverContext

返回 CastReceiverContext 单例实例。

返回

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

为自定义消息通道设置消息监听器。一个命名空间可以有多个监听器。

参数

命名空间

string

命名空间。请注意，有效的命名空间必须以字符串“urn:x-cast:”为前缀。

监听器

function(non-null cast.framework.system.Message)
抛出

Error 如果系统尚未就绪或此应用不支持命名空间。

addEventListener

addEventListener(type, handler)

添加用于投放系统事件的监听器。

参数

类型

cast.framework.system.EventType

值不能为 null。

handler

function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

检查平台是否支持视频流或音频流的给定媒体参数。

参数

mimeType

string

媒体 MIME 类型。它由类型和子类型组成，以“/”分隔。它可以是视频 MIME 类型或音频 MIME 类型。

编解码器

可选

string

带英文引号的字符串包含以英文逗号分隔的格式列表，其中每种格式用于指定流中存在的媒体样本类型。

width

可选

number

描述数据流水平分辨率（以像素为单位）。

高度

可选

number

描述数据流垂直分辨率（以像素为单位）。

帧速率

可选

number

描述数据流的帧速率。
返回

boolean 能否在 Chromecast 上播放直播。

getApplicationData

getApplicationData() 会返回 cast.framework.system.ApplicationData

在系统准备就绪后提供应用信息，否则将为 null。

返回

nullable cast.framework.system.ApplicationData 应用信息；如果系统尚未就绪，则为 null。

getDeviceCapabilities

getDeviceCapabilities() 返回对象

在系统准备就绪后提供设备功能信息，否则将为 null。如果返回空对象，设备不会公开任何功能信息。

返回

nullable Object：设备功能信息（键值对）。如果系统尚未就绪，该值将为 null。如果平台未提供任何设备功能信息，它可能为空对象。

getPlayerManager

getPlayerManager() 会返回 cast.framework.PlayerManager

获取可以控制和监控媒体播放的播放器实例。

返回

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) 会返回 cast.framework.system.Sender

按发送者 ID 获取发送者

参数

senderId

string

要返回的发件人 ID。
返回

nullable cast.framework.system.Sender 

getSenders

getSenders() 会返回非 null cast.framework.system.Sender 的数组

获取当前已连接的发件人的列表。

返回

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() 会返回 cast.framework.system.StandbyState

报告投放应用的 HDMI 输入是否处于待机状态。

返回

non-null cast.framework.system.StandbyState：应用的 HDMI 输入是否处于待机状态。如果无法确定（例如因为电视不支持 CEC 命令），则返回的值为 UNKNOWN。

getSystemState

getSystemState() returns cast.framework.system.SystemState

提供有关系统状态的应用信息。

返回

non-null cast.framework.system.SystemState 系统状态。

getVisibilityState

getVisibilityState() 会返回 cast.framework.system.VisibilityState

报告投射应用是否为 HDMI 有效输入源。

返回

non-null cast.framework.system.VisibilityState：确定应用是否为 HDMI 有效输入。如果无法确定（例如因为电视不支持 CEC 命令），则返回的值为 UNKNOWN。

isSystemReady

isSystemReady() 返回布尔值

当应用调用开始时，系统将发送 ready 事件，以表明应用信息已就绪，并且应用可在有一个发送者连接时立即发送消息。

返回

boolean 系统是否已准备好处理消息。

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

开始加载播放器 js。这可用于在调用 start 之前启动接收器的早期阶段开始加载播放器 js 代码。 如果播放器已加载（已调用 start），则此函数为空操作。

参数

useLegacyDashSupport

可选

boolean

指示应将 MPL 用于 DASH 内容。

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

移除之前通过 CastReceiverContext#addCustomMessageListener 注册的消息监听器。

参数

命名空间

string

命名空间。请注意，有效的命名空间必须以字符串“urn:x-cast:”为前缀。

监听器

function(non-null cast.framework.system.Message)

要取消注册的消息监听器函数。
抛出

Error 如果系统尚未就绪或此应用不支持命名空间。

removeEventListener

removeEventListener(type, handler)

移除用于投放系统事件的监听器。

参数

类型

cast.framework.system.EventType

值不能为 null。

handler

function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

向特定发件人发送邮件。

参数

命名空间

string

命名空间。请注意，有效的命名空间必须以字符串“urn:x-cast:”为前缀。

senderId

（字符串或未定义）

位发送者 ID，或者未定义向所有发送者广播。

data

任意类型

消息载荷。

值不能为 null。
抛出

Error 准备消息时出错。

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

如果应用添加了调试状态信息以记录在反馈报告中，则应调用此函数来响应 feedbackstarted 事件。 它接受一个参数“message”，该字符串表示应用想要记录的调试信息。

参数

feedbackMessage

string
已弃用
使用 cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

设置应用状态。应用应在其状态发生变化时调用此方法。如果未定义或设置为空字符串，则默认情况下，应用注册期间建立的应用名称值将用于应用状态。

参数

statusText

string

状态文本。

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

设置处理程序，以便为反馈报告提供额外数据。处理程序将在创建报告的反馈时调用，并且应以字符串或字符串 promise 的形式返回额外数据。return promise 应在 5 秒内解析，以便包含在报告中。

参数

feedbackHandler

function()

值可能为 null。

setInactivityTimeout

setInactivityTimeout(maxInactivity)

设置接收器非活动超时时间。建议在调用 Start 时设置最大非活跃值值，但不更改该值。此 API 仅用于开发/调试目的。

参数

maxInactivity

number

关闭无响应连接前的时间间隔（以秒为单位）。

setLoggerLevel

setLoggerLevel(level)

设置日志详尽程度。

参数

level

cast.framework.LoggerLevel

日志记录级别。

值不能为 null。

start

start(options) 会返回 cast.framework.CastReceiverContext

初始化系统管理器和媒体管理器，以便接收方应用可以接收来自发送者的请求。

参数

选项

（非 Null cast.framework.CastReceiverOptions 或可选的非 null 对象）
返回

non-null cast.framework.CastReceiverContext 

个经停点

stop()

关闭接收器应用。