cast. framework. CastReceiverOptions
Cast 接收器上下文选项。 所有属性都是可选的。
构造函数
CastReceiverOptions
new CastReceiverOptions()
属性
adBreakPreloadTime
(数字或未定义)
我们应提前多长时间预加载单个广告插播时间点的内容(以秒为单位)。这样可以避免过早预加载广告插播时间点,从而避免广告指标出现混乱。 如果未提供,则使用默认值 5 秒。
customNamespaces
具有非 null cast.framework.system.MessageType 属性的非 null 对象
自定义消息命名空间及其类型的映射。自定义消息命名空间必须在应用启动之前进行初始化,因此必须在接收器选项中提供。 (如果此处未提供,则默认消息类型为 JSON)。
disableIdleTimeout
(布尔值或未定义)
如果为 true,则可防止接收器在主动播放停止后进入空闲状态时关闭。此属性应仅用于非媒体应用。
enforceSupportedCommands
布尔值
如果为 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 或 undefined)
包含自定义参数的播放配置。
playWatchedBreak
(布尔值或未定义)
如果为 true,则即使已观看过客户端拼接的广告插播时间点,也会播放该广告插播时间点。
preferredPlaybackRate
(数字或未定义)
如果在加载请求中未指定,则使用此播放速度。允许的范围是 0.5 到 2,其中 1 表示正常速度。
preferredTextLanguage
(字符串或未定义)
如果加载请求未指定有效轨道,则用于文本轨道的语言。
队列
(非 null cast.framework.QueueBase 或未定义)
自定义队列实现。
shakaVariant
(非 null cast.framework.ShakaVariant 或未定义)
应加载哪个版本的 Shaka Player。设置为 cast.framework.ShakaVariant.DEBUG 以加载调试 build。
shakaVersion
(字符串或未定义)
Shaka 版本,采用 MAJOR.MINOR.PATCH 或 MAJOR.MINOR.PATCH-SUFFIX 格式,例如“4.15.56”(当前默认值)。
支持的版本为 >=4.15.56 <6.0.0。 已弃用但仍兼容的版本为 >=2.5.6 <4.15.56。
注意:不建议使用低于默认版本的 Shaka Player 版本,因为最新版本中已修复了许多 bug。您可以在此处指定较新版本,以选择启用默认情况下尚不可用的其他修复或功能。不过,请注意,Web 接收器 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 和播放速度。
uiConfig
(非 null cast.framework.ui.UiConfig 或 undefined)
界面配置。
useLegacyDashSupport
(布尔值或未定义)
如果为 true,则对 DASH 内容使用 MPL。
useShakaForHls
(布尔值或未定义)
如果为 true,则对 HLS 内容使用 Shaka Player。默认设置为 false。
注意:Shaka Player 不是 HLS 内容的默认播放器,因为其功能仍不完善,并且我们希望确保其性能良好且与 HLS 接收器广泛兼容,然后再将其设为默认播放器。如果您在正式发布之前选择启用 Shaka Player for HLS,请向我们报告您遇到的任何问题。 (https://developers.google.com/cast/support) 在全面推出适用于 HLS 的 Shaka Player 之前,我们不保证 Shaka Player 与 HLS 的兼容性,如果您遇到重大问题,我们可能会建议您将此标志还原为默认设置。
versionCode
(数字或未定义)
一个整数,用作内部版本号,表示接收器版本。此数字仅用于在收集指标时区分接收器版本。该值应随着每个版本的发布而递增,并在回滚时保持与该版本绑定。