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() 會傳回 number

傳回目前播放中廣告插播片段的目前時間 (以秒為單位)。

傳回

nullable number 目前廣告插播片段中的時間 (以秒為單位)。 null，但 Player 未播放中斷片段。

getBreakClipDurationSec

getBreakClipDurationSec() 會傳回 number

以秒為單位傳回目前播放中廣告插播片段的長度。

傳回

nullable number 目前插播片段的長度。 null，但 Player 未播放中斷片段。

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() 會傳回數字

取得接收端目前支援的媒體指令。 與 getSupportedMediaCommands() 不同，這個方法傳回的值會根據目前的播放狀態動態變更。舉例來說，播放廣告時可能不支援 SEEK 指令。呼叫接收器 CastReceiverContext#start 後，才能呼叫這個方法，否則會傳回 0。

另請參閱

cast.framework.messages.Command

傳回

number 應用程式支援的媒體指令位元遮罩。

getCurrentTimeSec

getCurrentTimeSec() 會傳回 number

取得目前媒體的已播放時間。

傳回

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) returns 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() returns number

取得偏好的播放速率。 可在關機事件中使用，將最新的偏好播放速率儲存至永久儲存空間，以便在下一個工作階段的 Cast 選項中使用。

傳回

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

取得目前媒體的經過播放時間，不扣除廣告插播時間。

傳回

number經過的時間 (以秒為單位)。如果沒有播放任何媒體，則為 0。

getRawSeekableRange

getRawSeekableRange() 會傳回 cast.framework.messages.Range

傳回目前的媒體可搜尋範圍。

注意：這與 getRawCurrentTimeSec() 的單位相符，但與 seek() 不符！這不包含廣告或任何其他媒體的位移。除非您確定需要原始值，否則應改用 getLiveSeekableRange()。

傳回

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() 會傳回數字

取得媒體的絕對開始時間，以 UNIX Epoch 時間表示 (自 Unix Epoch 紀元時間起算的秒數)。絕對時間僅適用於直播。

傳回

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() 會傳回非空值的 cast.framework.TimedMetadata 陣列

傳回資訊清單剖析期間遇到的時間碼中繼資料。在 HLS 中為 #EXT-X-DATERANGE，在 DASH 中為 EventStream。

傳回

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

load

load(loadRequest) 會傳回包含空白的 Promise

發出載入媒體的要求。

傳回

non-null Promise containing void：作業成功時會解析的 Promise，失敗時則會遭到拒絕。

暫停

pause()

暫停目前播放的媒體。

播放

play()

播放目前暫停的媒體。

removeEventListener

removeEventListener(eventType, eventListener)

移除為指定播放事件新增的事件監聽器。 如果沒有相符的事件監聽器，系統會忽略此呼叫。

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

從支援的媒體指令清單中移除指令。

另請參閱

cast.framework.messages.Command

seek

seek(seekTime)

在目前的媒體中搜尋。

sendCustomState

sendCustomState(state)

將應用程式播放邏輯的自訂狀態傳送至 UI 邏輯。 這個方法有助於分離播放邏輯和 UI。維持邏輯與 UI 之間的區隔，可讓您將相同的 UI 邏輯用於本機播放和遠端控制。透過這個方法傳送的自訂狀態可供 UI 使用 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。如果設定 Promise 的 HTMLMediaElement，媒體會在 Promise 解決後開始播放。

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

設定媒體資訊。

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

設定處理常式，針對特定載入要求傳回或修改 cast.framework.PlaybackConfig。處理常式參數是接收器 (在 CastReceiverOptions 中提供) 的 LoadRequestData 和預設 PlaybackConfig。處理常式應傳回修改後的播放設定，或 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()

停止播放目前播放的媒體。