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 の null 以外の配列) イベントタイプまたはイベントタイプの配列 |
eventListener |
function(null 以外の cast.framework.events.Event) |
- 例外
-
non-null Error
指定された引数が有効でない場合。
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)
サポートされているメディア コマンドの既存のリストに、サポートされている新しいコマンドを追加します。
パラメータ |
|
---|---|
サポートされている MediaCommands |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャストのステータス |
省略可 ブール値
|
- 関連ドキュメント
- cast.framework.messages.Command
ブロードキャストのステータス
ブロードキャスト ステータス(includeMedia、requestId、customData、includeQueueItems)
すべての送信者にメディア ステータス メッセージを送信します(ブロードキャスト)。アプリはこれを使用して、カスタムの状態変更を送信します。
パラメータ |
|
---|---|
includeMedia |
省略可 ブール値
|
requestId |
省略可 数値 このレスポンスの原因となった受信リクエストの ID。 |
カスタムデータ |
省略可 オブジェクト ステータス メッセージのアプリケーション固有のカスタムデータ。 値を null にすることもできます。 |
includeQueueItems |
省略可 ブール値 ステータス メッセージにキューアイテムを含めるかどうか。デフォルトでは追加されません。 |
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 エポック時刻からの経過秒数)。 |
- 戻り値
-
nullable number
メディア時間。表示できない場合はnull
。
getPlaybackConfig
getPlaybackConfig() は cast.framework.PlaybackConfig を返します。
再生構成を返します。
- 戻り値
-
nullable cast.framework.PlaybackConfig
getPlaybackRate
getPlaybackRate() は数値を返します
現在の再生レートを返します。
レシーバ CastReceiverContext#start
が呼び出される前に 1
を返します。
- 戻り値
-
number
現在の再生速度
getPlayerState
getPlayerState() が cast.framework.messages.PlayerState を返す
Player
状態を取得します。
- 戻り値
-
non-null cast.framework.messages.PlayerState
: 現在のPlayer
の状態。
getPreferredPlaybackRate
getPreferredPlaybackRate() は数値を返します
希望する再生速度を取得します。シャットダウン イベントで最新の優先再生速度を永続ストレージに保存し、キャスト オプションの次のセッションで使用できます。
- 戻り値
-
number
getPreferredText の言語
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.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() は、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。失敗した場合は拒否される Promise。
pause
一時停止
現在再生中のメディアを一時停止します。
再生
play()
現在一時停止しているメディアを再生します。
removeEventListener
removeEventListener(eventType, eventListener)
特定の再生イベントに追加されたイベント リスナーを削除します。 一致するイベント リスナーが存在しない場合、この呼び出しは無視されます。
パラメータ |
|
---|---|
eventType |
(null 以外の cast.framework.events.EventType または null 以外の cast.framework.events.EventType の null 以外の配列) eventType またはイベントタイプの配列 |
eventListener |
function(null 以外の cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands、BroadcastStatus)
サポートされているメディア コマンドのリストからコマンドを削除します。
パラメータ |
|
---|---|
サポートされている MediaCommands |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャストのステータス |
省略可 ブール値
|
- 関連ドキュメント
- cast.framework.messages.Command
seek
シーク(seekTime)
現在のメディアを検索します。
パラメータ |
|
---|---|
シークタイム |
数値 |
sendCustomState
sendCustomState(state)
アプリの再生ロジックから UI ロジックにカスタム状態を送信します。このメソッドにより、再生ロジックと UI を分離できます。ロジックと UI の分離を維持することで、ローカル再生とリモコンの両方で同じ UI ロジックを使用できるようになります。このメソッドによって送信されるカスタム状態は、PlayerData
を通じて UI で利用できます。
パラメータ |
|
---|---|
使って |
オブジェクト カスタム状態オブジェクト。 値を null にすることはできません。 |
sendError
sendError(senderId, requestId, type, reason, customData)
特定の送信者にエラーを送信します。
パラメータ |
|
---|---|
送信者 ID |
string 送信者 ID。 |
requestId |
数値 このエラーの原因となった受信リクエストの ID。 |
type |
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 |
string 送信者 ID。 |
requestId |
数値 このレスポンスの原因となった受信リクエストの ID。 |
includeMedia |
省略可 ブール値
|
カスタムデータ |
省略可 オブジェクト ステータス メッセージのアプリケーション固有のカスタムデータ。 値を null にすることもできます。 |
includeQueueItems |
省略可 ブール値 ステータス メッセージにキューアイテムを含めるかどうか。デフォルトでは追加されません。 |
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 にすることはできません。 |
オプティマイズのブロードキャスト |
省略可 ブール値 |
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 |
数値 アプリがサポートするメディア コマンドのビットマスク。 |
ブロードキャストのステータス |
省略可 ブール値
|
- 関連ドキュメント
- cast.framework.messages.Command
停止
stop()
現在再生中のメディアを停止します。