addEventListener

addEventListener(eventType, eventListener)

添加一个监听播放事件的事件监听器。

抛出

non-null Error 如果给定的实参无效。

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

向现有的支持的媒体命令列表添加新的支持的命令。

另请参阅

cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

向所有发送方（广播）发送媒体状态消息。 应用使用此方法发送自定义状态更改。

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) 返回数字

将媒体时间转换为媒体绝对时间。 绝对时间仅适用于直播。

返回

nullable number 绝对时间，如果未提供，则为 null。

getAudioTracksManager

getAudioTracksManager() 返回 cast.framework.AudioTracksManager

获取 AudioTracksManager 实例。

返回

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() 返回数值

返回当前正在播放的插播广告片段的当前时间（以秒为单位）。

返回

nullable number 当前广告插播片段内的当前时间（以秒为单位）。 当 Player 未播放插播广告片段时，会引发 null。

getBreakClipDurationSec

getBreakClipDurationSec() 返回数值

返回当前播放的广告插播片段的时长（以秒为单位）。

返回

nullable number 当前插播片段的时长。 当 Player 未播放插播片段时，会引发 null。

getBreakManager

getBreakManager() 返回 cast.framework.breaks.BreakManager

获取 BreakManager 实例。

返回

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() returns Array of non-null cast.framework.messages.Break

返回一个中断列表。

返回

non-null Array of non-null cast.framework.messages.Break 

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() 返回 number

获取当前接收器支持的媒体命令。 与 getSupportedMediaCommands() 不同，此方法的返回值会根据当前的播放状态动态变化。例如，在播放广告期间，SEEK 命令可能不受支持。 此方法只能在调用接收器 CastReceiverContext#start 之后调用，否则将返回 0。

另请参阅

cast.framework.messages.Command

返回

number 应用支持的媒体命令的位掩码。

getCurrentTimeSec

getCurrentTimeSec() 返回数字

获取当前媒体的已播放时间。

返回

number 已用时间（以秒为单位）。如果没有媒体正在播放，则此值为 0。

getDurationSec

getDurationSec() 返回数值

获取当前播放媒体的时长（以秒为单位）。

返回

number 媒体时长。如果没有媒体内容正在播放，则为 NaN。

getLiveSeekableRange

getLiveSeekableRange() 返回 cast.framework.messages.LiveSeekableRange

返回直播可搜索范围，其中包含开始时间和结束时间（以秒为单位）。 这些值基于媒体时间。

返回

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

getMediaInformation() 返回 cast.framework.messages.MediaInformation

获取当前媒体的媒体信息。

返回

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) 返回 number

将媒体绝对时间转换为媒体时间。绝对时间仅适用于直播。

返回

nullable number 媒体时间，如果未提供，则为 null。

getPlaybackConfig

getPlaybackConfig() 返回 cast.framework.PlaybackConfig

返回播放配置；如果默认值未被替换，则返回 null。

返回

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() 返回 number

返回当前播放速率。 在调用接收器 CastReceiverContext#start 之前返回 1。

返回

number 当前播放速率。

getPlayerState

getPlayerState() 返回 cast.framework.messages.PlayerState

获取 Player 状态。

返回

non-null cast.framework.messages.PlayerState 当前 Player 的状态。

getPreferredPlaybackRate

getPreferredPlaybackRate() 返回数值

获取首选播放速率。 可在关闭事件中使用，以将最新的首选播放速率保存到持久性存储空间，以便在下一个会话中在投屏选项中使用。

返回

number 

getPreferredTextLanguage

getPreferredTextLanguage() 返回字符串

获取首选文本轨道语言。

返回

nullable string 

getPreferredTextStyle

getPreferredTextStyle() 返回 cast.framework.messages.TextTrackStyle

获取首选文本轨道样式。

返回

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() returns (cast.framework.QueueManager or undefined)

获取 QueueManager 实例。

返回

(non-null cast.framework.QueueManager or undefined) 

getRawCurrentTimeSec

getRawCurrentTimeSec() 返回数值

获取当前媒体的已播放时间，不减去广告插播时间。

返回

number 已用时间（以秒为单位）。如果没有媒体正在播放，则此值为 0。

getRawSeekableRange

getRawSeekableRange() 返回 cast.framework.messages.Range

返回当前媒体的可搜索范围。

注意：此值与 getRawCurrentTimeSec() 的单位一致，但与 seek() 的单位不一致。此值不考虑广告或任何其他媒体偏移量。除非您确定需要原始值，否则应使用 getLiveSeekableRange()。

返回

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() 返回数字

获取绝对媒体开始时间，以 UNIX 纪元时间（自 UNIX 纪元以来的秒数）表示。 绝对时间仅适用于直播。

返回

nullable number 

getStats

getStats() 返回 cast.framework.stats.Stats

返回播放统计信息。统计信息会在整个播放会话中进行汇总（如果适用）。

返回

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() 返回 number

获取接收器支持的媒体命令。只能在调用 CastReceiverContext#start() 之后调用，否则会返回 0。支持的媒体命令值完全由接收器应用控制。它不会根据 MediaStatus 自动更新。

另请参阅

cast.framework.messages.Command

返回

number 应用支持的媒体命令的位掩码。

getTextTracksManager

getTextTracksManager() 返回 cast.framework.TextTracksManager

获取 TextTracksManager 实例。

返回

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() 会返回非 null cast.framework.TimedMetadata 的数组

返回在清单解析期间遇到的定时元数据。在 HLS 中为 #EXT-X-DATERANGE，在 DASH 中为 EventStream。

返回

non-null Array of non-null cast.framework.TimedMetadata 

负荷

load(loadRequest) 返回包含 void 的 Promise

发起加载媒体的请求。

返回

non-null Promise containing void 在操作成功时解析的 promise，如果失败则拒绝。

暂停

pause()

暂停当前正在播放的媒体。

播放

play()

播放当前已暂停的媒体。

removeEventListener

removeEventListener(eventType, eventListener)

移除为指定播放事件添加的事件监听器。 如果不存在匹配的事件监听器，则忽略此调用。

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

从支持的媒体命令列表中移除命令。

另请参阅

cast.framework.messages.Command

努力提供服务

seek(seekTime)

在当前媒体中搜索。

sendCustomState

sendCustomState(state)

从应用播放逻辑向界面逻辑发送自定义状态。 此方法有助于分离播放逻辑和界面。 保持逻辑与界面分离，可让您将相同的界面逻辑用于本地播放和远程控制。 通过此方法发送的自定义状态可通过 PlayerData 提供给界面。

另请参阅

cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

向特定发送者发送错误。

sendLocalMediaRequest

sendLocalMediaRequest(request)

发送本地媒体请求。

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

向特定发送者发送媒体状态消息。

setIdleReason

setIdleReason(idleReason)

设置玩家处于 IDLE 状态的原因。 这样一来，想要强制进入 IDLE 状态的应用就可以指明这样做的原因（例如自定义错误）。 空闲原因在下一条状态消息中发送。 注意：大多数应用都不需要设置此值。仅当应用需要在特殊情况下使 Player 进入 IDLE 状态，且默认 idleReason 无法反映预期行为时，才需要此方法。

setMediaElement

setMediaElement(mediaElement)

设置要使用的 HTMLMediaElement。如果设置了 HTMLMediaElement 的 Promise，则在解析 Promise 后，媒体开始播放。

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

设置媒体信息。

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

设置一个处理程序，以针对特定加载请求返回或修改 cast.framework.PlaybackConfig。处理程序参数是接收器的 LoadRequestData 和默认 PlaybackConfig（在 CastReceiverOptions 中提供）。处理程序应返回修改后的播放配置，或返回 null 以阻止媒体播放。返回值也可以是 Promise，以便等待来自服务器的数据。

setMediaUrlResolver

setMediaUrlResolver(resolver)

设置一个处理程序，以返回 LOAD 请求的媒体网址。 此处理程序可用于避免将媒体内容网址作为媒体状态的一部分发布。默认情况下，媒体 contentId 用作内容网址。

setMessageInterceptor

setMessageInterceptor(type, interceptor)

设置传入和传出消息的拦截器。 拦截器可以更新请求数据，并且应返回更新后的数据、包含更新后数据的 Promise（如果无法立即返回数据），或者在不应处理请求时返回 null。 注意：如果提供了 LOAD 消息拦截器，但未提供单独的 PRELOAD 拦截器，则会针对 PRELOAD 消息调用 LOAD 拦截器。

setPlaybackConfig

setPlaybackConfig(playbackConfig)

在 PlayerManager 上设置播放配置。

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

设置接收器支持的媒体命令。

另请参阅

cast.framework.messages.Command

停止

stop()

停止当前正在播放的媒体。