cast. 框架。 CastReceiverOptions
Cast 接收器上下文选项。 所有房源均为可选属性。
构造函数
CastReceiver 选项
新的 CastReceiverOptions()
属性
custom 命名空间
具有非 null cast.framework.system.MessageType 属性的非 null 对象
自定义消息命名空间及其类型的映射。自定义消息命名空间必须在应用启动之前初始化,因此必须在接收器选项中提供。如果此处未提供,则默认消息类型为 JSON。
disableIdleTimeout
(布尔值或未定义)
如果为 true,则阻止接收器在有效播放停止后变为空闲状态。此属性应仅用于非媒体应用。
强制执行的受支持命令
boolean
如果为 true,则不在支持的 Commands 映射图中的任何媒体命令都会生成错误。cast.framework.messages.ErrorReason 将设为 NOT_SUPPORTED。默认值为 false,这允许在不检查地图的情况下执行媒体命令。
localSenderId
(字符串或未定义)
用于本地请求的发送者 ID。默认值为“local”。
maxInactivity
(数字或未定义)
关闭空闲的发送者连接前的最长时间(以秒为单位)。设置此值可使检测信号消息保持连接活跃。用于以比正常的 TCP 超时更快的速度检测无响应发件人。最小值为 5 秒;不强制规定上限,但通常要过几分钟才能触发平台 TCP 超时。默认值为 10 秒。
MediaElement
(非 null HTMLMediaElement 或 undefined)
要用来播放内容的媒体元素。默认行为是使用网页中找到的第一个媒体元素。
播放配置
(非 null cast.framework.PlaybackConfig 或未定义)
包含自定义参数的播放配置。
playWatchedBreak
(布尔值或未定义)
如果为 true,则客户端拼接的广告插播时间点将会播放,即使已经观看完毕也是如此。
首选播放率
(数字或未定义)
在加载请求中未指定时的播放速率。允许的范围为 0.5 到 2,其中 1 表示正常速度。
首选文本语言
(字符串或未定义)
当加载请求未指定有效轨道时,用于文本轨道的语言。
队列
(非 null cast.framework.QueueBase 或未定义)
自定义队列实现。
shakaVersion
(字符串或未定义)
MAJOR.MINOR.PATCH 格式的 Shaka 版本,例如“4.3.4”(当前默认值)。
支持的版本高于 3.3.16 <5.0.0。已废弃但仍兼容的版本为 >=2.5.6 <3.3.16。
注意:不建议使用默认的 Shaka Player 版本,因为在最新版本中修复了许多 bug。您可以在此处指定较新的版本,以选择启用默认尚不支持的其他修复或功能。不过请注意,未来版本的 Web Receiver SDK 可能会更改支持的版本范围,并强制使用您在此处指定的版本之外的其他版本。此标志只能用作临时措施,并且应获得 Cast 支持团队的指导。使用 (https://developers.google.com/cast/support) 需自行承担风险。
跳过 MplLoad
(布尔值或未定义)
如果为 true,则阻止接收器加载 MPL 播放器。
skipPlayersLoad
(布尔值或未定义)
如果为 true,则阻止接收器加载 MPL 或 Shaka 播放器库。相当于将 skipMplLoad 和 skipShakaLoad 都设置为 true。
跳过 ShakaLoad
(布尔值或未定义)
如果为 true,则阻止接收器加载 Shaka 播放器。
状态文本
(字符串或未定义)
表示应用状态的文本。它应符合国际化规则,因为发件人应用可能会显示这些规则。
supportedCommands
(数字或未定义)
应用支持的媒体命令的位掩码。必须始终支持 LOAD、PLAY、STOP、GET_STATUS。如果未提供此值,则系统也会支持 PAUSE、SEEK、STREAM_VOLUME、STREAM_MUTE、EDIT_TRACKS 和 PLAYBACK_RATE。
界面配置
(非 null cast.framework.ui.UiConfig 或未定义)
界面配置。
useLegacyDashSupport
(布尔值或未定义)
如果为 true
,请为 DASH 内容使用 MPL。
使用 ShahForForHls
(布尔值或未定义)
如果为 true
,请使用 Shaka Player 播放 HLS 内容。默认设置为 false
。
注意:Shaka Player 不是 HLS 内容的默认设置,因为我们仍然缺少功能,而且我们希望在将它设为默认版本之前,保证其性能出色且与 HLS 接收器兼容。如果您在正式版本发布之前选择启用 Shaka Player for HLS,我们建议您报告遇到的任何问题。 在 https://developers.google.com/cast/support 上
versionCode
(数字或未定义)
一个整数,用作接收者版本的内部版本号。此数量仅用于在收集指标时区分接收器版本。它应该随着每个版本的递增,并在回滚时保持与相应版本的绑定。