类:PlayerManager

方法

addEventListener

addEventListener(eventType, eventListener)

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

参数

eventType

(非 null cast.framework.events.EventType 或非 null 非 null cast.framework.events.EventType 数组)

事件类型或事件类型数组

事件监听器

函数(非 null cast.framework.events.Event

抛出

non-null Error 如果指定的参数无效,则会发生此错误。

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, 广播 Status)

将受支持的新命令添加到现有的受支持媒体命令列表中。

参数

支持的 MediaCommands

number

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

广播状态

选填

布尔值

true 表示应将更改通知给发送者(如果未提供,通知给发送者)。

另请参阅
cast.framework.messages.Command

广播状态

BroadcastStatus(includeMedia, requestId, customData, includeQueueItems)

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

参数

包含媒体

选填

布尔值

true 表示消息应包含媒体信息。

requestId

选填

number

导致此响应的传入请求的 ID。

自定义数据

选填

对象

状态消息:特定于应用的自定义数据。

值可以为 null。

includeQueueItems

选填

布尔值

是否在状态消息中包含队列项。默认不包含这些变量。

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) 返回数字

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

参数

MediaTime

number

媒体时间。

返回

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() 返回非 null cast.framework.messages.Break 数组

返回休息时段列表。

返回

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

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() 返回数字

获取当前的接收器支持的媒体命令。与 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(绝对时间) 返回数字

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

参数

绝对时间

number

媒体的绝对时间,以 UNIX 纪元时间(与 Unix 计时原点之间相隔的秒数)表示。

返回

nullable number 媒体时间;如果不可用,则为 null

getPlaybackConfig

getPlaybackConfig() 返回 cast.framework.PlaybackConfig

返回播放配置。

返回

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() 返回数字

返回当前播放速率。 在调用接收器 CastRecevierContext#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() 返回(cast.framework.QueueManager 或未定义)

获取 QueueManager 实例。

返回

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

getRawCurrentTimeSec

getRawCurrentTimeSec() 返回数字

获取当前媒体的已播放时长,而不减去广告插播时长。

返回

number:所用时间(以秒为单位)。如果没有媒体播放,此值将为 0

getStartAbsoluteTime

getStartAbsoluteTime() 会返回号码

获取绝对媒体开始时间,以 UNIX 纪元时间(与 Unix 计时原点之间相隔的秒数)表示。绝对时间仅适用于直播。

返回

nullable number 

getStats

getStats() 会返回 cast.framework.Stats

返回播放统计信息。在适当情况下,统计信息将在整个播放会话期间进行汇总。

返回

non-null cast.framework.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() 返回数字

获取接收器支持的媒体命令。应仅在调用 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

发出加载媒体的请求。

参数

loadRequest

cast.framework.messages.LoadRequestData

加载媒体的请求。

值不能为 null。

返回

non-null Promise containing void:操作成功时解析的 Promise,如果操作失败,则会拒绝。

暂停

pause()

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

play

play()

播放当前暂停的媒体。

移除事件监听器

removeEventListener(eventType, eventListener)

移除为给定播放事件添加的事件监听器。如果不存在匹配的事件监听器,系统会忽略此调用。

参数

eventType

(非 null cast.framework.events.EventType 或非 null 非 null cast.framework.events.EventType 数组)

一种事件类型或事件类型数组

事件监听器

函数(非 null cast.framework.events.Event

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, 广播 Status)

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

参数

支持的 MediaCommands

number

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

广播状态

选填

布尔值

true 表示应将更改通知给发送者(如果未提供,通知给发送者)。

另请参阅
cast.framework.messages.Command

seek

Seek(seekTime)

在当前媒体中查找。

参数

SeekTime

number

sendCustomState

sendCustomState(state)

将自定义播放状态从应用播放逻辑发送到界面逻辑。 此方法有助于将播放逻辑和界面分离。 通过将逻辑与界面保持分离,用户可以对本地播放和遥控器使用相同的界面逻辑。 此方法发送的自定义状态可通过 PlayerData 提供给界面。

参数

state

对象

自定义状态对象。

值不能为 null。

另请参阅
cast.framework.ui.PlayerData#customState

发送错误

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

向特定发送者发送错误。

参数

发送者 ID

字符串

发送者 ID。

requestId

number

导致此错误的传入请求的 ID。

类型

cast.framework.messages.ErrorType

错误类型。

值不能为 null。

reason

选填

cast.framework.messages.ErrorReason

错误原因。

值可以为 null。

自定义数据

选填

对象

特定于应用的错误消息。

值可以为 null。

sendLocalMediaRequest

sendLocalMediaRequest(请求)

发送本地媒体请求。

参数

请求

cast.framework.messages.RequestData

值不能为 null。

发送状态

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

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

参数

发送者 ID

字符串

发送者 ID。

requestId

number

导致此响应的传入请求的 ID。

包含媒体

选填

布尔值

true 表示消息应包含 MediaInformation 实例。

自定义数据

选填

对象

状态消息:特定于应用的自定义数据。

值可以为 null。

includeQueueItems

选填

布尔值

是否在状态消息中包含队列项。默认不包含这些变量。

setIdleReason 类

setIdleReason(idleReason)

设置播放器处于 IDLE 状态的原因。 这样,想要强制 IDLE 状态的应用就可以说明这样做的原因(例如自定义错误)。空闲状态会在下一个状态消息中发送。注意:大多数应用都不需要设置此值。只有在应用需要使 Player 在特殊情况下变为 IDLE 状态,并且默认的 idalReason 不反映预期行为时,才需要使用此属性。

参数

idleReason

cast.framework.messages.IdleReason

处于 IDLE 状态的原因。

值不能为 null。

setMediaElement

setMediaElement(mediaElement)

设置要使用的 HTMLMediaElement。如果设置了 HTMLMediaElementPromise,系统会在解析 Promise 后开始播放媒体。

参数

MediaElement

(非 null HTMLMediaElement 或包含非 null HTMLMediaElement 的非 promise)

Player 将使用的 MediaElement

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

设置媒体信息。

参数

媒体信息

cast.framework.messages.MediaInformation

值不能为 null。

opt_broadcast

选填

布尔值

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(处理程序)

设置处理程序以针对特定加载请求返回或修改 cast.framework.PlaybackConfig。处理程序参数是接收器的 LoadRequestData 和默认 PlaybackConfig(在 CastReceiverOptions 中提供)。处理程序应返回修改后的播放配置,或者为 null,以防止媒体播放。返回值也可以是 Promise,以允许等待服务器的数据。

参数

handler

函数(非 null cast.framework.messages.LoadRequestData、非 null cast.framework.PlaybackConfig

用于提供特定于请求的播放配置的函数。

值可以为 null。

setMediaUrlResolver

setMediaUrlResolver(resolver)

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

参数

解析器

函数(非 null cast.framework.messages.LoadRequestData

用于解析媒体内容网址的函数。

值可以为 null。

setMessageInterceptor

setMessageInterceptor(type, 拦截器)

设置传入和传出消息的拦截器。 拦截器可以更新请求数据,并应返回更新后的数据、包含更新后的数据的 Promise(如果无法立即返回数据),或返回不应处理请求时的 null注意:如果提供了 LOAD 消息拦截器,但未提供单独的 PRELOAD 拦截器,则系统将针对 PRELOAD 消息调用 LOAD 拦截器。

参数

类型

cast.framework.messages.MessageType

值不能为 null。

拦截器

函数(非 null cast.framework.messages.RequestData

值可以为 null。

setPlaybackConfig

setPlaybackConfig(playbackConfig)

PlayerManager 上设置播放配置。

参数

播放配置

cast.framework.PlaybackConfig

值不能为 null。

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, 广播 Status)

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

参数

支持的 MediaCommands

number

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

广播状态

选填

布尔值

true 表示应将更改通知给发送者(如果未提供,通知给发送者)。

另请参阅
cast.framework.messages.Command

停止

停止

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