クラス: CastReceiverContext

cast.framework.CastReceiverContext

class static

基盤となるライブラリの読み込みを管理し、基盤となるキャスト レシーバ SDK を初期化します。

スロー値

non-null Error: MediaElement がドキュメント本文に作成されていない場合。複数のメディア要素を作成する場合、デベロッパーは「castMediaElement」クラスをいずれか 1 つに設定し、CAF レシーバーが使用するようにします。

Methods

getInstance

静的

getInstance() は cast.framework.CastReceiverContext を返します。

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

戻り値

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

カスタム メッセージ チャンネルにメッセージ リスナーを設定します。

パラメータ
名前空間	文字列 名前空間。有効な名前空間の先頭には文字列「urn:x-cast:」を付ける必要があります。
リスナー	function（非 null cast.framework.system.Event）

スロー値

Errorシステムの準備ができていない場合、または名前空間がこのアプリでサポートされていない場合。

addEventListener

addEventListener(type, ハンドラ)

キャスト システム イベントにリスナーを追加する。

パラメータ
type	cast.framework.system.EventType 値を null にすることはできません。
handler	function（非 null cast.framework.system.Event）

canDisplayType

canDisplayType（mimeType、コーデック、幅、高さ、フレームレート）はブール値を返します

動画または音声ストリームの特定のメディア パラメータがプラットフォームでサポートされているかどうかを確認します。

パラメータ
mimeType	文字列 メディアの MIME タイプ。「/」で区切られたタイプとサブタイプで構成されます。これは、動画またはオーディオの MIME タイプのいずれかです。
コーデック	任意 文字列 Quoted-string には、フォーマットのカンマ区切りリストが含まれます。フォーマットごとに、ストリーム内に存在するメディア サンプル タイプを指定します。
width	任意 数値 ストリームの水平解像度をピクセル単位で表します。
高さ	任意 数値 ストリームの垂直解像度をピクセル単位で表します。
フレームレート	任意 数値 ストリームのフレームレートを記述します。

戻り値

boolean ストリームを Chromecast で再生できる場合。

getApplicationData

getApplicationData() は cast.framework.system.ApplicationData を返します。

システムの準備ができたらアプリ情報を提供します。提供しないと null になります。

戻り値

nullable cast.framework.system.ApplicationData: アプリケーション情報。システムの準備ができていない場合は null。

getDeviceCapabilities

getDeviceCapabilities() は Objects を返します

システムの準備ができるとデバイス機能に関する情報を提供します。提供しないと null になります。空のオブジェクトが返された場合、デバイスは機能の情報を公開しません。

戻り値

nullable Object デバイスの機能情報（Key-Value ペア）。システムの準備ができていない場合は、null になります。プラットフォームがデバイスの機能情報を公開していない場合、空のオブジェクトになることがあります。

getPlayerManager

getPlayerManager() は cast.framework.PlayerManager を返します

メディア再生を制御、モニタリングできる Player インスタンスを取得します。

戻り値

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) は cast.framework.system.Sender を返します。

送信者 ID で送信者を取得する

パラメータ
送信者 ID	文字列 返される送信者の ID。

戻り値

nullable cast.framework.system.Sender 

getSenders

getSenders() は、null 以外の cast.framework.system.Sender の配列を返します。

現在接続している送信者のリストを取得します。

戻り値

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() は cast.framework.system.StandbyState を返します。

キャスト アプリの HDMI 入力がスタンバイ状態かどうかを報告します。

戻り値

non-null cast.framework.system.StandbyState アプリの HDMI 入力がスタンバイ状態のかどうかを示します。テレビが CEC コマンドをサポートしていないなど、判別できない場合、返される値は UNKNOWN になります。

getSystemState

getSystemState() は cast.framework.system.SystemState を返します。

システムの状態に関するアプリ情報を提供します。

戻り値

non-null cast.framework.system.SystemState システム状態。

getVisibilityState

getVisibilityState() は cast.framework.system.VisibilityState を返します。

キャスト アプリケーションが HDMI アクティブ入力かどうかを報告します。

戻り値

non-null cast.framework.system.VisibilityState アプリが HDMI アクティブ入力かどうかを示します。テレビが CEC コマンドをサポートしていないなど、判別できない場合、返される値は UNKNOWN になります。

isSystemReady

isSystemReady() がブール値を返す

アプリ呼び出しが開始されると、システムはアプリ情報の準備が整っていることを示す準備完了イベントを送信します。アプリケーションは、接続者が 1 人接続されるとすぐにメッセージを送信できます。

戻り値

boolean システムがメッセージを処理する準備ができているかどうかを指定します。

loadPlayerLibraries

loadPlayerLibraries（useLegacyDashSupport）

プレーヤー js の読み込みを開始します。これを使用して、レシーバーを呼び出す初期段階でプレーヤー js コードの読み込みを開始できます。プレーヤーがすでに読み込まれている場合は、この関数は何も起こりません（start が呼び出された場合）。

パラメータ
useLegacyDashSupport	任意 boolean DASH コンテンツで MPL を使用することを示します。

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

カスタム メッセージ チャンネルのメッセージ リスナーを削除する。

パラメータ
名前空間	文字列 名前空間。有効な名前空間の先頭には文字列「urn:x-cast:」を付ける必要があります。
リスナー	function（cast.framework.system.Event）

スロー値

Errorシステムの準備ができていない場合、または名前空間がこのアプリでサポートされていない場合。

removeEventListener

removeEventListener(type, ハンドラ)

システム イベントをキャストするリスナーを削除します。

パラメータ
type	cast.framework.system.EventType 値を null にすることはできません。
handler	function（非 null cast.framework.system.Event）

sendCustomMessage

sendCustomMessage(namespace, sendIdId, message)

特定の送信者にメッセージを送信する。

パラメータ
名前空間	文字列 名前空間。有効な名前空間の先頭には文字列「urn:x-cast:」を付ける必要があります。
送信者 ID	（文字列または未定義） SenderId、またはすべての送信者へのブロードキャストの場合は未定義。
メッセージ	すべての種類 メッセージ。 値を null にすることはできません。

スロー値

Error メッセージの準備中にエラーが発生した場合。

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

アプリがフィードバック レポートにログインするためのデバッグ状態情報を追加した場合は、feedbackstarted イベントに応答してこの関数を呼び出す必要があります。アプリケーションがログに記録するデバッグ情報を表す文字列であるパラメータ「message」を受け取ります。

パラメータ
feedbackMessage	文字列

非推奨

cast.framework.CastReceiverContext#setFeedbackHandler を使用する

setApplicationState

setApplicationState(statusText)

アプリの状態を設定します。アプリは、状態が変化したときに呼び出す必要があります。未定義であるか、空の文字列に設定されている場合、アプリケーション登録時に確立されたアプリケーション名の値が、デフォルトでアプリケーションの状態に使用されます。

パラメータ
statusText	文字列 ステータスのテキスト。

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

フィードバック レポートに追加データを提供するハンドラを設定します。 ハンドラは、報告されたフィードバックが作成されたときに呼び出され、追加のデータを文字列または文字列の Promise として返す必要があります。戻り値は、5 秒以内に解決されてレポートに記載されます。

パラメータ
feedbackHandler	function() 値は null でもかまいません。

setInactivityTimeout

setInactivityTimeout(maxInactivity)

レシーバーの非アクティブ タイムアウトを設定します。起動なしの呼び出し時は、変更しない最大値を設定することをおすすめします。この API は開発/デバッグのみを目的としています。

パラメータ
非アクティブ期間	数値 応答しない接続を閉じるまでの間隔（秒）。

setLoggerLevel

setLoggerLevel(level)

ログの詳細レベルを設定します。

パラメータ
level	cast.framework.LoggerLevel ロギングレベル。 値を null にすることはできません。

開始

start(options) は cast.framework.CastReceiverContext を返します

システム マネージャーとメディア マネージャーを初期化して、レシーバー アプリが送信者からリクエストを受信できるようにします。

パラメータ
オプション	（null 以外の cast.framework.CastReceiverOptions、またはオプションの null 以外のオブジェクト）

戻り値

non-null cast.framework.CastReceiverContext 

停止

stop()

レシーバー アプリをシャットダウンします。