cast. framework. CastReceiverContext
基盤となるライブラリの読み込みを管理し、基盤となる Cast レシーバ SDK を初期化します。
- 例外
-
non-null ErrorMediaElement がドキュメント本文に作成されていない場合。複数のメディア要素が作成された場合、デベロッパーは、CAF レシーバーが使用する要素の 1 つに「castMediaElement」クラスを設定する必要があります。
メソッド
getInstance
getInstance() は cast.framework.CastReceiverContext を返します。
CastReceiverContext シングルトン インスタンスを返します。
- 戻り値
-
non-null cast.framework.CastReceiverContext
addCustomMessageListener
addCustomMessageListener(namespace, listener)
カスタム メッセージ チャンネルのメッセージ リスナーを設定します。1 つの Namespace に複数のリスナーを使用できます。
パラメータ |
|
|---|---|
|
名前空間 |
文字列 名前空間。有効な名前空間には、文字列「urn:x-cast:」を接頭辞として付ける必要があります。 |
|
listener |
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 タイプを指定できます。 |
|
コーデック |
省略可 文字列 quoted-string には、カンマ区切りのリストの形式が含まれます。各形式は、ストリームに存在するメディア サンプルタイプを指定します。 |
|
width |
省略可 数値 ストリームの水平解像度をピクセル単位で記述します。 |
|
height |
省略可 数値 ストリームの垂直解像度をピクセル単位で記述します。 |
|
framerate |
省略可 数値 ストリームのフレームレートを記述します。 |
- 戻り値
-
booleanストリームを Chromecast で再生できるかどうか。
getApplicationData
getApplicationData() は cast.framework.system.ApplicationData を返します。
システムが準備完了になるとアプリケーション情報を提供します。それ以外の場合は null になります。
- 戻り値
-
nullable cast.framework.system.ApplicationDataアプリケーション情報。システムが準備できていない場合は null。
getDeviceCapabilities
getDeviceCapabilities() は cast.framework.system.DeviceCapabilitiesObj を返します。
システムが準備完了になると、デバイスの機能情報を提供します。それ以外の場合は null になります。空のオブジェクトが返された場合、デバイスは機能情報を公開しません。
- 戻り値
-
nullable cast.framework.system.DeviceCapabilitiesObjデバイスの機能情報(Key-Value ペア)。システムの準備がまだできていない場合は null になります。プラットフォームがデバイスの機能情報を公開していない場合、空のオブジェクトになることがあります。
getDeviceInformation
getDeviceInformation() は cast.framework.system.DeviceInformationObj を返します。
システムの準備が整うと、機能に関連しないデバイス識別情報を提供します。それ以外の場合は「null」になります。空のオブジェクトが返された場合、デバイスはそのような情報を公開しません。
- 戻り値
-
nullable cast.framework.system.DeviceInformationObjデバイス情報(Key-Value ペア)。システムの準備がまだできていない場合は null になります。プラットフォームがこの情報を公開していない場合は、空のオブジェクトになることがあります。
getPlayerManager
getPlayerManager() は cast.framework.PlayerManager を返します。
メディア再生を制御およびモニタリングできる Player インスタンスを取得します。
- 戻り値
-
non-null cast.framework.PlayerManager
getSender
getSender(senderId) は cast.framework.system.Sender を返します。
送信者 ID で送信者を取得する
パラメータ |
|
|---|---|
|
senderId |
文字列 返される送信者の ID。 |
- 戻り値
-
nullable cast.framework.system.Sender
getSenders
getSenders() returns Array of non-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() はブール値を返します。
アプリケーションが start を呼び出すと、システムは ready イベントを送信して、アプリケーション情報が準備できたこと、および 1 つの送信者が接続されるとすぐにアプリケーションがメッセージを送信できることを示します。
- 戻り値
-
booleanシステムがメッセージを処理する準備ができているかどうか。
loadPlayerLibraries
loadPlayerLibraries(useLegacyDashSupport)
プレーヤー JS の読み込みを開始します。これは、start を呼び出す前に、レシーバーの起動の初期段階でプレーヤーの JS コードの読み込みを開始するために使用できます。プレーヤーがすでに読み込まれている場合(start が呼び出されている場合)、この関数は何もしません。
パラメータ |
|
|---|---|
|
useLegacyDashSupport |
省略可 ブール値 DASH コンテンツに MPL を使用する必要があることを示します。 |
removeCustomMessageListener
removeCustomMessageListener(namespace, listener)
以前に CastReceiverContext#addCustomMessageListener で登録されたメッセージ リスナーを削除します。
パラメータ |
|
|---|---|
|
名前空間 |
文字列 名前空間。有効な名前空間には、文字列「urn:x-cast:」を接頭辞として付ける必要があります。 |
|
listener |
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)
特定の送信者にメッセージを送信します。
パラメータ |
|
|---|---|
|
名前空間 |
文字列 名前空間。有効な名前空間には、文字列「urn:x-cast:」を接頭辞として付ける必要があります。 |
|
senderId |
(文字列または未定義) senderId。すべての送信者にブロードキャストする場合は未定義。 |
|
データ |
すべての種類 メッセージ ペイロード。 値を 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)
ログの詳細レベルを設定します。
パラメータ |
|
|---|---|
|
レベル |
ロギングレベル。 値を null にすることはできません。 |
start
start(options) returns cast.framework.CastReceiverContext
システム マネージャーとメディア マネージャーを初期化して、受信側アプリが送信側からリクエストを受信できるようにします。
パラメータ |
|
|---|---|
|
オプション |
(null 以外の cast.framework.CastReceiverOptions、またはオプションの null 以外のオブジェクト) |
- 戻り値
-
non-null cast.framework.CastReceiverContext
停止
stop(closeReason)
レシーバー アプリケーションをシャットダウンします。
パラメータ |
|
|---|---|
|
closeReason |
省略可 cast.framework.common.CloseReason レシーバー アプリケーションが停止している理由を示す、オプションの終了理由。指定しない場合、フレームワークは最近のメディア プレーヤー イベントに基づいて理由を推測するか、APP_REQUEST にフォールバックします。次のいずれかの数値を渡します。
値を null にすることはできません。 |