cast. framework. PlayerManager
メディア再生を制御、監視します。
- スロー値
-
non-null Error
コンストラクタを直接使用する場合。PlayerManager
にアクセスするには、cast.framework.CastReceiverContext#getPlayerManager を呼び出します。
Methods
addEventListener
addEventListener(eventType, eventListener)
再生イベントをリッスンするイベント リスナーを追加します。
パラメータ |
|
---|---|
eventType |
(非 null cast.framework.events.EventTypeまたは非 null 非 cast.framework.events.EventType の配列) イベントタイプまたはイベントタイプの配列 |
eventListener |
function(非 null cast.framework.events.Event) |
- スロー値
-
non-null Error
指定された引数が有効でない場合。
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)
サポートされているメディア コマンドの既存のリストに、サポートされている新しいコマンドを追加します。
パラメータ |
|
---|---|
サポートされている MediaCommands |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャスト ステータス |
任意 boolean
|
- 関連ドキュメント
- cast.framework.messages.Command
ブロードキャスト ステータス
BroadcastStatus(includeMedia、requestId、customData、includeQueueItems)
すべての送信者にメディア ステータス メッセージを送信します(ブロードキャスト)。アプリはこれを使用して、カスタムの状態変化を送信します。
パラメータ |
|
---|---|
includeMedia |
任意 boolean
|
requestId |
任意 数値 このレスポンスの原因となった受信リクエストの ID。 |
カスタムデータ |
任意 オブジェクト ステータス メッセージ アプリケーション固有のカスタムデータ。 値は null でもかまいません。 |
includeQueueItems |
任意 boolean ステータス メッセージにキューアイテムを含めるかどうか。デフォルトでは含まれていません。 |
getAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) は数値を返します
メディア時間をメディア絶対時間に変換します。 絶対時間はライブ配信にのみ適用されます。
パラメータ |
|
---|---|
mediaTime |
数値 メディアタイム。 |
- 戻り値
-
nullable number
絶対時間。使用できない場合はnull
。
getAudioTracksManager
getAudioTracksManager() は cast.framework.AudioTracksManager を返します。
AudioTracksManager
インスタンスを取得します。
- 戻り値
-
non-null cast.framework.AudioTracksManager
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() は数値を返します。
現在再生中のブレーク クリップの現在の時刻を秒単位で返します。
- 戻り値
-
nullable number
現在のブレーク クリップ内の現在の時刻(秒)。null
:Player
がブレーク クリップを再生していない場合。
getBreakClipDurationSec
getBreakClipDurationSec() は数値を返します。
現在再生中のブレーク クリップの長さを秒単位で返します。
- 戻り値
-
nullable number
現在の休憩クリップの再生時間。null
:Player
がブレーク クリップを再生していない場合。
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 を返します。
ライブシーク可能な範囲(開始時間と終了時間、秒単位)を返します。値はメディア時間に基づいています。
- 戻り値
getMediaInformation
getMediaInformation() は cast.framework.messages.MediaInformation を返します。
現在のメディアのメディア情報を取得します。
- 戻り値
getMediaTimeForAbsoluteTime
getMediaTimeForAbsoluteTime(absoluteTime) は数値を返します。
メディアの絶対時間をメディア時間に変換します。絶対時間はライブ配信にのみ適用されます。
パラメータ |
|
---|---|
絶対時間 |
数値 メディアの絶対時間。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 を返します。
優先するテキスト トラック スタイルを取得します。
- 戻り値
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
load(loadRequest) は、void を含む Promise を返します。
メディア読み込みのリクエストを開始します。
パラメータ |
|
---|---|
loadRequest |
cast.framework.messages.LoadRequestData メディアを読み込むリクエスト。 値を null にすることはできません。 |
- 戻り値
-
non-null Promise containing void
オペレーションが成功した場合、または失敗した場合は拒否されたときに、解決される Promise。
一時停止
Pause()
現在再生中のメディアを一時停止します。
再生
play()
現在一時停止中のメディアを再生します。
removeEventListener
removeEventListener(eventType, eventListener)
特定の再生イベントに対して追加されたイベント リスナーを削除します。 一致するイベント リスナーが存在しない場合、この呼び出しは無視されます。
パラメータ |
|
---|---|
eventType |
(非 null cast.framework.events.EventTypeまたは非 null 非 cast.framework.events.EventType の配列) eventType またはイベントタイプの配列 |
eventListener |
function(非 null cast.framework.events.Event) |
removeSupportedMediaCommands(削除)
removeSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)
サポートされているメディア コマンドのリストからコマンドを削除します。
パラメータ |
|
---|---|
サポートされている MediaCommands |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャスト ステータス |
任意 boolean
|
- 関連ドキュメント
- cast.framework.messages.Command
seek
Seek(シーク時間)
現在のメディアでシークします。
パラメータ |
|
---|---|
シーク時間 |
数値 |
sendCustomState
sendCustomState(state)
アプリの再生ロジックから UI ロジックにカスタム状態を送信します。この方法により、再生ロジックと UI を分離できます。
ロジックと UI の分離を維持することで、ローカル再生とリモコンの両方に同じ UI ロジックを使用できます。このメソッドによって送信されるカスタム状態は、PlayerData
を通じて UI で利用できます。
パラメータ |
|
---|---|
state |
オブジェクト カスタム ステータス オブジェクト。 値を null にすることはできません。 |
sendError
sendError(senderId, requestId, type, reason, customData)
特定の送信者にエラーを送信する。
パラメータ |
|
---|---|
送信者 ID |
文字列 送信者 ID。 |
requestId |
数値 このエラーが発生した受信リクエストの ID。 |
type |
cast.framework.messages.ErrorType エラータイプ。 値を null にすることはできません。 |
reason |
任意 cast.framework.messages.ErrorReason エラーの理由。 値は null でもかまいません。 |
カスタムデータ |
任意 オブジェクト エラー メッセージ アプリケーション固有のカスタムデータ。 値は null でもかまいません。 |
sendLocalMediaRequest
sendLocalMediaRequest(リクエスト)
ローカル メディア リクエストを送信します。
パラメータ |
|
---|---|
誤り |
cast.framework.messages.RequestData 値を null にすることはできません。 |
sendStatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
特定の送信者にメディア ステータス メッセージを送信する。
パラメータ |
|
---|---|
送信者 ID |
文字列 送信者 ID。 |
requestId |
数値 このレスポンスの原因となった受信リクエストの ID。 |
includeMedia |
任意 boolean
|
カスタムデータ |
任意 オブジェクト ステータス メッセージ アプリケーション固有のカスタムデータ。 値は null でもかまいません。 |
includeQueueItems |
任意 boolean ステータス メッセージにキューアイテムを含めるかどうか。デフォルトでは含まれていません。 |
setIdleReason
setIdleReason(idleReason)
プレーヤーが IDLE
状態になる理由を設定します。これにより、IDLE
状態を強制するアプリは、それを行う理由(カスタムエラーなど)を示すことができます。アイドル状態の理由は、次のステータス メッセージで送信されます。注: ほとんどのアプリで、この値を設定する必要はありません。これは、特別な状況でアプリが Player
を IDLE
状態に移行する必要があり、デフォルトの idleReason が目的の動作を反映していない場合にのみ必要です。
パラメータ |
|
---|---|
アイドル理由 |
cast.framework.messages.IdleReason
値を null にすることはできません。 |
setMediaElement
setMediaElement(mediaElement)
使用する HTMLMediaElement
を設定します。HTMLMediaElement
の Promise
が設定されている場合、Promise
が解決された後にメディアの再生が開始されます。
パラメータ |
|
---|---|
mediaElement |
(null 以外の HTMLMediaElement、または null 以外の HTMLMediaElement を含む null 以外の Promise)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
メディア情報を設定します。
パラメータ |
|
---|---|
mediaInformation |
cast.framework.messages.MediaInformation 値を null にすることはできません。 |
opt_broadcast |
任意 boolean |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
特定の読み込みリクエストに対して cast.framework.PlaybackConfig を返すか変更するハンドラを設定します。ハンドラ パラメータは、レシーバの LoadRequestData
とデフォルトの PlaybackConfig
(CastReceiverOptions
で指定)です。メディアの再生を防ぐために、変更された再生構成または null
を返す必要があります。戻り値は、サーバーからのデータを待機するために Promise
にすることもできます。
パラメータ |
|
---|---|
handler |
Functions(非 null cast.framework.messages.LoadRequestData、非 null cast.framework.PlaybackConfig) リクエスト固有の再生構成を提供する関数。 値は null でもかまいません。 |
setMediaUrlResolver
setMediaUrlResolver(resolver)
LOAD
リクエストのメディア URL を返すハンドラを設定します。このハンドラを使用すると、メディア コンテンツ URL をメディア ステータスの一部として公開せずに済みます。デフォルトでは、メディア contentId
がコンテンツ URL として使用されます。
パラメータ |
|
---|---|
リゾルバ |
function(null 以外の cast.framework.messages.LoadRequestData) メディア コンテンツの URL を解決するための関数。 値は null でもかまいません。 |
setMessageInterceptor
setMessageInterceptor(type、インターセプタ)
受信メッセージと送信メッセージのインターセプトを設定します。インターセプトはリクエスト データを更新でき、更新されたデータ(データをすぐには返せない場合)を含む Promise
、または処理すべきでない場合は null
を返します。注: LOAD
メッセージ インターセプタが指定されていても、個別の PRELOAD
インターセプタが指定されていない場合、PRELOAD
メッセージに対して LOAD
インターセプタが呼び出されます。
パラメータ |
|
---|---|
type |
cast.framework.messages.MessageType 値を null にすることはできません。 |
インターセプター |
function(null 以外の cast.framework.messages.RequestData) 値は null でもかまいません。 |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
PlayerManager
で再生構成を設定します。
パラメータ |
|
---|---|
playConfig |
値を null にすることはできません。 |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)
レシーバーがサポートするメディア コマンドを設定します。
パラメータ |
|
---|---|
サポートされている MediaCommands |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャスト ステータス |
任意 boolean
|
- 関連ドキュメント
- cast.framework.messages.Command
停止
stop()
現在再生中のメディアを停止します。