Namespace: system

cast.framework.system

namespace   static

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

クラス

列挙型

DeviceCapabilities

static

文字列

キャスト対応デバイスと、該当する場合は接続先のディスプレイ デバイスで構成される現在のセットアップの機能について説明します。

値

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

文字列

このデバイスが、ロック解除用方向キーなどの入力メカニズムをサポートしているかどうか。

TOUCH_INPUT_SUPPORTED

文字列

タッチ入力のサポート。タッチ入力に対応している Cast 対応デバイスの例としては、Google Nest Hub や Google Nest Hub Max などがあります。

IS_GROUP

文字列

デバイスが仮想デバイスで、物理デバイスではなくグループ ターゲットを表している場合。

IS_DEVICE_REGISTERED

文字列

true に設定されている場合、このフラグは Cast デバイスが 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 など）（わかっている場合）。 不明な場合は空の文字列。

環境

文字列

デバイスが置かれている環境のタイプ（自宅、自動車、飛行機、ホテルなど）。わかっている場合。ほとんどのデバイスでは通常「ホーム」です。

DEVICE_ID

文字列

受信側デバイスの一意の ID（わかっている場合）。Sender SDK によって公開される Cast Receiver ID と同じ値になります。不明な場合は空白の文字列。

METADATA_FROM_FIRMWARE

文字列

デバイス情報がファームウェアによって提供されたかどうか。

DisconnectReason

static

文字列

切断の理由を表します。

値

REQUESTED_BY_SENDER

文字列

接続の終了が送信側アプリから積極的にリクエストされた（通常はユーザーによってトリガーされる）。

エラー

文字列

プロトコル エラーが発生しました。

不明

文字列

送信側が close() を呼び出して正常に切断をリクエストしたかどうかは不明です（リクエストしていない可能性が高いですが、close メッセージが失われた可能性もあります）。通常、このエラーはネットワーク タイムアウトが発生した場合、送信側アプリがクラッシュした場合、送信側 OS がソケットを閉じた場合に発生します。

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

文字列

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

値

不明

文字列

リリース オーナーを特定できませんでした。

DIAL

文字列

アプリが DIAL リクエストによって起動された。

CAST

文字列

アプリが Cast V2 リクエストによって起動された。

Cloud

文字列

アシスタント リクエスト（Google アシスタントのコマンドなど）によってアプリが起動された。

MessageType

static

文字列

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

値

STRING

文字列

メッセージは自由形式の文字列です。アプリケーションは、送信される情報のエンコード/デコードを行います。

JSON

文字列

メッセージは JSON でエンコードされます。基盤となるトランスポートは JSON エンコードされた文字列を使用します。

StandbyState

static

文字列

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

値

スタンバイ

文字列

NOT_STANDBY

文字列

不明

文字列

SystemState

static

文字列

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

値

NOT_STARTED

文字列

アプリケーションの起動がまだリクエストされていません。

STARTING_IN_BACKGROUND

文字列

アプリケーションが起動しようとしていますが、ユーザーには表示されません。

開始中

文字列

アプリケーションが起動中です。

準備完了

文字列

アプリケーションがフォアグラウンドで実行されており、メッセージの送受信の準備が整っている。

STOPPING_IN_BACKGROUND

文字列

アプリがバックグラウンドで停止する。

停止中

文字列

アプリケーションが停止しています。

VisibilityState

static

文字列

これは、プラットフォームによって報告された現在の可視性の状態を表します。Cast プラットフォームで可視性の状態を特定できない場合は、UNKNOWN になることがあります。

値

VISIBLE

文字列

NOT_VISIBLE

文字列

不明

文字列

プロパティ

DeviceCapabilities

static

文字列

キャスト対応デバイスと、該当する場合は接続先のディスプレイ デバイスで構成される現在のセットアップの機能について説明します。

値

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

文字列

このデバイスが、ロック解除用方向キーなどの入力メカニズムをサポートしているかどうか。

TOUCH_INPUT_SUPPORTED

文字列

タッチ入力のサポート。タッチ入力に対応している Cast 対応デバイスの例としては、Google Nest Hub や Google Nest Hub Max などがあります。

IS_GROUP

文字列

デバイスが仮想デバイスで、物理デバイスではなくグループ ターゲットを表している場合。

IS_DEVICE_REGISTERED

文字列

true に設定されている場合、このフラグは Cast デバイスが 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 など）（わかっている場合）。 不明な場合は空の文字列。

環境

文字列

デバイスが置かれている環境のタイプ（自宅、自動車、飛行機、ホテルなど）。わかっている場合。ほとんどのデバイスでは通常「ホーム」です。

DEVICE_ID

文字列

受信側デバイスの一意の ID（わかっている場合）。Sender SDK によって公開される Cast Receiver ID と同じ値になります。不明な場合は空白の文字列。

METADATA_FROM_FIRMWARE

文字列

デバイス情報がファームウェアによって提供されたかどうか。

DisconnectReason

static

文字列

切断の理由を表します。

値

REQUESTED_BY_SENDER

文字列

接続の終了が送信側アプリから積極的にリクエストされた（通常はユーザーによってトリガーされる）。

エラー

文字列

プロトコル エラーが発生しました。

不明

文字列

送信側が close() を呼び出して正常に切断をリクエストしたかどうかは不明です（リクエストしていない可能性が高いですが、close メッセージが失われた可能性もあります）。通常、このエラーはネットワーク タイムアウトが発生した場合、送信側アプリがクラッシュした場合、送信側 OS がソケットを閉じた場合に発生します。

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

文字列

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

値

不明

文字列

リリース オーナーを特定できませんでした。

DIAL

文字列

アプリが DIAL リクエストによって起動された。

CAST

文字列

アプリが Cast V2 リクエストによって起動された。

Cloud

文字列

アシスタント リクエスト（Google アシスタントのコマンドなど）によってアプリが起動された。

MessageType

static

文字列

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

値

STRING

文字列

メッセージは自由形式の文字列です。アプリケーションは、送信される情報のエンコード/デコードを行います。

JSON

文字列

メッセージは JSON でエンコードされます。基盤となるトランスポートは JSON エンコードされた文字列を使用します。

StandbyState

static

文字列

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

値

スタンバイ

文字列

NOT_STANDBY

文字列

不明

文字列

SystemState

static

文字列

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

値

NOT_STARTED

文字列

アプリケーションの起動がまだリクエストされていません。

STARTING_IN_BACKGROUND

文字列

アプリケーションが起動しようとしていますが、ユーザーには表示されません。

開始中

文字列

アプリケーションが起動中です。

準備完了

文字列

アプリケーションがフォアグラウンドで実行されており、メッセージの送受信の準備が整っている。

STOPPING_IN_BACKGROUND

文字列

アプリがバックグラウンドで停止する。

停止中

文字列

アプリケーションが停止しています。

VisibilityState

static

文字列

これは、プラットフォームによって報告された現在の可視性の状態を表します。Cast プラットフォームで可視性の状態を特定できない場合は、UNKNOWN になることがあります。

値

VISIBLE

文字列

NOT_VISIBLE

文字列

不明

文字列

抽象型

DeviceCapabilitiesObj

static

{audio_assistant:（ブール値または未定義）、bluetooth_supported:（ブール値または未定義）、display_supported:（ブール値または未定義）、hi_res_audio_supported:（ブール値または未定義）、is_dv_supported:（ブール値または未定義）、is_hdr_supported:（ブール値または未定義）、cast_lite_only:（ブール値または未定義）、dpad_input_supported:（ブール値または未定義）、touch_input_supported:（ブール値または未定義）、is_group:（ブール値または未定義）、remote_control_overlay_supported:（ブール値または未定義）、sleep_timer_overlay_supported:（ブール値または未定義）、app_foreground:（ブール値または未定義）、is_device_registered:（ブール値または未定義）、is_cbcs_supported:（ブール値または未定義）、is_dolby_atmos_supported:（ブール値または未定義）}

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