addEventListener

addEventListener(eventType, eventListener)

再生イベントをリッスンするイベント リスナーを追加します。

例外

non-null Error: 指定された引数が無効な場合。

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

サポートされているメディア コマンドの既存のリストに、サポートされている新しいコマンドを追加します。

関連情報

cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

すべてのセンダーにメディア ステータス メッセージを送信します（ブロードキャスト）。アプリケーションはこれを使用してカスタム状態変更を送信します。

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) returns number

メディア時間をメディア絶対時間に変換します。絶対時間はライブ配信にのみ適用されます。

戻り値

nullable number 絶対時間。検出されない場合は null。

getAudioTracksManager

getAudioTracksManager() returns cast.framework.AudioTracksManager

AudioTracksManager インスタンスを取得します。

戻り値

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() returns number

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

戻り値

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

getBreakClipDurationSec

getBreakClipDurationSec() returns number

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

戻り値

nullable number 現在のブレーク クリップの長さ。Player が休憩クリップを再生していない場合は null。

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

現在のレシーバーでサポートされているメディア コマンドを取得します。getSupportedMediaCommands() とは異なり、このメソッドの戻り値は現在の再生ステータスに基づいて動的に変化します。たとえば、広告の再生中に SEEK コマンドがサポートされないことがあります。このメソッドは、レシーバー CastReceiverContext#start の呼び出し後にのみ呼び出す必要があります。それ以外の場合は 0 を返します。

関連情報

cast.framework.messages.Command

戻り値

number アプリでサポートされているメディア コマンドのビットマスク。

getCurrentTimeSec

getCurrentTimeSec() returns number

現在のメディアの再生経過時間を取得します。

戻り値

number 経過時間（秒単位）。メディアが再生されていない場合は 0 になります。

getDurationSec

getDurationSec() returns number

現在再生中のメディアの再生時間（秒）を取得します。

戻り値

number メディアの再生時間。再生中のメディアがない場合は NaN。

getLiveSeekableRange

getLiveSeekableRange() returns cast.framework.messages.LiveSeekableRange

ライブのシーク可能な範囲を、開始時間と終了時間（秒単位）で返します。値はメディア時間に基づいています。

戻り値

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

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

現在の再生レートを返します。レシーバ CastReceiverContext#start が呼び出される前に 1 を返します。

戻り値

number 現在の再生レート。

getPlayerState

getPlayerState() returns cast.framework.messages.PlayerState

Player 状態を取得します。

戻り値

non-null cast.framework.messages.PlayerState 現在の Player の状態。

getPreferredPlaybackRate

getPreferredPlaybackRate() returns number

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

戻り値

number 

getPreferredTextLanguage

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

広告ブレーク時間を差し引かずに、現在のメディアの経過再生時間を取得します。

戻り値

number 経過時間（秒単位）。メディアが再生されていない場合は 0 になります。

getRawSeekableRange

getRawSeekableRange() returns cast.framework.messages.Range

現在のメディアのシーク可能な範囲を返します。

注: これは getRawCurrentTimeSec() の単位と一致しますが、seek() とは一致しません。広告やその他のメディア オフセットは考慮されません。未加工の値が必要であることが確実な場合を除き、代わりに getLiveSeekableRange() を使用する必要があります。

戻り値

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() returns number

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

戻り値

nullable number 

getStats

getStats() returns cast.framework.stats.Stats

再生統計情報を返します。統計情報は、必要に応じて再生セッション全体で集計されます。

戻り値

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() returns number

レシーバーでサポートされているメディア コマンドを取得します。CastReceiverContext#start() の呼び出し後にのみ呼び出す必要があります。それ以外の場合は 0 を返します。サポートされているメディア コマンドの値は、レシーバー アプリケーションによってのみ制御されます。MediaStatus に基づいて自動的に更新されることはありません。

関連情報

cast.framework.messages.Command

戻り値

number アプリでサポートされているメディア コマンドのビットマスク。

getTextTracksManager

getTextTracksManager() は cast.framework.TextTracksManager を返します

TextTracksManager インスタンスを取得します。

戻り値

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() returns Array of non-null cast.framework.TimedMetadata

マニフェストの解析中に検出されたタイムド メタデータを返します。これは、HLS では #EXT-X-DATERANGE、DASH では EventStream です。

戻り値

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

load

load(loadRequest) returns Promise containing void

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

戻り値

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 ロジックを使用できます。このメソッドで送信されたカスタム状態は、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 状態にする必要があり、デフォルトの idleReason が意図した動作を反映していない場合にのみ必要です。

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

停止

stop()

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