cast. framework. CastReceiverContext
基盤となるライブラリの読み込みを管理し、基盤となるキャスト レシーバ SDK を初期化します。
- 例外
-
non-null Error
MediaElement がドキュメントの本文に作成されていない場合。複数のメディア要素を作成する場合、デベロッパーは「castMediaElement」クラスをそのいずれかに設定する必要があります。CAF レシーバーはこれを使用します。
Methods
getInstance
getInstance() returns cast.framework.CastReceiverContext
CastReceiverContext シングルトン インスタンスを返します。
- 戻り値
-
non-null cast.framework.CastReceiverContext
addCustomMessageListener
addCustomMessageListener(namespace, listener)
カスタム メッセージ チャネルのメッセージ リスナーを設定します。1 つの Namespace に複数のリスナーを使用できます。
パラメータ |
|
---|---|
namespace |
文字列 名前空間。有効な名前空間には接頭辞「urn:x-cast:」を付ける必要があります。 |
リスナー |
function(non-null cast.framework.system.Message) |
- 例外
-
Error
システムの準備ができていないか、名前空間がこのアプリケーションでサポートされていない場合。
addEventListener
addEventListener(type, handler)
システム イベントをキャストするためのリスナーを追加します。
パラメータ |
|
---|---|
type |
cast.framework.system.EventType 値を null にすることはできません。 |
handler |
function(non-null cast.framework.system.Event) |
canDisplayType
canDisplayType(mimeType, codecs, width, height, framerate) returns boolean
動画ストリームまたは音声ストリームの指定されたメディア パラメータがプラットフォームでサポートされているかどうかを確認します。
パラメータ |
|
---|---|
mimeType |
文字列 メディアの MIME タイプ。「/」で区切られたタイプとサブタイプで構成され、動画タイプまたはオーディオ MIME タイプのいずれかになります。 |
コーデック |
省略可 文字列 引用符付き文字列には、フォーマットのカンマ区切りリストが含まれます。各フォーマットは、ストリーム内に存在するメディア サンプルタイプを指定します。 |
width |
省略可 数値 ストリームの水平解像度をピクセル単位で表します。 |
height |
省略可 数値 ストリームの垂直解像度をピクセル単位で表します。 |
フレームレート |
省略可 数値 ストリームのフレームレートを表します。 |
- 戻り値
-
boolean
Chromecast でストリーミングを再生できるかどうか。
getApplicationData
getApplicationData() が cast.framework.system.ApplicationData を返す。
システムの準備ができたらアプリ情報を提供します。それ以外の場合は null になります。
- 戻り値
-
nullable cast.framework.system.ApplicationData
アプリ情報。システムの準備ができていない場合は null。
getDeviceCapabilities
getDeviceCapabilities() はオブジェクトを返す
システムの準備ができたら、デバイス機能情報を提供します。それ以外の場合は null になります。空のオブジェクトが返された場合、デバイスは機能情報を公開しません。
- 戻り値
-
nullable Object
: デバイスの機能情報(Key-Value ペア)。システムの準備ができていない場合は null になります。プラットフォームがデバイス機能情報を公開しない場合は、空のオブジェクトになります。
getPlayerManager
getPlayerManager() が cast.framework.PlayerManager を返す
メディア再生の制御とモニタリングができるプレーヤー インスタンスを取得します。
- 戻り値
-
non-null cast.framework.PlayerManager
getSender
getSender(senderId) は、cast.framework.system.Sender を返します。
送信者 ID で送信者を取得する
パラメータ |
|
---|---|
senderId |
文字列 返される送信者の 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() returns 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() はブール値を返す
アプリの呼び出しが開始されると、システムはアプリ情報の準備ができたことを示すために Ready イベントを送信します。アプリは 1 人の送信者が接続されるとすぐにメッセージを送信できます。
- 戻り値
-
boolean
システムがメッセージを処理する準備ができているかどうか。
loadPlayerLibraries
loadPlayerLibraries(useLegacyDashSupport)
プレーヤー js の読み込みを開始します。これを使用して、start を呼び出す前にレシーバーを起動する初期段階で Player JS コードの読み込みを開始できます。 プレーヤーがすでに読み込まれている場合(start が呼び出された場合)は、この関数は何もしません。
パラメータ |
|
---|---|
useLegacyDashSupport |
省略可 boolean MPL を DASH コンテンツに使用することを示します。 |
removeCustomMessageListener
removeCustomMessageListener(namespace, listener)
以前に CastReceiverContext#addCustomMessageListener
で登録されたメッセージ リスナーを削除します。
パラメータ |
|
---|---|
namespace |
文字列 名前空間。有効な名前空間には接頭辞「urn:x-cast:」を付ける必要があります。 |
リスナー |
function(non-null cast.framework.system.Message) 登録を解除するメッセージ リスナー関数。 |
- 例外
-
Error
システムの準備ができていないか、名前空間がこのアプリケーションでサポートされていない場合。
removeEventListener
removeEventListener(type, handler)
システム イベントをキャストするためのリスナーを削除しました。
パラメータ |
|
---|---|
type |
cast.framework.system.EventType 値を null にすることはできません。 |
handler |
function(non-null cast.framework.system.Event) |
sendCustomMessage
sendCustomMessage(namespace, senderId, data)
特定の送信者にメッセージを送信します。
パラメータ |
|
---|---|
namespace |
文字列 名前空間。有効な名前空間には接頭辞「urn:x-cast:」を付ける必要があります。 |
senderId |
(文字列または未定義) sendId、または未定義(すべての送信者へのブロードキャスト)。 |
data |
すべての種類 メッセージ ペイロード。 値を null にすることはできません。 |
- 例外
-
Error
メッセージの準備中にエラーが発生した場合。
sendFeedbackMessage
sendFeedbackMessage(feedbackMessage)
この関数は、アプリがフィードバック レポートにログインするためのデバッグ状態情報を追加した場合、feedbackstarted イベントに対応して呼び出す必要があります。このメソッドはパラメータ「message」を受け取ります。これは、アプリがログに記録したいデバッグ情報を表す文字列です。
パラメータ |
|
---|---|
feedbackMessage |
文字列 |
- 非推奨
- cast.framework.CastReceiverContext#setFeedbackHandler を使用する
setApplicationState
setApplicationState(statusText)
アプリケーションの状態を設定します。アプリは、状態が変化したときにこれを呼び出します。未定義または空の文字列に設定した場合、アプリの登録時に確立されたアプリケーション名の値が、デフォルトでアプリの状態として使用されます。
パラメータ |
|
---|---|
statusText |
文字列 ステータス テキスト。 |
setFeedbackHandler
setFeedbackHandler(feedbackHandler)
フィードバック レポートに追加データを提供するハンドラを設定します。ハンドラは、報告されたフィードバックが作成されたときに呼び出され、追加のデータを文字列または文字列 Promise として返します。戻り値の Promise は、レポートに含めるには 5 秒以内に解決される必要があります。
パラメータ |
|
---|---|
feedbackHandler |
function() 値を null にすることもできます。 |
setInactivityTimeout
setInactivityTimeout(maxInactivity)
レシーバーの非アクティブ タイムアウトを設定します。Start を呼び出し、変更しない場合は、非アクティブの最大値を設定することをおすすめします。この API は、開発/デバッグ目的でのみ提供されています。
パラメータ |
|
---|---|
maxInactivity |
数値 応答しない接続を閉じるまでの間隔(秒)。 |
setLoggerLevel
setLoggerLevel(level)
ログの詳細レベルを設定します。
パラメータ |
|
---|---|
level |
ロギングレベル。 値を null にすることはできません。 |
開始
start(options) が cast.framework.CastReceiverContext を返す場合。
システム マネージャーとメディア マネージャーを初期化して、レシーバー アプリがセンダーからのリクエストを受信できるようにします。
パラメータ |
|
---|---|
オプション |
(null 以外の cast.framework.CastReceiverOptions または null 以外の省略可能なオブジェクト) |
- 戻り値
-
non-null cast.framework.CastReceiverContext
停止
停止()
レシーバー アプリをシャットダウンします。