chrome. cast. media. メディア
受信側アプリに読み込まれたメディア アイテムを表します。
コンストラクタ
Media
new Media(sessionId, mediaSessionId)
パラメータ |
|
---|---|
sessionId |
string セッション ID。 |
mediaSessionId |
数値 メディア ID。 |
プロパティ
activeTrackIds
null 値許容の数値の配列
アクティブな Track に対応する ID のリスト。
breakStatus
(non-null chrome.cast.media.BreakStatus または未定義)
レシーバーで休憩が再生されたときの休憩のステータス。このフィールドは、レシーバがブレークの再生中に定義され、ブレークが再生されていないもののコンテンツ内に存在する場合は空になり、コンテンツにブレークがない場合は未定義になります。
currentItemId
null 値許容数値
メディア ステータスの変更が発生した時点でキュー内にあった(再生されていない可能性がある)アイテムのアイテム ID。
currentTime
数値
現在の再生位置(メディア開始からの経過秒数)。
このメンバーは散発的にしか更新されないため、その値は古くなっていることがよくあります。getEstimatedTime
メソッドを使用して、レシーバーから報告された最後の情報に基づいて実際の再生位置の推定を取得します。
- 非推奨
- 代わりに getEstimatedTime を使用してください。
customData
null 値許容オブジェクト
受信側アプリケーションによって設定されたカスタムデータセット。
idleReason
null 値許容の chrome.cast.media.IdleReason
アイドル状態の理由(受信側が把握している場合)。
items
null 値非許容の chrome.cast.media.QueueItem 配列。
キュー内で並べ替えられたアイテムの配列。
liveSeekableRange
(null ではない chrome.cast.media.LiveSeekableRange または未定義)
ライブ ストリームまたはイベント ストリームの移動可能な範囲。相対メディア時間(秒単位)が使用されます。VOD ストリームでは未定義になります。
loadingItemId
null 値許容数値
レシーバーで現在読み込み中のアイテムのアイテム ID。現在読み込み中のアイテムがない場合は null。
media
null 値許容の chrome.cast.media.MediaInfo
メディアの説明。
mediaSessionId
数値
メディア アイテムを識別します。
playbackRate
数値
再生速度。1.0 は通常の再生を表します。
playerState
non-null chrome.cast.media.PlayerState
プレーヤーの状態。
preloadedItemId
null 値許容数値
次のアイテムの ID。プリロードされている場合にのみ利用できます。レシーバーでは、メディア アイテムをプリロードし、一時的にメモリにキャッシュしておけば、後で読み込むときに処理が速くなります(メディアをネットワークからフェッチする必要がないため)。
queueData
(non-null chrome.cast.media.QueueData または未定義)
データをキューに入れる。
repeatMode
non-null chrome.cast.media.RepeatMode
キューを再生するための繰り返しモード。
sessionId
string
メディアをホストしているセッションを示します。
supportedMediaCommands
non-null Array of non-null chrome.cast.media.MediaCommand
メディア プレーヤーでサポートされているメディア コマンド。
videoInfo
(null ではない chrome.cast.media.VideoInformation または未定義)
動画の情報。
音量
非 null chrome.cast.Volume
メディア ストリームの音量。 volume.level と volume.muted が常に設定されます。
Methods
addUpdateListener
addUpdateListener(listener)
メディアのステータスが変わったときに呼び出されるリスナーを追加します。 プロパティ(currentTime、volume、metadata、PlaybackRate、playerState、customData)を変更すると、リスナーがトリガーされます。メディアの getStatus メソッドの呼び出しが成功すると、リスナーもトリガーされます。
パラメータ |
|
---|---|
リスナー |
function(boolean) 追加するリスナー。パラメータは、Media オブジェクトがまだ生きているかどうかを示します。 |
editTracksInfo
editTracksInfo(editTracksInfoRequest, successCallback, errorCallback)
テキスト トラックのスタイルまたはトラックのステータスを変更します。TrackId が既存の trackId と一致しない場合、リクエスト全体が失敗し、ステータスは変更されません。
パラメータ |
|
---|---|
editTracksInfoRequest |
chrome.cast.media.EditTracksInfoRequest 値を null にすることはできません。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
getEstimatedBreakClipTime
getEstimatedBreakClipTime() returns (number or undefined)
レシーバーから報告された最後の情報に基づいて、現在のブレーク クリップ位置を推定します。
- 戻り値
-
(number or undefined)
: 現在のブレーク クリップ位置の推定値(メディアの開始からの秒数)。ブレークが再生されていないときに breakStatus または currentBreakClipTime が定義されていない場合、未定義が返されます。
getEstimatedBreakTime
getEstimatedBreakTime() returns (number or undefined)
レシーバーから報告された最後の情報に基づいて、現在のブレーク位置を推定します。
- 戻り値
-
(number or undefined)
現在のブレーク位置の推定値(メディアの開始からの経過秒数)。ブレークが再生されていない場合、breakStatus または currentBreakTime が定義されていない場合、未定義が返されます。
getEstimatedLiveSeekableRange
getEstimatedLiveSeekableRange() returns (chrome.cast.media.LiveSeekableRange or undefined)
レシーバーから報告された最後の情報に基づいて、liveSeekableRange の開始時間を秒単位で推定します。
- 戻り値
-
(non-null chrome.cast.media.LiveSeekableRange or undefined)
現在の liveSeekableRange の推定値。コンテンツがライブでないときに liveSeekableRange、liveSeekableRange.start、liveSeekableRange.end が定義されていない場合は、未定義が返されます。
getEstimatedTime
getEstimatedTime() は number を返す
レシーバーから報告された最後の情報に基づいて、現在の再生位置を推定します。
- 戻り値
-
number
現在の再生位置の推定値(メディアの開始からの秒数)。
getStatus
getStatus(getStatusRequest, successCallback, errorCallback)
受信側アプリからメディア アイテムのステータスを取得します。
レシーバ アプリからステータスを受信すると、指定した successCallback に加えて、追加されたメディア更新リスナーも呼び出されます。アプリでは、このメソッドを呼び出してメディア ステータスをポーリングする代わりに、メディアが変更されるたびにメディア アップデート リスナーが自動的に呼び出されるようにする必要があります。
パラメータ |
|
---|---|
getStatusRequest |
chrome.cast.media.GetStatusRequest ステータス取得リクエスト(省略可)。 |
successCallback |
function() 受信側アプリからステータスを受信すると呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
pause
pause(pauseRequest, successCallback, errorCallback)
メディア アイテムを一時停止します。
パラメータ |
|
---|---|
pauseRequest |
|
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。 メディアの一時停止リクエスト。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
再生
play(playRequest, successCallback, errorCallback)
メディア アイテムを再生します。
パラメータ |
|
---|---|
playRequest |
メディア再生リクエスト(省略可)。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueAppendItem
queueAppendItem(item, successCallback, errorCallback)
新しいメディア アイテムをキューの末尾に追加します。
パラメータ |
|
---|---|
item |
キューの末尾に追加するアイテム。 値を null にすることはできません。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-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(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueJumpToItem
queueJumpToItem(itemId, successCallback, errorCallback)
キュー内の itemId を持つアイテムを再生します。
itemId が最初に存在していなかったか、この関数を呼び出す前に別の送信者によって削除されたため、キューで itemId が見つからなかった場合、この関数は通知なしでレシーバにリクエストを送信しません。
パラメータ |
|
---|---|
itemId |
数値 ジャンプするアイテムの ID。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-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 が最初に存在していなかったか、この関数を呼び出す前に別の送信者によって削除されたため、キューで itemId が見つからなかった場合、この関数は通知なしでレシーバにリクエストを送信しません。
newIndex が負の値の場合、errorCallback が呼び出されます。ただし、誤って指定したか、別の送信者によってキューが縮小されたために、newIndex がオーバーフローした場合、アイテムはキューの最後に移動します。
パラメータ |
|
---|---|
itemId |
数値 移動するアイテムの ID。 |
newIndex |
数値 アイテムの新しいインデックス。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueNext
queueNext(successCallback, errorCallback)
キュー内の次の項目にジャンプします。
パラメータ |
|
---|---|
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queuePrev
queuePrev(successCallback, errorCallback)
キュー内の前のアイテムにジャンプします。
パラメータ |
|
---|---|
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueRemoveItem
queueRemoveItem(itemId, successCallback, errorCallback)
itemId を持つアイテムをキューから削除します。
itemId が最初に存在していなかったか、この関数を呼び出す前に別の送信者によって削除されたため、キューで itemId が見つからなかった場合、この関数は通知なしでレシーバにリクエストを送信しません。
パラメータ |
|
---|---|
itemId |
数値 削除する商品アイテムの ID。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-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(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueSetRepeatMode
queueSetRepeatMode(repeatMode, successCallback, errorCallback)
キューの繰り返しモードを設定します。
パラメータ |
|
---|---|
repeatMode |
現在のアイテムが終了したときに次のアイテムを選択するアルゴリズム。 値を null にすることはできません。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-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(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
removeUpdateListener
removeUpdateListener(listener)
この Media に以前に追加されたリスナーを削除します。
パラメータ |
|
---|---|
リスナー |
function(boolean) 削除するリスナー。 |
尽力する
sense(seekRequest, successCallback, errorCallback)
メディア アイテムを検索します。
パラメータ |
|
---|---|
seekRequest |
メディアシーク リクエスト。 値を null にすることはできません。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-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(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
停止
stop(stopRequest, successCallback, errorCallback)
メディア プレーヤーを停止します。
パラメータ |
|
---|---|
stopRequest |
停止リクエスト。 |
successCallback |
function() 成功時に呼び出されます。 |
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
supportsCommand
supportsCommand(command) はブール値を返します
メディア プレーヤーが特定のメディア コマンドをサポートしているかどうかを指定します。
パラメータ |
|
---|---|
コマンド |
chrome.cast.media.MediaCommand クエリ対象のコマンド。 値を null にすることはできません。 |
- 戻り値
-
boolean
プレーヤーがコマンドをサポートしている場合は true。