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