クラス: CastReceiverContext

メソッド

getInstance

static

getInstance() returns cast.framework.CastReceiverContext

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

戻り値

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

カスタム メッセージ チャネルのメッセージ リスナーを設定します。Namespace に複数のリスナーを設定できます。

パラメータ

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 タイプを指定できます。

コーデック

省略可

文字列

引用符付き文字列には、カンマ区切りの形式のリストが含まれます。各形式は、ストリームに存在するメディア サンプル タイプを指定します。

省略可

数値

ストリームの水平解像度をピクセル単位で記述します。

height

省略可

数値

ストリームの垂直解像度をピクセル単位で表します。

framerate

省略可

数値

ストリームのフレームレートを記述します。

戻り値

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

getApplicationData

getApplicationData() returns cast.framework.system.ApplicationData

システムが準備できたらアプリケーション情報を提供します。準備ができていない場合は null になります。

戻り値

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

getDeviceCapabilities

getDeviceCapabilities() returns cast.receiver.CastReceiverManager.DeviceCapabilitiesObj

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

戻り値

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

getDeviceInformation

getDeviceInformation() returns cast.receiver.CastReceiverManager.DeviceInformationObj

システムが準備完了した時点で、ケーパビリティに関連しないデバイス識別情報を提供します。それ以外の場合は「null」になります。空のオブジェクトが返された場合、デバイスはそのような情報を公開していません。

戻り値

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

getPlayerManager

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

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

戻り値

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) returns 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() returns 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() returns cast.framework.system.VisibilityState

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

戻り値

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

isSystemReady

isSystemReady() returns boolean

アプリケーションが start を呼び出すと、システムは ready イベントを送信して、アプリケーション情報が準備完了したこと、および送信者が接続されるとすぐにアプリケーションがメッセージを送信できることを示します。

戻り値

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

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

パラメータ

useLegacyDashSupport

省略可

ブール値

DASH コンテンツに MPL を使用する必要があることを示します。

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

以前に CastReceiverContext#addCustomMessageListener で登録されたメッセージ リスナーを削除します。

パラメータ

namespace

文字列

名前空間。有効な名前空間には、文字列「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)

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

パラメータ

namespace

文字列

名前空間。有効な名前空間には、文字列「urn:x-cast:」を接頭辞として付加する必要があります。

senderId

(文字列または未定義)

senderId。すべての送信者にブロードキャストする場合は undefined。

データ

すべての種類

メッセージ ペイロード。

値を 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

cast.framework.LoggerLevel

ロギングレベル。

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

start

start(options) returns cast.framework.CastReceiverContext

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

パラメータ

オプション

(null 以外の cast.framework.CastReceiverOptions または null 以外の省略可能なオブジェクト)

戻り値

non-null cast.framework.CastReceiverContext 

停止

stop()

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