クラス: Session

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

コンストラクタ

Session

new Session(sessionId、appId、displayName、appImages、receiver)

パラメータ

sessionId

文字列

セッション ID。

appId

文字列

受信者のアプリケーション識別子。

displayName

文字列

アプリの表示名

アプリ画像

null 以外の chrome.cast.Image の配列

アプリに関連付けられた画像。

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

レシーバー

chrome.cast.Receiver

アプリを実行しているレシーバ。

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

プロパティ

appId

文字列

キャスト アプリの ID。表示用ではありません。

アプリ画像

非 null の chrome.cast.Image の配列。

アプリケーションを説明する画像の配列。

displayName

文字列

人が読める形式の Cast アプリケーションの名前(「YouTube」など)。

media

非 null の chrome.cast.media.Media の配列。

このキャスト セッションに属するメディア(他の送信者によって読み込まれたメディアを含む)。

namespaces

{name: string} の null 以外の配列

レシーバ アプリケーションがサポートする名前空間のリスト。

レシーバー

null 以外の chrome.cast.Receiver

アプリケーションを実行しているレシーバ。

送信者アプリ

非 null の chrome.cast.SenderApplication の配列

受信側アプリケーションでサポートされている送信側アプリケーション。これは、送信者アプリをインストールまたはアクセスするようユーザーに求めるために使用されることがあります。

sessionId

文字列

レシーバ アプリケーションのこのインスタンスを一意に識別します。

status

null 以外の chrome.cast.SessionStatus

受信側アプリケーションへのこのキャスト セッションのステータス。

statusText

null 値許容文字列

現在のアプリのコンテンツを説明するテキスト(「マイ ウェディング スライドショー」など)。

トランスポート ID

文字列

交通目的でこのセッションを一意に識別する ID。これは通信チャネルの内部のものです。

Methods

addMediaListener

addMediaListener(listener)

別の送信者によってメディア セッションが作成されたときに呼び出されるリスナーを追加します。

パラメータ

リスナー

function(null 以外の chrome.cast.media.Media

追加するリスナー。

addMessageListener

addMessageListener(namespace, listener)

レシーバ アプリケーションからメッセージを受信したときに呼び出されるリスナーを追加します。リスナーは、最初の引数として名前空間を使用し、2 番目の引数としてメッセージとともに呼び出されます。

パラメータ

名前空間

文字列

リッスンする名前空間(例: urn:x-cast:com.example.namespace)。

リスナー

function(string, string)

追加するリスナー。

addUpdateListener

addUpdateListener(listener)

セッションが変更されたときに呼び出されるリスナーを追加します。ステータス、名前空間、ステータス、レシーバーのボリュームの各プロパティを変更すると、リスナーがトリガーされます。

リスナーは、セッションの status プロパティを確認して接続ステータスを確認する必要があります。ブール値パラメータ isAlive はサポートが終了し、status Session プロパティに置き換えられました。下位互換性を維持するため、isAlive パラメータは引き続き渡されます。status = chrome.cast.SessionStatus.STOPPED を除き、true になります。

パラメータ

リスナー

関数(ブール値)

追加するリスナー。

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

DIAL アプリ情報を取得します。

パラメータ

successCallback

関数(null 以外の chrome.cast.DialLaunchData)

errorCallback

function(null 以外の chrome.cast.Error

leave

leave(successCallback, errorCallback)

セッションに関連付けられた実行中のレシーバ アプリケーションから離れます(接続を解除します)。

このクライアントの AutoJoinPolicy で定義されたスコープ内の既存のクライアントは接続が解除されます。今後のクライアントは、退出したセッションに自動的に参加することはありません。

切断されたすべてのクライアントには、isAlive = true というセッション更新リスナーが作成されます。isAlive はサポートが終了しているため、リスナーはセッションの status プロパティを確認して接続ステータスを確認する必要があります。この場合は status = chrome.cast.SessionStatus.DISCONNECTED になります。

パラメータ

successCallback

function()

errorCallback

function(null 以外の chrome.cast.Error

考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

実行中のレシーバ アプリケーションにメディアを読み込みます。

パラメータ

loadRequest

chrome.cast.media.LoadRequest

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

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

successCallback

function(null 以外の chrome.cast.media.Media

成功時に読み込まれたメディアで呼び出されます。

errorCallback

function(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(null 以外の chrome.cast.media.Media

成功時に読み込まれたメディアで呼び出されます。

errorCallback

function(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(null 以外の chrome.cast.media.Media

削除するリスナー。

removeMessageListener

removeMessageListener(namespace, listener)

以前に追加されたメッセージのリスナーを削除します。

パラメータ

名前空間

文字列

リッスンする名前空間(例: urn:x-cast:com.example.namespace)。

リスナー

function(string, string)

削除するリスナー。

removeUpdateListener

removeUpdateListener(listener)

このセッションの以前に追加されたリスナーを削除します。

パラメータ

リスナー

関数(ブール値)

削除するリスナー。

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

指定された名前空間の受信側アプリにメッセージを送信します。successCallback は、メッセージがメッセージ チャネルに送信されると呼び出されます。受信側アプリへの配信はベスト エフォート型であり、保証されていません。

パラメータ

名前空間

文字列

メッセージの送信先の名前空間(例: urn:x-cast:com.example.namespace)。

メッセージ

(null 以外のオブジェクトまたは文字列)

successCallback

function()

メッセージの送信時に呼び出されます。

errorCallback

function(null 以外の chrome.cast.Error

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

setReceiver ています

setReceiver ミュート(ミュート、successCallback、errorCallback)

レシーバーの音量を設定します。

パラメータ

ミュート中

boolean

新しくミュートされたステータス。

successCallback

function()

errorCallback

function(null 以外の chrome.cast.Error

考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

レシーバーの音量を設定します。

パラメータ

新レベル

数値

新しい音量レベル。0.0 ~ 1.0。

successCallback

function()

errorCallback

function(null 以外の chrome.cast.Error

考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。

停止

stop(successCallback, errorCallback)

セッションに関連付けられている実行中のレシーバ アプリケーションを停止します。

パラメータ

successCallback

function()

errorCallback

function(null 以外の chrome.cast.Error

考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR、EXTENSION_MISSING です。