cast. framework. CastReceiverContext
            管理底层库的加载并初始化底层 Cast 接收器 SDK。
- 抛出
 - 
                
non-null Error如果未在 document body 上创建 MediaElement。如果创建了多个媒体元素,开发者应将“castMediaElement”类设置为其中一个,CAF 接收器将使用该元素。 
方法
getInstance
getInstance() 返回 cast.framework.CastReceiverContext
返回 CastReceiverContext 单例实例。
- 返回
 - 
                  
non-null cast.framework.CastReceiverContext 
addCustomMessageListener
addCustomMessageListener(namespace, listener)
为自定义消息渠道设置消息监听器。一个命名空间可以有多个监听器。
                      参数 | 
                  |
|---|---|
| 
                         命名空间  | 
                      
                         字符串 命名空间。请注意,有效的命名空间必须以字符串“urn:x-cast:”为前缀。  | 
                    
| 
                         监听器  | 
                      
                         function(non-null cast.framework.system.Message)  | 
                    
- 抛出
 - 
                  
Error如果系统未就绪或此应用不支持相应命名空间。 
addEventListener
addEventListener(type, handler)
添加了监听器以接收投屏系统事件。
                      参数 | 
                  |
|---|---|
| 
                         类型  | 
                      
                         cast.framework.system.EventType 值不得为 null。  | 
                    
| 
                         处理程序  | 
                      
                         function(non-null cast.framework.system.Event)  | 
                    
canDisplayType
canDisplayType(mimeType, codecs, width, height, framerate) 返回 boolean
检查平台是否支持视频或音频流的指定媒体参数。
                      参数 | 
                  |
|---|---|
| 
                         mimeType  | 
                      
                         字符串 媒体 MIME 类型。它由以“/”分隔的类型和子类型组成。它可以是视频或音频 MIME 类型。  | 
                    
| 
                         编解码器  | 
                      
                         可选 字符串 带引号的字符串包含以英文逗号分隔的格式列表,其中每种格式都指定了流中存在的媒体样本类型。  | 
                    
| 
                         width  | 
                      
                         可选 数值 描述了视频流的水平分辨率(以像素为单位)。  | 
                    
| 
                         高度  | 
                      
                         可选 数值 描述了视频流的垂直分辨率(以像素为单位)。  | 
                    
| 
                         帧速率  | 
                      
                         可选 数值 描述了视频流的帧速率。  | 
                    
- 返回
 - 
                  
boolean如果可以在 Chromecast 上播放该视频流。 
getApplicationData
getApplicationData() 返回 cast.framework.system.ApplicationData
在系统准备就绪后提供应用信息,否则为 null。
- 返回
 - 
                  
nullable cast.framework.system.ApplicationData应用信息;如果系统未就绪,则为 null。 
getDeviceCapabilities
getDeviceCapabilities() 返回 cast.receiver.CastReceiverManager.DeviceCapabilitiesObj
在系统准备就绪后提供设备功能信息,否则为 null。如果返回空对象,则表示设备未公开任何功能信息。
- 返回
 - 
                  
nullable cast.receiver.CastReceiverManager.DeviceCapabilitiesObj设备功能信息(键值对)。如果系统尚未准备就绪,则为 null。如果平台未公开任何设备功能信息,则可能为空对象。 
getDeviceInformation
getDeviceInformation() 返回 cast.receiver.CastReceiverManager.DeviceInformationObj
在系统准备就绪后提供与功能无关的设备识别信息,否则为“null”。如果返回空对象,则表示设备未公开任何此类信息。
- 返回
 - 
                  
nullable cast.receiver.CastReceiverManager.DeviceInformationObj设备信息(键值对)。如果系统尚未准备就绪,则为 null。如果平台不公开此信息,则此字段可能为空对象。 
getPlayerManager
getPlayerManager() 返回 cast.framework.PlayerManager
获取可控制和监控媒体播放的播放器实例。
- 返回
 - 
                  
non-null cast.framework.PlayerManager 
getSender
getSender(senderId) 返回 cast.framework.system.Sender
按发送者 ID 获取发送者
                      参数 | 
                  |
|---|---|
| 
                         senderId  | 
                      
                         字符串 要返回的发送者的 ID。  | 
                    
- 返回
 - 
                  
nullable cast.framework.system.Sender 
getSenders
getSenders() returns Array of non-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() 返回 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() 返回布尔值
当应用调用 start 时,系统会发送 ready 事件,以表明应用信息已准备就绪,并且应用可以在有发送者连接时立即发送消息。
- 返回
 - 
                  
boolean系统是否已准备好处理消息。 
loadPlayerLibraries
loadPlayerLibraries(useLegacyDashSupport)
开始加载播放器 JS。这可用于在调用 start 之前,在启动接收器的早期阶段开始加载播放器 JS 代码。 如果已加载播放器(已调用 start),此函数将不执行任何操作。
                      参数 | 
                  |
|---|---|
| 
                         useLegacyDashSupport  | 
                      
                         可选 布尔值 指明应将 MPL 用于 DASH 内容。  | 
                    
removeCustomMessageListener
removeCustomMessageListener(namespace, listener)
移除之前通过 CastReceiverContext#addCustomMessageListener 注册的消息监听器。
              
                      参数 | 
                  |
|---|---|
| 
                         命名空间  | 
                      
                         字符串 命名空间。请注意,有效的命名空间必须以字符串“urn:x-cast:”为前缀。  | 
                    
| 
                         监听器  | 
                      
                         function(non-null cast.framework.system.Message) 要取消注册的消息监听器函数。  | 
                    
- 抛出
 - 
                  
Error如果系统未就绪或此应用不支持相应命名空间。 
removeEventListener
removeEventListener(type, handler)
移除用于广播系统事件的监听器。
                      参数 | 
                  |
|---|---|
| 
                         类型  | 
                      
                         cast.framework.system.EventType 值不得为 null。  | 
                    
| 
                         处理程序  | 
                      
                         function(non-null cast.framework.system.Event)  | 
                    
sendCustomMessage
sendCustomMessage(namespace, senderId, data)
向特定发送者发送消息。
                      参数 | 
                  |
|---|---|
| 
                         命名空间  | 
                      
                         字符串 命名空间。请注意,有效的命名空间必须以字符串“urn:x-cast:”为前缀。  | 
                    
| 
                         senderId  | 
                      
                         (字符串或未定义) senderId,如果广播给所有发送者,则为 undefined。  | 
                    
| 
                         数据  | 
                      
                         任意类型 消息载荷。 值不得为 null。  | 
                    
- 抛出
 - 
                  
Error如果准备消息时出错。 
sendFeedbackMessage
sendFeedbackMessage(feedbackMessage)
如果应用要将调试状态信息添加到反馈报告中的日志中,则应在响应 feedbackstarted 事件时调用此函数。 它接受一个“message”参数,该参数是一个字符串,表示应用要记录的调试信息。
                      参数 | 
                  |
|---|---|
| 
                         feedbackMessage  | 
                      
                         字符串  | 
                    
- 已弃用
 - 使用 cast.framework.CastReceiverContext#setFeedbackHandler
 
setApplicationState
setApplicationState(statusText)
设置应用状态。当应用的状态发生变化时,应调用此方法。如果未定义或设置为空字符串,则默认情况下,系统会使用在应用注册期间确定的应用名称值作为应用状态。
                      参数 | 
                  |
|---|---|
| 
                         statusText  | 
                      
                         字符串 状态文本。  | 
                    
setFeedbackHandler
setFeedbackHandler(feedbackHandler)
设置处理程序以向反馈报告提供额外数据。 当创建报告的反馈时,将调用处理程序,并且处理程序应返回额外的字符串数据或字符串 promise。 退回承诺应在 5 秒内解决,以便将其纳入报告中。
                      参数 | 
                  |
|---|---|
| 
                         feedbackHandler  | 
                      
                         function() 值可能为 null。  | 
                    
setInactivityTimeout
setInactivityTimeout(maxInactivity)
设置接收器空闲超时时间。建议在调用 Start 时设置最大不活动值,并且不要更改该值。此 API 仅用于开发/调试目的。
                      参数 | 
                  |
|---|---|
| 
                         maxInactivity  | 
                      
                         数值 在关闭无响应的连接之前的时间间隔(以秒为单位)。  | 
                    
setLoggerLevel
setLoggerLevel(level)
设置日志详细程度级别。
                      参数 | 
                  |
|---|---|
| 
                         level  | 
                      
                        
                         日志记录级别。 值不得为 null。  | 
                    
start
start(options) 返回 cast.framework.CastReceiverContext
初始化系统管理器和媒体管理器,以便接收器应用可以接收来自发送器的请求。
                      参数 | 
                  |
|---|---|
| 
                         选项  | 
                      
                         (非 null cast.framework.CastReceiverOptions 或可选的非 null 对象)  | 
                    
- 返回
 - 
                  
non-null cast.framework.CastReceiverContext 
停止
stop()
关闭接收器应用。