Namespace: system

cast.framework.system

namespace   static

これは cast.framework.system Namespace です。

クラス

ApplicationData

起動されたアプリケーションのデータを記述するメタデータ。

イベント

システム情報を含む cast.framework.CastReceiverContext によってディスパッチされるイベント。

FeedbackStartedEvent

システムがフィードバック レポートの作成を開始したときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

MaxVideoResolutionChangedEvent

システムが動画の最大解像度の制限を更新する必要があるときに、cast.framework.CastReceiverContext によってディスパッチされるイベント。

メッセージ

送信者から受信したカスタム メッセージ。カスタム イベントをリッスンするには、cast.framework.CastReceiverContext#addCustomMessageListener メソッドを使用します。

ReadyEvent

システムの準備が整ったときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

送信者

これは、接続されている送信側デバイスのデータを表します。

SenderConnectedEvent

送信者が接続されたときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

SenderDisconnectedEvent

送信者が切断されたときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

ShutdownEvent

アプリケーションがシャットダウンされたときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

StandbyChangedEvent

テレビがスタンバイ状態に入るかスタンバイ状態から復帰したときに cast.framework.CastReceiverContext によってディスパッチされるイベント。アプリケーションは常に isStandby プロパティを確認する必要があります。実際のステータスが不明かどうかを確認するには、アプリで cast.framework.CastReceiverContext#getStandbyState メソッドを呼び出します。

SystemVolumeChangedEvent

システムの音量が変更されたときに cast.framework.CastReceiverContext によってディスパッチされるイベント。

SystemVolumeData

これはシステム ボリューム データを表します。

VisibilityChangedEvent

アプリの公開設定が変更されたとき（HDMI 入力が変更されたときや、テレビの電源がオフになったときなど）に cast.framework.CastReceiverContext によってディスパッチされるイベント。

列挙型

DeviceCapabilities

static

文字列

現在のセットアップの機能を記述します。現在のセットアップは、Cast 対応デバイスと、該当する場合は接続先のディスプレイ デバイスで構成されます。

値
AUDIO_ASSISTANT	文字列 音声アシスタントのサポート。音声アシスタントをサポートする Cast 対応デバイスの例としては、Google Home や Google Home Mini などがあります。
BLUETOOTH_SUPPORTED	文字列 Bluetooth のサポート。
DISPLAY_SUPPORTED	文字列 ディスプレイ出力のサポート。ディスプレイをサポートする Cast 対応デバイスの例としては、Chromecast や Cast 対応テレビがあります。ディスプレイをサポートしていない Cast 対応デバイスの例としては、Chromecast Audio や Google Home があります。
HI_RES_AUDIO_SUPPORTED	文字列 ハイレゾ オーディオ（最大 24 ビット / 96 KHz）に対応。
IS_DV_SUPPORTED	文字列 ドルビー ビジョンのサポート。
IS_HDR_SUPPORTED	文字列 HDR 動画のサポート。
CAST_LITE_ONLY	文字列 このデバイスが音声のみのプラットフォームで動作しているかどうか。一部の API は、このようなプラットフォームでは完全にはサポートされていない可能性があります。
DPAD_INPUT_SUPPORTED	文字列 このデバイスが、ロック解除 DPAD などの入力メカニズムをサポートしているかどうか。
TOUCH_INPUT_SUPPORTED	文字列 タップ入力のサポート。タップ入力に対応している Cast 対応デバイスの例としては、Google Nest Hub や Google Nest Hub Max などがあります。
IS_GROUP	文字列 デバイスが仮想デバイスであり、実機ではなくグループ ターゲットを表す場合。
IS_DEVICE_REGISTERED	文字列 true に設定すると、このフラグは、キャスト デバイスが Cast Developer Console に登録されていることを示します。
IS_CBCS_SUPPORTED	文字列 true に設定すると、このフラグは CBCS スキーム（SAMPLE-AES）がサポートされていることを示します。
IS_DOLBY_ATMOS_SUPPORTED	文字列 true に設定すると、このフラグは、オーディオ パススルーで Dolby Atmos がサポートされていることを示します。

DeviceInformation

static

文字列

cast.framework.CastReceiverContext.DeviceInformationObj の有効なキーの定数。

値
MODEL_NAME	文字列 デバイスモデルの名前（Google TV Streamer、Google Nest Hub、Google Nest Mini など）（わかっている場合）。不明な場合は「unknown」。
BRAND_NAME	文字列 デバイスのブランド名（Google、LG、Sony など）（判明している場合）。 不明な場合は空白の文字列。
OS_NAME	文字列 デバイスの OS の名前（Android、Fuchsia、Linux など）（判明している場合）。 不明な場合は空の文字列、Cast デバイスでない場合は「not Cast」。
OS_VERSION	文字列 デバイスの OS のバージョン（例: 14.0 など）（わかっている場合）。 不明な場合は空白の文字列。
環境	文字列 デバイスが置かれている環境の種類（自宅、自動車、飛行機、ホテルなど）（判明している場合）。通常、ほとんどのデバイスで「home」です。
DEVICE_ID	文字列 受信側デバイスの一意の ID（判明している場合）。Sender SDK によって公開される Cast レシーバー ID と同じ値になります。不明な場合は空の文字列。
METADATA_FROM_FIRMWARE	文字列 デバイス情報がファームウェアから提供されたかどうか。

DisconnectReason

static

文字列

切断の理由を表します。

値
REQUESTED_BY_SENDER	文字列 送信側アプリによって接続の終了が積極的にリクエストされました（通常はユーザーによってトリガーされます）。
エラー	文字列 プロトコル エラーが発生しました。
UNKNOWN	文字列 送信者が close() を呼び出して正常に切断するようリクエストしたかどうかは不明です（おそらくリクエストしていませんが、「close」メッセージが失われた可能性があります）。これは通常、ネットワーク タイムアウトが発生した場合、送信側アプリがクラッシュした場合、送信側 OS がソケットを閉じた場合に発生します。
APPLICATION_STOP	文字列 受信側アプリが停止した。
ABRUPT_SHUTDOWN	文字列 送信者が接続されている間に、プラットフォームがアプリケーションを終了しました。
NO_SENDERS	文字列 送信者が接続されていないときにアプリケーションが終了した。
TRANSPORT_CLOSED	文字列 基盤となる SSL ソケットが、仮想接続の正常な終了なしに送信者によって閉じられました。
TRANSPORT_ABORTED	文字列 基盤となる SSL ソケットがピアによって中止されました。
TRANSPORT_TOO_LONG_INACTIVE	文字列 ハートビートの失敗により、基盤となる SSL ソケットが閉じられました。
CLOSED_BY_SELF	文字列 接続は Cast レシーバーによって正常に閉じられました。

EventType

static

文字列

cast.framework.CastReceiverContext によってディスパッチされるシステム イベント。

値
準備完了	文字列 システムが準備完了したときに呼び出されます。
シャットダウン	文字列 アプリケーションが終了したときに呼び出されます。
SENDER_CONNECTED	文字列 新しい送信者が接続したときに呼び出されます。
SENDER_DISCONNECTED	文字列 送信者が切断されたときに呼び出されます。
エラー	文字列 システムエラーが発生したときに呼び出されます。
SYSTEM_VOLUME_CHANGED	文字列 システム音量が変更されたときに呼び出されます。
VISIBILITY_CHANGED	文字列 アプリの表示が変更されたときに呼び出されます（HDMI 入力の変更後、テレビの電源がオフまたはオンになったとき、キャスト デバイスが外部電源に接続されているときなど）。この API は、ブラウザによって発生する「webkitvisibilitychange」イベントと同じ効果があります。これは、便宜上、また webkit 接頭辞付きのイベントへの依存を避けるために、cast.framework.CastReceiverContext API として提供されます。
STANDBY_CHANGED	文字列 テレビのスタンバイ状態が変更されたときに呼び出されます。このイベントは cast.framework.system.EventType.VISIBILITY_CHANGED イベントに関連しています。テレビがスタンバイ モードの場合、視認性は false になります。 可視性状態はスタンバイ状態よりも詳細ですが（可視性にはテレビ チャンネルの選択も含まれるため）、すべてのテレビで確実に検出されるわけではありません。ほとんどのテレビに実装されているため、このような場合はスタンバイを使用できます。
MAX_VIDEO_RESOLUTION_CHANGED	文字列
FEEDBACK_STARTED	文字列 システムがフィードバック レポートの作成を開始したときに呼び出されます。

LaunchedFrom

static

文字列

これは、レシーバーを起動したリクエストのタイプを表します。

値
UNKNOWN	文字列 リリース オーナーを特定できませんでした。
DIAL	文字列 アプリが DIAL リクエストによって起動された。
CAST	文字列 アプリが Cast V2 リクエストによって起動された。
Cloud	文字列 アプリがアシスタントのリクエスト（Google アシスタントのコマンドなど）によって起動された。

MessageType

static

文字列

カスタム メッセージの種類。

値
STRING	文字列 メッセージは自由形式の文字列です。送信される情報のエンコード / デコードは、アプリケーションが行います。
JSON	文字列 メッセージは JSON でエンコードされます。基盤となるトランスポートは、JSON エンコードされた文字列を使用します。

StandbyState

static

文字列

これは、プラットフォームから報告された現在のスタンバイ状態を表します。Cast プラットフォームが状態を判断できない場合は、UNKNOWN になることがあります。

値
スタンバイ	文字列
NOT_STANDBY	文字列
UNKNOWN	文字列

SystemState

static

文字列

これは、現在のシステム状態を表します。

値
NOT_STARTED	文字列 アプリケーションの起動がまだリクエストされていません。
STARTING_IN_BACKGROUND	文字列 アプリケーションは起動しているが、ユーザーには表示されていない。
開始中	文字列 アプリケーションを起動しています。
準備完了	文字列 アプリがフォアグラウンドにあり、メッセージを送受信する準備が整っている。
STOPPING_IN_BACKGROUND	文字列 バックグラウンドでアプリが停止しています。
停止中	文字列 アプリケーションを停止しています。

VisibilityState

static

文字列

これは、プラットフォームから報告された現在の公開設定の状態を表します。Cast プラットフォームが公開設定を判断できない場合は、UNKNOWN になることがあります。

値
VISIBLE	文字列
NOT_VISIBLE	文字列
UNKNOWN	文字列

プロパティ

DeviceCapabilities

static

文字列

現在のセットアップの機能を記述します。現在のセットアップは、Cast 対応デバイスと、該当する場合は接続先のディスプレイ デバイスで構成されます。

値
AUDIO_ASSISTANT	文字列 音声アシスタントのサポート。音声アシスタントをサポートする Cast 対応デバイスの例としては、Google Home や Google Home Mini などがあります。
BLUETOOTH_SUPPORTED	文字列 Bluetooth のサポート。
DISPLAY_SUPPORTED	文字列 ディスプレイ出力のサポート。ディスプレイをサポートする Cast 対応デバイスの例としては、Chromecast や Cast 対応テレビがあります。ディスプレイをサポートしていない Cast 対応デバイスの例としては、Chromecast Audio や Google Home があります。
HI_RES_AUDIO_SUPPORTED	文字列 ハイレゾ オーディオ（最大 24 ビット / 96 KHz）に対応。
IS_DV_SUPPORTED	文字列 ドルビー ビジョンのサポート。
IS_HDR_SUPPORTED	文字列 HDR 動画のサポート。
CAST_LITE_ONLY	文字列 このデバイスが音声のみのプラットフォームで動作しているかどうか。一部の API は、このようなプラットフォームでは完全にはサポートされていない可能性があります。
DPAD_INPUT_SUPPORTED	文字列 このデバイスが、ロック解除 DPAD などの入力メカニズムをサポートしているかどうか。
TOUCH_INPUT_SUPPORTED	文字列 タップ入力のサポート。タップ入力に対応している Cast 対応デバイスの例としては、Google Nest Hub や Google Nest Hub Max などがあります。
IS_GROUP	文字列 デバイスが仮想デバイスであり、実機ではなくグループ ターゲットを表す場合。
IS_DEVICE_REGISTERED	文字列 true に設定すると、このフラグは、キャスト デバイスが Cast Developer Console に登録されていることを示します。
IS_CBCS_SUPPORTED	文字列 true に設定すると、このフラグは CBCS スキーム（SAMPLE-AES）がサポートされていることを示します。
IS_DOLBY_ATMOS_SUPPORTED	文字列 true に設定すると、このフラグは、オーディオ パススルーで Dolby Atmos がサポートされていることを示します。

DeviceInformation

static

文字列

cast.framework.CastReceiverContext.DeviceInformationObj の有効なキーの定数。

値
MODEL_NAME	文字列 デバイスモデルの名前（Google TV Streamer、Google Nest Hub、Google Nest Mini など）（わかっている場合）。不明な場合は「unknown」。
BRAND_NAME	文字列 デバイスのブランド名（Google、LG、Sony など）（判明している場合）。 不明な場合は空白の文字列。
OS_NAME	文字列 デバイスの OS の名前（Android、Fuchsia、Linux など）（判明している場合）。 不明な場合は空の文字列、Cast デバイスでない場合は「not Cast」。
OS_VERSION	文字列 デバイスの OS のバージョン（例: 14.0 など）（わかっている場合）。 不明な場合は空白の文字列。
環境	文字列 デバイスが置かれている環境の種類（自宅、自動車、飛行機、ホテルなど）（判明している場合）。通常、ほとんどのデバイスで「home」です。
DEVICE_ID	文字列 受信側デバイスの一意の ID（判明している場合）。Sender SDK によって公開される Cast レシーバー ID と同じ値になります。不明な場合は空の文字列。
METADATA_FROM_FIRMWARE	文字列 デバイス情報がファームウェアから提供されたかどうか。

DisconnectReason

static

文字列

切断の理由を表します。

値
REQUESTED_BY_SENDER	文字列 送信側アプリによって接続の終了が積極的にリクエストされました（通常はユーザーによってトリガーされます）。
エラー	文字列 プロトコル エラーが発生しました。
UNKNOWN	文字列 送信者が close() を呼び出して正常に切断するようリクエストしたかどうかは不明です（おそらくリクエストしていませんが、「close」メッセージが失われた可能性があります）。これは通常、ネットワーク タイムアウトが発生した場合、送信側アプリがクラッシュした場合、送信側 OS がソケットを閉じた場合に発生します。
APPLICATION_STOP	文字列 受信側アプリが停止した。
ABRUPT_SHUTDOWN	文字列 送信者が接続されている間に、プラットフォームがアプリケーションを終了しました。
NO_SENDERS	文字列 送信者が接続されていないときにアプリケーションが終了した。
TRANSPORT_CLOSED	文字列 基盤となる SSL ソケットが、仮想接続の正常な終了なしに送信者によって閉じられました。
TRANSPORT_ABORTED	文字列 基盤となる SSL ソケットがピアによって中止されました。
TRANSPORT_TOO_LONG_INACTIVE	文字列 ハートビートの失敗により、基盤となる SSL ソケットが閉じられました。
CLOSED_BY_SELF	文字列 接続は Cast レシーバーによって正常に閉じられました。

EventType

static

文字列

cast.framework.CastReceiverContext によってディスパッチされるシステム イベント。

値
準備完了	文字列 システムが準備完了したときに呼び出されます。
シャットダウン	文字列 アプリケーションが終了したときに呼び出されます。
SENDER_CONNECTED	文字列 新しい送信者が接続したときに呼び出されます。
SENDER_DISCONNECTED	文字列 送信者が切断されたときに呼び出されます。
エラー	文字列 システムエラーが発生したときに呼び出されます。
SYSTEM_VOLUME_CHANGED	文字列 システム音量が変更されたときに呼び出されます。
VISIBILITY_CHANGED	文字列 アプリの表示が変更されたときに呼び出されます（HDMI 入力の変更後、テレビの電源がオフまたはオンになったとき、キャスト デバイスが外部電源に接続されているときなど）。この API は、ブラウザによって発生する「webkitvisibilitychange」イベントと同じ効果があります。これは、便宜上、また webkit 接頭辞付きのイベントへの依存を避けるために、cast.framework.CastReceiverContext API として提供されます。
STANDBY_CHANGED	文字列 テレビのスタンバイ状態が変更されたときに呼び出されます。このイベントは cast.framework.system.EventType.VISIBILITY_CHANGED イベントに関連しています。テレビがスタンバイ モードの場合、視認性は false になります。 可視性状態はスタンバイ状態よりも詳細ですが（可視性にはテレビ チャンネルの選択も含まれるため）、すべてのテレビで確実に検出されるわけではありません。ほとんどのテレビに実装されているため、このような場合はスタンバイを使用できます。
MAX_VIDEO_RESOLUTION_CHANGED	文字列
FEEDBACK_STARTED	文字列 システムがフィードバック レポートの作成を開始したときに呼び出されます。

LaunchedFrom

static

文字列

これは、レシーバーを起動したリクエストのタイプを表します。

値
UNKNOWN	文字列 リリース オーナーを特定できませんでした。
DIAL	文字列 アプリが DIAL リクエストによって起動された。
CAST	文字列 アプリが Cast V2 リクエストによって起動された。
Cloud	文字列 アプリがアシスタントのリクエスト（Google アシスタントのコマンドなど）によって起動された。

MessageType

static

文字列

カスタム メッセージの種類。

値
STRING	文字列 メッセージは自由形式の文字列です。送信される情報のエンコード / デコードは、アプリケーションが行います。
JSON	文字列 メッセージは JSON でエンコードされます。基盤となるトランスポートは、JSON エンコードされた文字列を使用します。

StandbyState

static

文字列

これは、プラットフォームから報告された現在のスタンバイ状態を表します。Cast プラットフォームが状態を判断できない場合は、UNKNOWN になることがあります。

値
スタンバイ	文字列
NOT_STANDBY	文字列
UNKNOWN	文字列

SystemState

static

文字列

これは、現在のシステム状態を表します。

値
NOT_STARTED	文字列 アプリケーションの起動がまだリクエストされていません。
STARTING_IN_BACKGROUND	文字列 アプリケーションは起動しているが、ユーザーには表示されていない。
開始中	文字列 アプリケーションを起動しています。
準備完了	文字列 アプリがフォアグラウンドにあり、メッセージを送受信する準備が整っている。
STOPPING_IN_BACKGROUND	文字列 バックグラウンドでアプリが停止しています。
停止中	文字列 アプリケーションを停止しています。

VisibilityState

static

文字列

これは、プラットフォームから報告された現在の公開設定の状態を表します。Cast プラットフォームが公開設定を判断できない場合は、UNKNOWN になることがあります。

値
VISIBLE	文字列
NOT_VISIBLE	文字列
UNKNOWN	文字列

抽象型

DeviceCapabilitiesObj

static

{audio_assistant: (boolean or undefined), bluetooth_supported: (boolean or undefined), display_supported: (boolean or undefined), hi_res_audio_supported: (boolean or undefined), is_dv_supported: (boolean or undefined), is_hdr_supported: (boolean or undefined), cast_lite_only: (boolean or undefined), dpad_input_supported: (boolean or undefined), touch_input_supported: (boolean or undefined), is_group: (boolean or undefined), remote_control_overlay_supported: (boolean or undefined), sleep_timer_overlay_supported: (boolean or undefined), app_foreground: (boolean or undefined), is_device_registered: (boolean or undefined), is_cbcs_supported: (boolean or undefined), is_dolby_atmos_supported: (boolean or undefined)}

getDeviceCapabilities によって返されるオブジェクトについて説明します。

関連情報

cast.framework.system.DeviceCapabilities

DeviceInformationObj

static

{model-name: string, brand-name: string, os-name: string, os-version: string, environment: string, device-id: string, metadata-from-firmware: boolean}

getDeviceInformation によって返されるオブジェクトを記述します。

関連情報

cast.framework.system.DeviceInformation