クラス: Media

コンストラクタ

メディア

new Media(sessionId, mediaSessionId)

パラメータ

sessionId

文字列

セッション ID。

mediaSessionId

数値

メディア識別子。

プロパティ

activeTrackId

null 値許容の配列の数値

アクティブなトラックに対応する ID のリスト。

BreakStatus

(null 以外の chrome.cast.media.BreakStatus または未定義)

レシーバーでブレークを再生しているときのブレークのステータス。このフィールドは、レシーバーが休止中を再生している場合は定義され、休養中でない場合は空白になりますが、コンテンツに存在する場合、コンテンツに休止が含まれていない場合は未定義になります。

currentItemId

null 値許容の数値

メディア ステータスの変更が発生したときにキュー内でアクティブだった(再生されていない可能性がある)アイテムのアイテム ID。

currentTime

数値

メディアの開始からの現在の再生位置(秒)。 このメンバーは散発的に更新されるだけなので、その値は最新ではありません。getEstimatedTime メソッドを使用して、レシーバーから報告された最後の情報に基づいて実際の再生位置を推定します。

非推奨
代わりに getEstimatedTime を使用してください。

カスタムデータ

null 値許容オブジェクト

受信側アプリケーションによって設定されたカスタム データセット。

アイドル理由

null 許容の chrome.cast.media.IdleReason

受信者が認識している場合は、アイドルの理由です。

items

null ではない chrome.cast.media.QueueItem の null 可能性配列

キュー内の並べ替えられたアイテムの配列。

liveSeekableRange

(null 以外の chrome.cast.media.LiveSeekableRange または未定義)

ライブ ストリームまたはイベント ストリームのシーク可能な範囲。相対メディア時間を秒単位で使用します。VOD ストリームでは未定義になります。

読み込みアイテム ID

null 値許容の数値

レシーバーに現在読み込まれているアイテムのアイテム ID です。現在読み込まれているアイテムがない場合は null です。

media

null 許容の chrome.cast.media.MediaInfo

メディアの説明。

mediaSessionId

数値

メディア アイテムを識別します。

playRate

数値

再生速度。1.0 は通常の再生を表します。

playerState

null ではない chrome.cast.media.PlayerState

プレーヤーの状態。

プリロードされたアイテム ID

null 値許容の数値

次のアイテムの ID。プリロードされている場合にのみ使用できます。レシーバのメディア アイテムは、一時的にプリロードしてメモリにキャッシュできるため、後で読み込む際にメディアからネットワークをフェッチする必要がないため、処理が速くなります。

queueData

(null 以外の chrome.cast.media.QueueData または未定義)

キューデータ。

リピートモード

null ではない chrome.cast.media.RepeatMode

キューを再生するための繰り返しモード。

sessionId

文字列

メディアをホストしているセッションを識別します。

サポートされている MediaCommands

null 以外の chrome.cast.media.MediaCommand の配列(null 以外)。

メディア プレーヤーによってサポートされるメディア コマンド。

動画情報

(null 以外の chrome.cast.media.VideoInformation または未定義)

動画情報。

Volume

null ではない chrome.cast.Volume

メディア ストリームの音量。volume.level と volume.muted は常に設定される。

Methods

addUpdateListener

addUpdateListener(listener)

メディアのステータスが変化したときに呼び出されるリスナーを追加します。次のプロパティを変更すると、リスナーがトリガーされます: currentTime、volume、metadata、playRate、playerState、customData。メディアの getStatus メソッドの呼び出しに成功すると、リスナーもトリガーされます。

パラメータ

リスナー

関数(ブール値)

追加するリスナー。このパラメータは、メディア オブジェクトがまだアクティブかどうかを示します。

編集トラック情報

EditTracksInfo(editTracksInfoRequest、successCallback、errorCallback)

テキスト トラックのスタイルを変更したり、トラックのステータスを変更したりします。 trackId が既存の trackId と一致しない場合、リクエスト全体が失敗し、ステータスは変更されません。

パラメータ

EditTracksInfoRequest

chrome.cast.media.EditTracksInfoRequest

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

getEstimatedBreakClipTime

getEstimatedBreakClipTime() は(数値または未定義)を返します

レシーバーから報告された最後の情報に基づいて、現在のブレーク クリップ位置を推定します。

戻り値

(number or undefined): メディアの開始時点からのブレーク クリップ位置の推定値(秒)。ブレークが再生されていない場合、breakStatus または currentBreakClipTime が定義されていない場合、未定義が返されます。

getEstimatedBreakTime

getEstimatedBreakTime() が返す値(数値または未定義)

レシーバから最後に報告された情報に基づいて、現在のブレーク位置を推定します。

戻り値

(number or undefined): メディアの開始からの現在のブレーク位置の推定値(秒)。breakStatus または currentBreakTime が定義されていない場合(ブレークが再生されていない場合)、未定義が返されます。

getEstimatedLiveSeekableRange

getEstimatedLiveSeekableRange() は、chrome.cast.media.LiveSeekableRange または未定義を返します。

レシーバによって報告された最後の情報に基づいて、liveSeekableRange の開始を秒単位で推定します。

戻り値

(non-null chrome.cast.media.LiveSeekableRange or undefined)現在の LiveSeekableRange の推定値。コンテンツがライブでないときに liveSeekableRange、liveSeekableRange.start、liveSeekableRange.end が定義されていない場合は、未定義が返されます。

getEstimatedTime

getEstimatedTime() は数値を返します

レシーバーから報告された最後の情報に基づいて、現在の再生位置を推定します。

戻り値

number: メディアの開始からの現在の再生位置の秒数。

getStatus

getStatus(getStatusRequest, successCallback, errorCallback)

受信側アプリからメディア アイテムのステータスを取得します。

指定された successCallback とともに、レシーバー アプリからステータスが受信されたときに、追加されたメディア更新リスナーも呼び出されます。このメソッドは、メディアのステータスをポーリングするためにメディアを呼び出すのではなく、メディアが変更されるたびにメディア更新リスナーの自動呼び出しに依存することを優先します。

パラメータ

getStatusRequest

chrome.cast.media.GetStatusRequest

オプションの get ステータス リクエスト。

successCallback

function()

受信側アプリからステータスが受信されたときに呼び出されます。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

一時停止

一時停止(pauseRequest、successCallback、errorCallback)

メディア アイテムを一時停止します。

パラメータ

一時停止リクエスト

chrome.cast.media.PauseRequest

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。 メディア一時停止リクエスト。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

再生

play(playRequest, successCallback, errorCallback)

メディア アイテムを再生します。

パラメータ

playRequest

chrome.cast.media.PlayRequest

オプションのメディア再生リクエスト。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueAppendItem

queueAppendItem(item, successCallback), errorCallback)

新しいメディア アイテムをキューの末尾に追加します。

パラメータ

item

chrome.cast.media.QueueItem

キューの末尾に追加する項目。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueInsertItems

queueInsertItems(queueInsertItemsRequest、successCallback、errorCallback)

新しいメディア アイテムのリストをキューに追加します。

パラメータ

queueInsertItemsRequest

chrome.cast.media.QueueInsertItemsRequest

メディア アイテムをメディア キューに挿入するためのリクエストです。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueJumpToItem

queueJumpToItem(itemId, successCallback, errorCallback)

キュー内の itemId でアイテムを再生。

itemId がキューに存在しなかった場合(元々存在しなかったか、この関数を呼び出す前に別の送信者により削除されたため)、この関数は、通知の受信者へのリクエストは送信せずに、通知なく戻ります。

パラメータ

itemId

数値

ジャンプするアイテムの ID。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueMoveItemToNewIndex

queueMoveItemToNewIndex(itemId, newIndex, successCallback, errorCallback)

itemId のアイテムをキュー内の newIndex に配置します。

itemId がキューに存在しなかった場合(元々存在しなかったか、この関数を呼び出す前に別の送信者により削除されたため)、この関数は、通知の受信者へのリクエストは送信せずに、通知なく戻ります。

newIndex が負の場合、errorCallback が呼び出されます。ただし、newIndex が誤って指定されたか、別の送信者によってキューが縮小されたためにオーバーフローした場合、項目はキューの最後に移動されます。

パラメータ

itemId

数値

移動するアイテムの ID。

新しいインデックス

数値

アイテムの新しいインデックス。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueNext

queueNext(successCallback, errorCallback)

キューの次のアイテムにジャンプします。

パラメータ

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queuePrev

queuePrev(successCallback、errorCallback)

キュー内の前のアイテムにジャンプします。

パラメータ

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueRemoveItem

queueRemoveItem(itemId、successCallback、errorCallback)

itemId のアイテムをキューから削除します。

itemId がキューに存在しなかった場合(元々存在しなかったか、この関数を呼び出す前に別の送信者により削除されたため)、この関数は、通知の受信者へのリクエストは送信せずに、通知なく戻ります。

パラメータ

itemId

数値

削除するアイテムの ID。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueReorderItems

queueReorderItems(queueReorderItemsRequest、successCallback、errorCallback)

キュー内のメディア アイテムのリストを並べ替える。

パラメータ

queueReorderItemsRequest

chrome.cast.media.QueueReorderItemsRequest

メディアキュー内のアイテムを並べ替えるリクエスト。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueSetRepeatMode

queueSetRepeatMode(repeatMode、successCallback、errorCallback)

キューの繰り返しモードを設定します。

パラメータ

リピートモード

chrome.cast.media.RepeatMode

現在のアイテムが終了したときに次のアイテムを選択するアルゴリズム。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

queueUpdateItems

queueUpdateItems(queueUpdateItemsRequest、successCallback、errorCallback)

メディアキューのプロパティ(繰り返しモードなど)と、メディアキュー内の既存のアイテムのプロパティを更新します。

パラメータ

queueUpdateItemsRequest

chrome.cast.media.QueueUpdateItemsRequest

メディアキューのプロパティを更新するリクエスト。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

removeUpdateListener

removeUpdateListener(listener)

この Media に以前に追加したリスナーを削除します。

パラメータ

リスナー

関数(ブール値)

削除するリスナー。

seek

Seek(seekRequest、successCallback, errorCallback)

メディア アイテムをシークします。

パラメータ

SeeRequest

chrome.cast.media.SeekRequest

メディア シーク リクエスト。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

setVolume

setVolume(volumeRequest、successCallback, errorCallback)

メディア ストリームの音量を設定します。volumeRequest.level または volumeRequest.muted の少なくとも 1 つを設定する必要があります。ミュート状態を変更しても音量レベルは変わりません。その逆も同様です。

パラメータ

volumeRequest

chrome.cast.media.VolumeRequest

設定されたボリューム リクエスト。

値を null にすることはできません。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

停止

stop(stopRequest, successCallback, errorCallback)

メディア プレーヤーを停止します。

パラメータ

stopRequest

chrome.cast.media.StopRequest

停止リクエスト。

successCallback

function()

成功で呼び出されました。

errorCallback

function(null 以外の chrome.cast.Error

エラー時に呼び出されます。考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

SupportCommand

supportCommand(command) はブール値を返します

メディア プレーヤーが指定されたメディア コマンドをサポートしているかどうかを指定します。

パラメータ

command

chrome.cast.media.MediaCommand

クエリを実行するコマンド。

値を null にすることはできません。

戻り値

boolean: プレーヤーがコマンドをサポートしている場合は true。