クラス: CastContext

cast.framework.CastContext

class static

キャストの操作を管理します。getInstance を使用してフェッチされるシングルトン オブジェクト。状態の管理 - キャスト アイコンとセッション オブジェクトの状態を提供します。 setOptions によってキャスト オプションが提供されるまで、キャスト操作はサポートされません。

コンストラクタ

CastContext

新しい CastContext()

Methods

getInstance

静的

getInstance() returns cast.framework.CastContext

CastContext シングルトン インスタンスを返します。

戻り値

cast.framework.CastContext CastContext のシングルトン インスタンス。

addEventListener

addEventListener(type, handler)

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

パラメータ

type

cast.framework.CastContextEventType

イベントの種類です。

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

handler

(non-null function(non-null cast.framework.CastStateEventData) or non-null function(non-null cast.framework.SessionStateEventData))

endCurrentSession

endCurrentSession(stopCasting)

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

パラメータ

stopCasting

boolean

受信アプリを停止させるか、切断するか。

getCastState

getCastState() が cast.framework.CastState を返す

戻り値

non-null cast.framework.CastState 現在のキャスト アイコンの状態。

getCurrentSession

getCurrentSession() が cast.framework.CastSession を返す。

戻り値

nullable cast.framework.CastSession 現在のセッション。

getSessionState

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

戻り値

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

removeEventListener

removeEventListener(type, handler)

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

パラメータ

type

cast.framework.CastContextEventType

イベントの種類です。

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

handler

(non-null function(non-null cast.framework.CastStateEventData) or non-null function(non-null cast.framework.SessionStateEventData))

requestSession

requestSession() は null 許容型の chrome.cast.ErrorCode を含む Promise を返します

キャスト選択 UI を開き、ユーザーがセッションを開始または停止できるようにします。

例外

Error コンテキスト オプションがまだ指定されていない場合。

戻り値

non-null Promise containing nullable chrome.cast.ErrorCode: セッションが開始中、または失敗（エラーコードにより拒否）を示す Promise。

setLaunchCredentialsData

setLaunchCredentialsData(credentialsData)

ユーザー認証情報データを設定します。setOptions の前に呼び出された場合は無視されます。setLaunchCredentialsData の後に setOptions を呼び出すと、setLaunchCredentialsData に設定された値がクリアされます。

パラメータ

credentialsData

chrome.cast.CredentialsData

送信者の認証情報を識別するために使用される認証情報データ。

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

setOptions

setOptions(options)

キャスト オプションを設定します。 イベントは、設定が提供されたときにのみ送信されます。

パラメータ

オプション

cast.framework.CastOptions

ページのキャスト オプション。

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

non-null Error オプションにアプリケーション ID がない場合。