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() が数値を返す

現在再生中のブレーク クリップの現在の時刻を秒単位で返します。

戻り値

nullable number 現在のブレーク クリップ内の現在の時間（秒）。 Player がブレーク クリップを再生していない場合の null。

getBreakClipDurationSec

getBreakClipDurationSec() が number を返す

現在再生中のブレーク クリップの時間を秒単位で返します。

戻り値

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(absoluteTime) は数値を返します。

メディアの絶対時間をメディア時間に変換します。絶対時間はライブ ストリームにのみ適用されます。

戻り値

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() が number を返す

優先再生速度を取得します。 シャットダウン イベント時に使用して、最新の優先再生速度を永続ストレージに保存できます。これにより、次のセッションでキャスト オプションで使用できるようになります。

戻り値

number 

getPreferredTextLanguage

getPreferredTextLanguage() が string を返す

使用するテキスト トラックの言語を取得します。

戻り値

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 経過時間（秒）。再生中のメディアがない場合は 0 になります。

getStartAbsoluteTime

getStartAbsoluteTime() が数値を返す

メディアの絶対開始時間を UNIX エポック時間（Unix エポックからの経過秒数）として取得します。絶対時間はライブ配信にのみ適用されます。

戻り値

nullable number 

getStats

getStats() returns 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 を返す

メディア読み込みリクエストを開始します。

戻り値

non-null Promise containing void オペレーションが成功したときに解決され、失敗した場合は拒否される Promise。

pause

pause()

再生中のメディアを一時停止します。

再生

play()

現在一時停止されているメディアを再生します。

removeEventListener

removeEventListener(eventType, eventListener)

特定の再生イベントに対して追加されたイベント リスナーを削除します。 一致するイベント リスナーが存在しない場合、この呼び出しは無視されます。

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

サポートされているメディア コマンドのリストからコマンドを削除します。

関連ドキュメント

cast.framework.messages.Command

尽力する

シーク（seekTime）

現在のメディアでシークします。

sendCustomState

sendCustomState(state)

アプリの再生ロジックから UI ロジックにカスタム状態を送信します。 このメソッドにより、再生ロジックと UI を分離できます。ロジックと UI を分離することで、ローカル再生とリモート コントロールの両方に同じ UI ロジックを使用できます。 このメソッドによって送信されたカスタム 状態は、PlayerData を通じて UI から利用できます。

関連ドキュメント

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 状態にする必要があり、デフォルトの idedReason が意図した動作を反映していない場合にのみ必要です。

setMediaElement

setMediaElement(mediaElement)

使用する HTMLMediaElement を設定します。HTMLMediaElement の Promise が設定されている場合、Promise が解決された後にメディアの再生が開始されます。

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

メディア情報を設定します。

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

特定の読み込みリクエストについて、cast.framework.PlaybackConfig を返す、または変更するハンドラを設定します。ハンドラ パラメータは、レシーバの LoadRequestData とデフォルトの PlaybackConfig（CastReceiverOptions で指定）です。ハンドラは、変更された再生設定、またはメディアの再生を防止するための null を返す必要があります。サーバーからのデータを待機できるように、戻り値を Promise にすることもできます。

setMediaUrlResolver

setMediaUrlResolver(resolver)

LOAD リクエストに対してメディア URL を返すハンドラを設定します。 このハンドラを使用すると、メディア ステータスの一部としてメディア コンテンツ URL が公開されないようにすることができます。デフォルトでは、メディア contentId がコンテンツ URL として使用されます。

setMessageInterceptor

setMessageInterceptor(type, interceptor)

受信メッセージと送信メッセージのインターセプタを設定します。 インターセプタはリクエスト データを更新できます。インターセプタは、更新されたデータ、更新されたデータを含む Promise（データをすぐに返せない場合）、または null（リクエストを処理する必要がない場合）のいずれかを返します。注: LOAD メッセージ インターセプタが指定されていて、個別の PRELOAD インターセプタが指定されていない場合は、PRELOAD メッセージに対して LOAD インターセプタが呼び出されます。

setPlaybackConfig

setPlaybackConfig(playbackConfig)

PlayerManager の再生構成を設定します。

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

レシーバーがサポートするメディア コマンドを設定します。

関連ドキュメント

cast.framework.messages.Command

停止

停止（）

再生中のメディアを停止します。