命名空間:系統

類別

列舉

DeviceCapabilities

static

字串

說明目前設定的功能,包括支援 Cast 的裝置,以及 (如適用) 連接的顯示裝置。

AUDIO_ASSISTANT

字串

支援語音助理。支援 Cast 的裝置 (支援 Google 助理) 示例包括 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

字串

支援 Dolby Vision。

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 裝置已在 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

字串

裝置 OS 的名稱 (例如 Android、Fuchsia、Linux 等),如果知道的話。 如果不明,則為空白字串;如果不是 Cast 裝置,則為「not Cast」。

OS_VERSION

字串

裝置的作業系統版本 (例如 14.0 等),如有。 如果不明,則為空白字串。

環境

字串

裝置所在的環境類型 (例如住家、車輛、飛機、飯店等,如果知道的話)。大多數裝置的預設值為「home」。

DEVICE_ID

字串

接收端裝置的專屬 ID (如已知)。與 Sender SDK 公開的 Cast 接收器 ID 值相同。如果不明,則為空白字串。

METADATA_FROM_FIRMWARE

字串

裝置資訊是否由韌體提供。

DisconnectReason

static

字串

代表連線中斷的原因。

REQUESTED_BY_SENDER

字串

傳送端應用程式主動要求關閉連線 (通常是由使用者觸發)。

錯誤

字串

發生通訊協定錯誤。

不明

字串

我們不確定傳送者是否呼叫 close() 要求正常中斷連線 (最有可能沒有,但「close」訊息可能遺失)。這通常會在網路連線逾時、傳送端應用程式當機,或傳送端 OS 關閉通訊端時發生。

EventType

static

字串

cast.framework.CastReceiverContext 分派的系統事件。

準備就緒

字串

系統準備就緒時觸發。

SHUTDOWN

字串

應用程式終止時觸發。

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 V2 要求啟動。

CLOUD

字串

應用程式是透過 Google 助理要求啟動 (例如透過 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

字串

說明目前設定的功能,包括支援 Cast 的裝置,以及 (如適用) 連接的顯示裝置。

AUDIO_ASSISTANT

字串

支援語音助理。支援 Cast 的裝置 (支援 Google 助理) 示例包括 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

字串

支援 Dolby Vision。

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 裝置已在 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

字串

裝置 OS 的名稱 (例如 Android、Fuchsia、Linux 等),如果知道的話。 如果不明,則為空白字串;如果不是 Cast 裝置,則為「not Cast」。

OS_VERSION

字串

裝置的作業系統版本 (例如 14.0 等),如有。 如果不明,則為空白字串。

環境

字串

裝置所在的環境類型 (例如住家、車輛、飛機、飯店等,如果知道的話)。大多數裝置的預設值為「home」。

DEVICE_ID

字串

接收端裝置的專屬 ID (如已知)。與 Sender SDK 公開的 Cast 接收器 ID 值相同。如果不明,則為空白字串。

METADATA_FROM_FIRMWARE

字串

裝置資訊是否由韌體提供。

DisconnectReason

static

字串

代表連線中斷的原因。

REQUESTED_BY_SENDER

字串

傳送端應用程式主動要求關閉連線 (通常是由使用者觸發)。

錯誤

字串

發生通訊協定錯誤。

不明

字串

我們不確定傳送者是否呼叫 close() 要求正常中斷連線 (最有可能沒有,但「close」訊息可能遺失)。這通常會在網路連線逾時、傳送端應用程式當機,或傳送端 OS 關閉通訊端時發生。

EventType

static

字串

cast.framework.CastReceiverContext 分派的系統事件。

準備就緒

字串

系統準備就緒時觸發。

SHUTDOWN

字串

應用程式終止時觸發。

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 V2 要求啟動。

CLOUD

字串

應用程式是透過 Google 助理要求啟動 (例如透過 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: (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