类:CastReceiverContext

方法

getInstance

静态

getInstance() 返回 cast.framework.CastReceiverContext

返回 CastReceiverContext 单例实例。

返回

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(命名空间, 监听器)

为自定义消息渠道设置消息监听器。

参数

命名空间

字符串

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

监听器

函数(非 null cast.framework.system.Event

抛出

Error 如果系统未准备就绪或此命名空间不支持命名空间。

addEventListener

addEventListener(类型, 处理程序)

向投放系统事件添加了监听器。

参数

类型

cast.framework.system.EventType

值不能为 null。

handler

函数(非 null cast.framework.system.Event

canDisplayType

canDisplayType(mimeType, 编解码器, 宽度, 高度, 帧速率) 返回布尔值

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

参数

mimeType

字符串

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

编解码器

选填

字符串

带英文引号的字符串包含以英文逗号分隔的格式列表,其中每种格式均指定信息流中的媒体样本类型。

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 获取发送者

参数

发送者 ID

字符串

要返回的发送者的 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 输入是否处于待机状态。例如,如果 TV 不支持 CEC 命令,则返回值为 UNKNOWN。

getSystemState

getSystemState() 会返回 cast.framework.system.SystemState

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

返回

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

getVisibilityState

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

报告投射应用是否为 HDMI 活动输入。

返回

non-null cast.framework.system.VisibilityState:应用是否为 HDMI 活动输入。例如,如果 TV 不支持 CEC 命令,则返回值为 UNKNOWN。

系统就绪

isSystemReady() 返回布尔值

当应用调用开始时,系统将发送 ready 事件,以指示应用信息已就绪,并且应用在连接了 1 个发送者之后能够立即发送消息。

返回

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

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

参数

使用 DashDashSupport

选填

布尔值

指明 MPL 应用于 DASH 内容。

移除 CustomMessageListener

removeCustomMessageListener(命名空间, 监听器)

移除自定义消息渠道的消息监听器。

参数

命名空间

字符串

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

监听器

函数 (cast.framework.system.Event)

抛出

Error 如果系统未准备就绪或此命名空间不支持命名空间。

移除事件监听器

removeEventListener(类型, 处理程序)

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

参数

类型

cast.framework.system.EventType

值不能为 null。

handler

函数(非 null cast.framework.system.Event

sendCustomMessage

sendCustomMessage(namespace, sendId, message)

向特定发件人发送消息。

参数

命名空间

字符串

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

发送者 ID

(字符串或未定义)

发送者 ID,或发送给所有发送者的未定义状态。

私信

任意类型

消息。

值不能为 null。

抛出

Error 准备邮件时出错。

发送反馈

sendFeedbackMessage(feedbackMessage)

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

参数

反馈消息

字符串

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

setApplicationState

setApplicationState(statusText)

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

参数

状态文本

字符串

状态文本。

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

设置处理程序以向反馈报告提供额外数据。 在创建报告的反馈时,系统将调用处理程序,并且应以字符串或 promise 的形式返回额外数据。 应在 5 秒内解析返回 promise,才能将其纳入报告中。

参数

feedbackHandler

函数()

值可以为 null。

setInactivityTimeout

setInactivityTimeout(maxInactivity)

设置接收器处于非活动状态的超时时间。建议在调用“Start”时不设置最大非活动值。此 API 仅用于开发/调试目的。

参数

最大无活动

number

关闭无响应连接之前的时间间隔(以秒为单位)。

setLoggerLevel

setLoggerLevel(级别)

设置日志详细程度。

参数

level

cast.framework.LoggerLevel

日志记录级别。

值不能为 null。

启动

start(options) 返回 cast.framework.CastReceiverContext

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

参数

选项

(非 null cast.framework.CastReceiverOptions 或可选的非 null 对象)

返回

non-null cast.framework.CastReceiverContext 

停止

停止

关闭接收器应用。