命名空间:system

类

枚举

DeviceCapabilities

static

字符串

描述当前设置的功能,该设置由支持 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

字符串

此设备是否支持输入机制,例如解锁方向键。

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,此标志表示通过音频直通支持 Dolby Atmos。

DeviceInformation

static

字符串

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 等),如果已知。 如果未知,则为空字符串。

环境

字符串

设备所处的环境类型(例如:住宅、汽车、飞机、酒店等),如果已知。对于大多数设备,通常为“home”。

DEVICE_ID

字符串

接收方设备的唯一 ID(如果已知)。该值将与发送端 SDK 公开的 Cast 接收器 ID 相同。如果未知,则为空白字符串。

METADATA_FROM_FIRMWARE

字符串

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

DisconnectReason

static

字符串

表示断开连接的原因。

值

REQUESTED_BY_SENDER

字符串

发送端应用主动请求关闭连接(通常由用户触发)。

错误

字符串

发生协议错误。

未知

字符串

发送方是否通过调用 close() 请求正常断开连接未知(很可能没有,但“关闭”消息可能已丢失)。这通常发生在网络超时、发送方应用崩溃或发送方操作系统关闭套接字时。

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 输入发生变化后,或者在电视关闭或开启且 Cast 设备由外部供电时)触发。请注意,此 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。

值

STANDBY

字符串

NOT_STANDBY

字符串

未知

字符串

SystemState

static

字符串

这表示当前系统状态。

值

尚未开始

字符串

尚未请求启动应用。

STARTING_IN_BACKGROUND

字符串

应用正在启动,但对用户不可见。

即将开始

字符串

应用正在启动。

准备就绪

字符串

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

STOPPING_IN_BACKGROUND

字符串

应用在后台运行时正在停止。

正在停止

字符串

应用正在停止。

VisibilityState

static

字符串

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

值

VISIBLE

字符串

NOT_VISIBLE

字符串

未知

字符串

属性

DeviceCapabilities

static

字符串

描述当前设置的功能,该设置由支持 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

字符串

此设备是否支持输入机制,例如解锁方向键。

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,此标志表示通过音频直通支持 Dolby Atmos。

DeviceInformation

static

字符串

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 等),如果已知。 如果未知,则为空字符串。

环境

字符串

设备所处的环境类型(例如:住宅、汽车、飞机、酒店等),如果已知。对于大多数设备,通常为“home”。

DEVICE_ID

字符串

接收方设备的唯一 ID(如果已知)。该值将与发送端 SDK 公开的 Cast 接收器 ID 相同。如果未知,则为空白字符串。

METADATA_FROM_FIRMWARE

字符串

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

DisconnectReason

static

字符串

表示断开连接的原因。

值

REQUESTED_BY_SENDER

字符串

发送端应用主动请求关闭连接(通常由用户触发)。

错误

字符串

发生协议错误。

未知

字符串

发送方是否通过调用 close() 请求正常断开连接未知(很可能没有,但“关闭”消息可能已丢失)。这通常发生在网络超时、发送方应用崩溃或发送方操作系统关闭套接字时。

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 输入发生变化后,或者在电视关闭或开启且 Cast 设备由外部供电时)触发。请注意,此 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。

值

STANDBY

字符串

NOT_STANDBY

字符串

未知

字符串

SystemState

static

字符串

这表示当前系统状态。

值

尚未开始

字符串

尚未请求启动应用。

STARTING_IN_BACKGROUND

字符串

应用正在启动,但对用户不可见。

即将开始

字符串

应用正在启动。

准备就绪

字符串

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

STOPPING_IN_BACKGROUND

字符串

应用在后台运行时正在停止。

正在停止

字符串

应用正在停止。

VisibilityState

static

字符串

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

值

VISIBLE

字符串

NOT_VISIBLE

字符串

未知

字符串

抽象类型

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