命名空间：system

cast.framework.system

namespace   static

这是 cast.framework.system 命名空间。

类

枚举

DeviceCapabilities

静态

字符串

描述当前设置的功能，该设置由支持 Cast 的设备以及（如果适用）与其连接的显示设备组成。

值

AUDIO_ASSISTANT

字符串

支持音频助理。支持 Cast 且支持音频助理的设备示例包括 Google Home 和 Google Home Mini。

BLUETOOTH_SUPPORTED

字符串

蓝牙支持。

DISPLAY_SUPPORTED

字符串

显示输出支持。支持显示功能的 Cast 设备包括 Chromecast 和 Cast 电视。不支持显示屏的 Cast 设备示例包括 Chromecast Audio 和 Google Home。

HI_RES_AUDIO_SUPPORTED

字符串

支持高解析度音频（最高 24 位 / 96KHz）。

IS_DV_SUPPORTED

字符串

支持杜比视界。

IS_HDR_SUPPORTED

字符串

支持 HDR 视频。

CAST_LITE_ONLY

字符串

相应设备是否在纯音频平台上运行。某些 API 在此类平台上可能无法完全支持。

DPAD_INPUT_SUPPORTED

字符串

相应设备是否支持输入机制，例如解锁 D-Pad。

TOUCH_INPUT_SUPPORTED

字符串

触控输入支持。支持触控输入的启用 Cast 的设备示例包括 Google Nest Hub 和 Google Nest Hub Max。

IS_GROUP

字符串

如果设备是虚拟设备，并且表示的是群组目标而非实体设备。

IS_DEVICE_REGISTERED

字符串

如果设置为 true，此标志表示 Cast 设备已在 Cast 开发者控制台中注册

IS_CBCS_SUPPORTED

字符串

设置为 true 时，此标志表示支持 CBCS 方案 (SAMPLE-AES)。

IS_DOLBY_ATMOS_SUPPORTED

字符串

设置为 true 时，此标志表示通过音频直通支持杜比全景声。

DeviceInformation

静态

字符串

cast.framework.CastReceiverContext.DeviceInformationObj 中有效键的常量。

值

MODEL_NAME

字符串

设备型号名称（例如：Google TV Streamer、Nest Hub、Nest Mini 等，如果已知）。如果未知，则为“unknown”。

BRAND_NAME

字符串

设备品牌的名称（例如：Google、LG、Sony 等，如果已知）。 如果未知，则为空字符串。

OS_NAME

字符串

设备操作系统的名称（例如：Android、Fuchsia、Linux 等，如果已知）。 如果未知，则为空字符串；如果不是 Cast 设备，则为“not Cast”。

OS_VERSION

字符串

设备操作系统的版本（例如 14.0 等，如果已知）。 如果未知，则为空字符串。

环境

字符串

设备所处的环境类型（例如住宅、汽车、飞机、酒店等，如果已知）。大多数设备的典型“主页”。

DEVICE_ID

字符串

接收器设备的唯一 ID（如果已知）。将与发送方 SDK 公开的 Cast 接收器 ID 具有相同的值。如果未知，则为空字符串。

METADATA_FROM_FIRMWARE

字符串

设备信息是否由固件提供。

DisconnectReason

静态

字符串

表示断开连接的原因。

值

REQUESTED_BY_SENDER

字符串

连接关闭是由发送方应用主动请求的（通常由用户触发）。

错误

字符串

出现协议错误。

未知

字符串

无法确定发送者是否通过调用 close() 请求正常断开连接（很可能没有，但“关闭”消息可能已丢失）。当出现网络超时、发送方应用崩溃或发送方操作系统关闭套接字时，通常会发生这种情况。

EventType

静态

字符串

由 cast.framework.CastReceiverContext 分派的系统事件。

值

准备就绪

字符串

在系统准备就绪时触发。

关机

字符串

在应用终止时触发。

SENDER_CONNECTED

字符串

当有新的发送者连接时触发。

SENDER_DISCONNECTED

字符串

当发送者断开连接时触发。

错误

字符串

在出现系统错误时触发。

SYSTEM_VOLUME_CHANGED

字符串

在系统音量发生变化时触发。

VISIBILITY_CHANGED

字符串

当应用的可见性发生变化时（例如，在 HDMI 输入源发生变化后，或者在电视关闭或开启且 Cast 设备由外部供电时）触发。请注意，此 API 的效果与浏览器引发的“webkitvisibilitychange”事件相同。为了方便起见并避免依赖于以 webkit 为前缀的事件，该 API 以 cast.framework.CastReceiverContext API 的形式提供。

STANDBY_CHANGED

字符串

在电视的待机状态发生变化时触发。此事件与 cast.framework.system.EventType.VISIBILITY_CHANGED 事件相关，因为如果电视处于待机模式，可见性将为 false。

与待机状态相比，可见性状态更加精细（因为可见性还包括电视频道选择），但在所有电视中都无法可靠地检测到。在这些情况下，可以使用待机模式，因为大多数电视都实现了该模式。

MAX_VIDEO_RESOLUTION_CHANGED

字符串

FEEDBACK_STARTED

字符串

当系统开始创建反馈报告时触发。

LaunchedFrom

静态

字符串

这表示启动接收器的请求类型。

值

未知

字符串

无法确定启动所有者。

DIAL

字符串

应用由 DIAL 请求启动。

CAST

字符串

应用由 Cast V2 请求启动。

CLOUD

字符串

应用是由助理请求（例如，通过 Google 助理命令）启动的。

MessageType

静态

字符串

自定义消息的类型。

值

STRING

字符串

消息是自由格式的字符串。应用负责对传输的信息进行编码/解码。

JSON

字符串

消息采用 JSON 编码。底层传输将使用 JSON 编码的字符串。

StandbyState

静态

字符串

表示平台报告的当前待机状态。如果 Cast 平台无法确定状态，则可能为 UNKNOWN。

值

STANDBY

字符串

NOT_STANDBY

字符串

未知

字符串

SystemState

静态

字符串

表示当前系统状态。

值

尚未开始

字符串

应用尚未被请求启动。

STARTING_IN_BACKGROUND

字符串

应用正在启动，但用户看不到。

正在开始

字符串

应用正在启动。

准备就绪

字符串

应用在前台运行，并且已准备好发送和接收消息。

STOPPING_IN_BACKGROUND

字符串

应用在后台运行时停止。

正在停止

字符串

应用正在停止。

VisibilityState

静态

字符串

表示平台报告的当前可见性状态。如果 Cast 平台无法确定可见性状态，则可能为 UNKNOWN。

值

VISIBLE

字符串

NOT_VISIBLE

字符串

未知

字符串

属性

DeviceCapabilities

静态

字符串

描述当前设置的功能，该设置由支持 Cast 的设备以及（如果适用）与其连接的显示设备组成。

值

AUDIO_ASSISTANT

字符串

支持音频助理。支持 Cast 且支持音频助理的设备示例包括 Google Home 和 Google Home Mini。

BLUETOOTH_SUPPORTED

字符串

蓝牙支持。

DISPLAY_SUPPORTED

字符串

显示输出支持。支持显示功能的 Cast 设备包括 Chromecast 和 Cast 电视。不支持显示屏的 Cast 设备示例包括 Chromecast Audio 和 Google Home。

HI_RES_AUDIO_SUPPORTED

字符串

支持高解析度音频（最高 24 位 / 96KHz）。

IS_DV_SUPPORTED

字符串

支持杜比视界。

IS_HDR_SUPPORTED

字符串

支持 HDR 视频。

CAST_LITE_ONLY

字符串

相应设备是否在纯音频平台上运行。某些 API 在此类平台上可能无法完全支持。

DPAD_INPUT_SUPPORTED

字符串

相应设备是否支持输入机制，例如解锁 D-Pad。

TOUCH_INPUT_SUPPORTED

字符串

触控输入支持。支持触控输入的启用 Cast 的设备示例包括 Google Nest Hub 和 Google Nest Hub Max。

IS_GROUP

字符串

如果设备是虚拟设备，并且表示的是群组目标而非实体设备。

IS_DEVICE_REGISTERED

字符串

如果设置为 true，此标志表示 Cast 设备已在 Cast 开发者控制台中注册

IS_CBCS_SUPPORTED

字符串

设置为 true 时，此标志表示支持 CBCS 方案 (SAMPLE-AES)。

IS_DOLBY_ATMOS_SUPPORTED

字符串

设置为 true 时，此标志表示通过音频直通支持杜比全景声。

DeviceInformation

静态

字符串

cast.framework.CastReceiverContext.DeviceInformationObj 中有效键的常量。

值

MODEL_NAME

字符串

设备型号名称（例如：Google TV Streamer、Nest Hub、Nest Mini 等，如果已知）。如果未知，则为“unknown”。

BRAND_NAME

字符串

设备品牌的名称（例如：Google、LG、Sony 等，如果已知）。 如果未知，则为空字符串。

OS_NAME

字符串

设备操作系统的名称（例如：Android、Fuchsia、Linux 等，如果已知）。 如果未知，则为空字符串；如果不是 Cast 设备，则为“not Cast”。

OS_VERSION

字符串

设备操作系统的版本（例如 14.0 等，如果已知）。 如果未知，则为空字符串。

环境

字符串

设备所处的环境类型（例如住宅、汽车、飞机、酒店等，如果已知）。大多数设备的典型“主页”。

DEVICE_ID

字符串

接收器设备的唯一 ID（如果已知）。将与发送方 SDK 公开的 Cast 接收器 ID 具有相同的值。如果未知，则为空字符串。

METADATA_FROM_FIRMWARE

字符串

设备信息是否由固件提供。

DisconnectReason

静态

字符串

表示断开连接的原因。

值

REQUESTED_BY_SENDER

字符串

连接关闭是由发送方应用主动请求的（通常由用户触发）。

错误

字符串

出现协议错误。

未知

字符串

无法确定发送者是否通过调用 close() 请求正常断开连接（很可能没有，但“关闭”消息可能已丢失）。当出现网络超时、发送方应用崩溃或发送方操作系统关闭套接字时，通常会发生这种情况。

EventType

静态

字符串

由 cast.framework.CastReceiverContext 分派的系统事件。

值

准备就绪

字符串

在系统准备就绪时触发。

关机

字符串

在应用终止时触发。

SENDER_CONNECTED

字符串

当有新的发送者连接时触发。

SENDER_DISCONNECTED

字符串

当发送者断开连接时触发。

错误

字符串

在出现系统错误时触发。

SYSTEM_VOLUME_CHANGED

字符串

在系统音量发生变化时触发。

VISIBILITY_CHANGED

字符串

当应用的可见性发生变化时（例如，在 HDMI 输入源发生变化后，或者在电视关闭或开启且 Cast 设备由外部供电时）触发。请注意，此 API 的效果与浏览器引发的“webkitvisibilitychange”事件相同。为了方便起见并避免依赖于以 webkit 为前缀的事件，该 API 以 cast.framework.CastReceiverContext API 的形式提供。

STANDBY_CHANGED

字符串

在电视的待机状态发生变化时触发。此事件与 cast.framework.system.EventType.VISIBILITY_CHANGED 事件相关，因为如果电视处于待机模式，可见性将为 false。

与待机状态相比，可见性状态更加精细（因为可见性还包括电视频道选择），但在所有电视中都无法可靠地检测到。在这些情况下，可以使用待机模式，因为大多数电视都实现了该模式。

MAX_VIDEO_RESOLUTION_CHANGED

字符串

FEEDBACK_STARTED

字符串

当系统开始创建反馈报告时触发。

LaunchedFrom

静态

字符串

这表示启动接收器的请求类型。

值

未知

字符串

无法确定启动所有者。

DIAL

字符串

应用由 DIAL 请求启动。

CAST

字符串

应用由 Cast V2 请求启动。

CLOUD

字符串

应用是由助理请求（例如，通过 Google 助理命令）启动的。

MessageType

静态

字符串

自定义消息的类型。

值

STRING

字符串

消息是自由格式的字符串。应用负责对传输的信息进行编码/解码。

JSON

字符串

消息采用 JSON 编码。底层传输将使用 JSON 编码的字符串。

StandbyState

静态

字符串

表示平台报告的当前待机状态。如果 Cast 平台无法确定状态，则可能为 UNKNOWN。

值

STANDBY

字符串

NOT_STANDBY

字符串

未知

字符串

SystemState

静态

字符串

表示当前系统状态。

值

尚未开始

字符串

应用尚未被请求启动。

STARTING_IN_BACKGROUND

字符串

应用正在启动，但用户看不到。

正在开始

字符串

应用正在启动。

准备就绪

字符串

应用在前台运行，并且已准备好发送和接收消息。

STOPPING_IN_BACKGROUND

字符串

应用在后台运行时停止。

正在停止

字符串

应用正在停止。

VisibilityState

静态

字符串

表示平台报告的当前可见性状态。如果 Cast 平台无法确定可见性状态，则可能为 UNKNOWN。

值

VISIBLE

字符串

NOT_VISIBLE

字符串

未知

字符串

抽象类型

DeviceCapabilitiesObj

静态

{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

静态

{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