chrome.
現在実行中の Cast アプリの状態を表します。 通常、これらのオブジェクトをクライアントが作成するべきではありません。
コンストラクタ
セッション
new Session(sessionId, appId, displayName, appImages, received)
パラメータ |
|
|---|---|
|
sessionId |
string セッション ID。 |
|
appId |
string 受信側のアプリの識別子。 |
|
displayName |
string アプリケーションの表示名。 |
|
appImages |
null ではない chrome.cast.Image の配列 アプリに関連付けられた画像 値を null にすることはできません。 |
|
レシーバー |
アプリを実行しているレシーバ。 値を null にすることはできません。 |
プロパティ
appId
string
キャストアプリの識別子。ディスプレイ用ではありません。
appImages
null 以外の chrome.cast.Image の配列。
アプリケーションを説明できる画像の配列。
displayName
string
人が読める形式のキャスト アプリケーション名（例: YouTube）。
media
null 以外の chrome.cast.media.Media の配列。
このキャスト セッションに属するメディア（他のセンダーによって読み込まれたメディアを含む）。
namespaces
null 以外の {name: string} の配列
レシーバー アプリケーションでサポートされている名前空間のリスト。
レシーバー
非 null chrome.cast.Receiver
アプリケーションを実行しているレシーバー。
senderApps
null 以外の、非 null の配列（chrome.cast.SenderApplication）
受信側アプリケーションがサポートする送信側アプリケーションこれにより、送信側のアプリをインストールまたはアクセスするようユーザーに促すことができます。
sessionId
string
受信側のアプリケーションのこのインスタンスを一意に識別します。
獲得する
null 以外の chrome.cast.SessionStatus
レシーバー アプリに対するこのキャスト セッションのステータス。
statusText
null 値許容の文字列
現在のアプリのコンテンツに関する説明テキスト（例: 「結婚式のスライドショー」）。
transportId
string
転送を目的として、このセッションを一意に記述する ID。通信チャネルの内部です。
Methods
addMediaListener
addMediaListener(listener)
メディア セッションが別のセンダーによって作成されたときに呼び出されるリスナーを追加します。
パラメータ |
|
|---|---|
|
リスナー |
function(non-null chrome.cast.media.Media) 追加するリスナー。 |
addMessageListener
addMessageListener(namespace, listener)
レシーバ アプリからメッセージを受信したときに呼び出されるリスナーを追加します。リスナーは、最初の引数として名前空間、2 番目の引数としてメッセージを指定して呼び出されます。
パラメータ |
|
|---|---|
|
名前空間 |
string リッスンする名前空間（例: 「urn:x-cast:com.example.namespace」）。 |
|
リスナー |
Function(string, string) 追加するリスナー。 |
addUpdateListener
addUpdateListener(listener)
セッションが変更されたときに呼び出されるリスナーを追加します。statusText、namespace、status、レシーバーの音量のプロパティを変更すると、リスナーがトリガーされます。
リスナーはセッションの status プロパティをチェックして、接続ステータスを確認する必要があります。ブール値パラメータ isAlive のサポートが終了し、status Session プロパティに置き換えられました。isAlive パラメータは、下位互換性のために引き続き渡され、status =
chrome.cast.SessionStatus.STOPPED を除き、true になります。
パラメータ |
|
|---|---|
|
リスナー |
function(boolean) 追加するリスナー。 |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
DIAL アプリの情報を取得します。
パラメータ |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
leave
Leave(successCallback, errorCallback)
セッションに関連付けられている実行中のレシーバ アプリケーションから離れます（切断します）。
このクライアントの AutoJoinPolicy で定義されているスコープ内にある既存のクライアントは接続解除されます。それ以降のクライアントは、退出したセッションに自動的に参加することはありません。
切断されたすべてのクライアントでは、isAlive = true でセッション更新リスナーが呼び出されます。isAlive はサポートが終了しているため、リスナーはセッションの status プロパティをチェックして接続ステータスを確認する必要があります。この例では status = chrome.cast.SessionStatus.DISCONNECTED です。
パラメータ |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
実行中のレシーバー アプリにメディアを読み込みます。
パラメータ |
|
|---|---|
|
loadRequest |
メディアの読み込みをリクエストします。 値を null にすることはできません。 |
|
successCallback |
function(non-null chrome.cast.media.Media) 成功時に、読み込まれた Media で呼び出されます。 |
|
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
queueLoad
queueLoad(queueLoadRequest, successCallback, errorCallback)
実行中のレシーバー アプリにメディア アイテムの新しいキューを読み込んで、必要に応じて再生を開始します。
パラメータ |
|
|---|---|
|
queueLoadRequest |
chrome.cast.media.QueueLoadRequest メディア アイテムの新しいキューを読み込むリクエスト。 値を null にすることはできません。 |
|
successCallback |
function(non-null chrome.cast.media.Media) 成功時に、読み込まれた Media で呼び出されます。 |
|
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
- 非推奨
- cast.framework.CastSession#loadMedia を使用して、関連する chrome.cast.media.LoadRequest#queueData を提供します。
removeMediaListener
removeMediaListener(listener)
以前に addMediaListener で追加されたリスナーを削除します。
パラメータ |
|
|---|---|
|
リスナー |
function(non-null chrome.cast.media.Media) 削除するリスナー。 |
removeMessageListener
removeMessageListener(namespace, listener)
以前に追加されたメッセージのリスナーを削除します。
パラメータ |
|
|---|---|
|
名前空間 |
string リッスンする名前空間。例: 「urn:x-cast:com.example.namespace」。 |
|
リスナー |
Function(string, string) 削除するリスナー。 |
removeUpdateListener
removeUpdateListener(listener)
この Session に以前追加されたリスナーを削除します。
パラメータ |
|
|---|---|
|
リスナー |
function(boolean) 削除するリスナー。 |
sendMessage
sendMessage(namespace, message, successCallback, errorCallback)
指定された名前空間で受信側アプリケーションにメッセージを送信します。SuccessCallback は、メッセージがメッセージ チャネルに送信されると呼び出されます。受信側のアプリケーションへの配信はベスト エフォート型であり、配信が保証されるわけではありません。
パラメータ |
|
|---|---|
|
名前空間 |
string メッセージを送信する名前空間（例: 'urn:x-cast:com.example.namespace）。 |
|
message |
(non-null Object or string) |
|
successCallback |
function() メッセージの送信時に呼び出されます。 |
|
errorCallback |
function(non-null chrome.cast.Error) エラー時に呼び出されます。発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
レシーバーの音量を設定します。
パラメータ |
|
|---|---|
|
ミュート中 |
boolean 新しいミュート ステータス。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、 SESSION_ERROR、EXTENSION_MISSING です。 |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
レシーバーの音量を設定します。
パラメータ |
|
|---|---|
|
newLevel |
数値 新しい音量レベルを 0.0 ～ 1.0 にします。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、 SESSION_ERROR、EXTENSION_MISSING です。 |
停止
stop(successCallback, errorCallback)
セッションに関連付けられている実行中のレシーバー アプリケーションを停止します。
パラメータ |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。 |