クラス: CastSession

cast.framework.CastSession

class static

キャスト セッションを管理する。

コンストラクタ

CastSession

new CastSession(sessionObj, state)

パラメータ

sessionObj

chrome.cast.Session

セッション データ。

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

state

cast.framework.SessionState

セッション状態。

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

Methods

addEventListener

addEventListener(type, handler)

イベント リスナーを追加します。

パラメータ

type

cast.framework.SessionEventType

イベントの種類です。

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

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

addMessageListener

addMessageListener(namespace, listener)

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

パラメータ

名前空間

string

リッスンする名前空間（例: 「urn:x-cast:com.example.namespace」）。

リスナー

Function(string, string)

追加するリスナー。

endSession

endSession(stopCasting)

現在のセッションを終了します。

パラメータ

stopCasting

boolean

現在のセッションの終了時に、受信側アプリが停止した場合。

getActiveInputState

getActiveInputState() は cast.framework.ActiveInputState を返します。

戻り値

non-null cast.framework.ActiveInputState レシーバーのアクティブな入力状態。

getApplicationMetadata

getApplicationMetadata() が cast.framework.ApplicationMetadata を返す。

戻り値

non-null cast.framework.ApplicationMetadata アプリケーション メタデータ。

getApplicationStatus

getApplicationStatus() が文字列を返す

戻り値

nullable string 申請状況の文字列。

getCastDevice

getCastDevice() が chrome.cast.Receiver を返す

戻り値

non-null chrome.cast.Receiver キャスト デバイスのメタデータ。

getMediaSession

getMediaSession() が chrome.cast.media.Media を返す

現在のメディア セッションを返します（利用可能な場合）。

戻り値

nullable chrome.cast.media.Media 現在のメディア セッション。

getSessionId

getSessionId() が文字列を返す

戻り値

string このセッションの一意の ID。

getSessionObj

getSessionObj() が chrome.cast.Session を返す

戻り値

non-null chrome.cast.Session セッション データ。

getSessionState

getSessionState() が cast.framework.SessionState を返す。

戻り値

cast.framework.SessionState 現在のセッションの状態。

getVolume

getVolume() が number を返す

戻り値

nullable number レシーバーの音量（利用可能な場合）

isMute

ismut() はブール値を返します。

戻り値

nullable boolean レシーバーのミュート ステータス（利用可能な場合）。

loadMedia

loadMedia(loadRequest) が、null 値許容の chrome.cast.ErrorCode を含む Promise を返す

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

パラメータ

loadRequest

chrome.cast.media.LoadRequest

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

non-null Promise containing nullable chrome.cast.ErrorCode 読み込みがレシーバに送信されたか失敗したことを示す保証（セッションは media_session イベントに渡されます）。

removeEventListener

removeEventListener(type, handler)

イベント リスナーを削除します。

パラメータ

type

cast.framework.SessionEventType

イベントの種類です。

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

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

removeMessageListener

removeMessageListener(namespace, listener)

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

パラメータ

名前空間

string

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

リスナー

Function(string, string)

削除するリスナー。

sendMessage

sendMessage(namespace, data) は、null 値許容の chrome.cast.ErrorCode を含む Promise を返します。

レシーバーにメッセージを送信します。

パラメータ

名前空間

string

メッセージを送信する名前空間（例: 'urn:x-cast:com.example.namespace）。

data

(non-null Object or string)

送信されるデータ。
戻り値

non-null Promise containing nullable chrome.cast.ErrorCode メッセージが送信されたときに Promise が解決されました。失敗した場合はエラーコードで拒否されます。

setMute

setmut(is ミュート) が、null 値許容の chrome.cast.ErrorCode を含む Promise を返す

レシーバーをミュートまたはミュートします。

パラメータ

isMute

boolean

新しいミュート ステータス。
戻り値

non-null Promise containing nullable chrome.cast.ErrorCode 解決済みの Promise レシーバが更新されました。失敗した場合はエラーコードが表示され、拒否されました。

setVolume

setVolume(volume) が、null 値許容の chrome.cast.ErrorCode を含む Promise を返す

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

パラメータ

音量

数値

新しい音量レベルを 0.0 ～ 1.0 にします。
戻り値

non-null Promise containing nullable chrome.cast.ErrorCode 解決済みの Promise レシーバが更新されました。失敗した場合はエラーコードが表示され、拒否されました。