類別: PlayerManager

方法

addEventListener

addEventListener(eventType, eventListener)

新增監聽監聽事件的事件監聽器。

參數

eventType

(非空值的 cast.framework.events.EventType 或非空值 cast.framework.events.EventType 的非空值陣列

事件類型或事件陣列

eventListener

function(非空值 cast.framework.events.Event)

擲回

non-null Error 如果特定引數無效。

新增媒體指令

addSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)

將新的支援的指令新增至支援的媒體指令清單。

參數

支援的 MediaCommands

號碼

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

廣播狀態

選填

布林值

true 表示傳送者應已收到有關變更的通知 (如未提供,系統會通知寄件者)。

另請參閱
cast.framework.messages.Command

廣播狀態

airStatus(includeMedia、requestId、customData、includeQueueItems)

傳送媒體狀態訊息給所有傳送者 (廣播)。 應用程式會使用此方法傳送自訂狀態變更。

參數

includeMedia

選填

布林值

true 表示訊息應包含媒體資訊。

要求 ID

選填

號碼

造成此回應的傳入要求 ID。

自訂資料

選填

物件

狀態訊息應用程式專屬的自訂資料。

值可以是空值。

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() 傳回非空值的 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(corTime) 會傳回數字

將媒體絕對時間轉換為媒體時間。絕對時間僅適用於直播。

參數

絕對時間

號碼

媒體的絕對時間,以 UNIX Epoch 紀元時間表示 (從 Unix Epoch 紀元時間起算的秒數)。

傳回

nullable number 媒體時間 (如果無法取得,則為 null)。

getPlaybackConfig

getPlaybackConfig() 傳回 cast.framework.PlaybackConfig

傳回播放設定。

傳回

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() 傳回數字

傳回目前的播放速率。先呼叫 1,再呼叫接收器 CastReceiverContext#start

傳回

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 Epoch 紀元時間表示 (從 Unix Epoch 紀元時間起算的秒數)。絕對時間僅適用於直播,

傳回

nullable number 

getStats

getStats() 會傳回 cast.framework.stats.Stats

傳回播放統計資料。必要時,系統會匯總整個播放工作階段的統計資料。

傳回

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

傳回資訊清單剖析期間發生的定時中繼資料。這是指 HLS 中的 #EXT-X-DATERANGE,而 DASH 中的 EventStream

傳回

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

load(loadRequest) 傳回包含 void 的 Promise

啟動載入媒體的要求。

參數

載入要求

cast.framework.messages.LoadRequestData

載入媒體的要求。

值不得為空值。

傳回

non-null Promise containing void 已在作業成功時解決問題,或是失敗時拒絕。

暫停

暫停()

暫停目前正在播放的媒體。

play

play()

播放目前暫停的媒體。

移除事件監聽器

removeEventListener(eventType, eventListener)

移除特定播放事件新增的事件監聽器。 如果沒有相符的事件監聽器,系統就會忽略這個呼叫。

參數

eventType

(非空值的 cast.framework.events.EventType 或非空值 cast.framework.events.EventType 的非空值陣列

EventType 或事件類型的陣列

eventListener

function(非空值 cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)

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

參數

支援的 MediaCommands

號碼

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

廣播狀態

選填

布林值

true 表示傳送者應已收到有關變更的通知 (如未提供,系統會通知寄件者)。

另請參閱
cast.framework.messages.Command

seek

find(findkTime)

查看目前媒體的內容。

參數

跳轉時間

號碼

sendCustomState

sendCustomState(州)

將自訂狀態從應用程式播放邏輯傳送至 UI 邏輯。這個方法有助於區隔播放邏輯和 UI。讓邏輯和使用者介面的方式保持各自獨立,可讓本機播放和遠端控制使用相同的 UI 邏輯。此方法傳送的自訂狀態可透過 PlayerData 提供給使用者介面。

參數

最終的隱藏狀態

物件

自訂狀態物件。

值不得為空值。

另請參閱
cast.framework.ui.PlayerData#customState

傳送錯誤

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

將錯誤傳送給特定的寄件者。

參數

傳送者 ID

字串

傳送者 ID。

要求 ID

號碼

導致此錯誤的傳入要求 ID。

類型

cast.framework.messages.ErrorType

錯誤類型。

值不得為空值。

原因

選填

cast.framework.messages.ErrorReason

錯誤原因。

值可以是空值。

自訂資料

選填

物件

錯誤訊息的應用程式特定自訂資料。

值可以是空值。

sendLocalMediaRequest

sendLocalMediaRequest(要求)

傳送本機媒體要求。

參數

申請。

cast.framework.messages.RequestData

值不得為空值。

傳送狀態

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

傳送媒體狀態訊息給特定寄件者。

參數

傳送者 ID

字串

傳送者 ID。

要求 ID

號碼

造成此回應的傳入要求 ID。

includeMedia

選填

布林值

true 表示訊息應包含 MediaInformation 執行個體。

自訂資料

選填

物件

狀態訊息應用程式專屬的自訂資料。

值可以是空值。

includeQueueItems

選填

布林值

是否要在狀態訊息中加入佇列項目。根據預設,系統不會納入這類篩選器。

setIdleReason

setIdleReason(idleReason)

設定玩家處於 IDLE 狀態的原因。這可讓應用程式強制強制執行 IDLE 狀態來表示原因 (例如自訂錯誤)。閒置狀態會顯示在下一個狀態訊息中。注意:大多數應用程式都不需要設定這個值,只有在應用程式需要讓 Player 進入特殊狀態時,IDLE 才會改變,且預設的閒置原因未反映預期行為時,才需要使用這個屬性。

參數

閒置原因

cast.framework.messages.IdleReason

處於 IDLE 狀態的原因。

值不得為空值。

setMediaElement

setMediaElement(mediaElement)

設定要使用的 HTMLMediaElement。如果設定了 HTMLMediaElementPromise,媒體問題會在 Promise 解決後開始播放。

參數

媒體元素

(非空值 HTMLMediaElement 或非空值 Promise,包含非空值 HTMLMediaElement)

Player 要使用的 MediaElement

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

設定媒體資訊。

參數

媒體資訊

cast.framework.messages.MediaInformation

值不得為空值。

Opt_broadcast

選填

布林值

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

設定處理常式,用於針對特定載入要求傳回或修改 cast.framework.PlaybackConfig。處理常式參數是接收器的 LoadRequestData 和預設 PlaybackConfig (由 CastReceiverOptions 提供)。處理常式應傳回修改的播放設定,或 null 來防止播放媒體。傳回值也可能是 Promise,以便等待伺服器資料。

參數

處理常式

function(非空值 cast.framework.messages.LoadRequestData, 非空值 cast.framework.PlaybackConfig)

提供要求特定播放設定的函式。

值可以是空值。

setMediaUrlResolver

setMediaUrlResolver(Resolver)

設定處理常式以傳回 LOAD 要求的媒體網址。這個處理常式可避免在媒體狀態中發布媒體內容網址。根據預設,系統會使用媒體 contentId 做為內容網址。

參數

解析器

function(非空值 cast.framework.messages.LoadRequestData)

解析媒體內容網址的函式。

值可以是空值。

setMessageInterceptor

setMessageInterceptor(類型, 攔截器)

設定內送和外寄郵件的攔截值。 攔截器可更新要求資料,且應傳回更新後的資料、傳回已更新資料的 Promise (如果無法立即傳回資料);如果不應處理要求,則傳回 null注意:如果提供了 LOAD 訊息攔截器,但沒有提供任何 PRELOAD 攔截器,系統會針對 PRELOAD 訊息呼叫 LOAD 攔截器。

參數

類型

cast.framework.messages.MessageType

值不得為空值。

攔截器

function(非空值 cast.framework.messages.RequestData)

值可以是空值。

setPlaybackConfig

setPlaybackConfig(playbackConfig)

設定 PlayerManager 的播放設定。

參數

播放設定

cast.framework.PlaybackConfig

值不得為空值。

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)

設定接收器支援的媒體指令。

參數

支援的 MediaCommands

號碼

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

廣播狀態

選填

布林值

true 表示傳送者應已收到有關變更的通知 (如未提供,系統會通知寄件者)。

另請參閱
cast.framework.messages.Command

停止

Stop()

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