เนมสเปซ: ระบบ

คลาส

การแจงนับ

DeviceCapabilities

คงที่

สตริง

อธิบายความสามารถของการตั้งค่าปัจจุบัน ซึ่งประกอบด้วย อุปกรณ์ที่พร้อมใช้งาน Cast และอุปกรณ์แสดงผลที่เชื่อมต่อ อยู่ (หากมี)

ค่า

AUDIO_ASSISTANT

สตริง

การรองรับผู้ช่วยเสียง ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ที่รองรับ Audio Assistant ได้แก่ Google Home และ Google Home Mini

BLUETOOTH_SUPPORTED

สตริง

รองรับบลูทูธ

DISPLAY_SUPPORTED

สตริง

รองรับเอาต์พุตการแสดงผล ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ที่รองรับการแสดงผล ได้แก่ Chromecast และทีวีที่พร้อมใช้งาน Cast ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ซึ่งไม่รองรับจอแสดงผล ได้แก่ Chromecast Audio และ Google Home

HI_RES_AUDIO_SUPPORTED

สตริง

รองรับเสียงความละเอียดสูง (สูงสุด 24 บิต / 96 KHz)

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

คงที่

สตริง

ค่าคงที่สำหรับคีย์ที่ถูกต้องใน cast.framework.CastReceiverContext.DeviceInformationObj

ค่า

MODEL_NAME

สตริง

ชื่อรุ่นอุปกรณ์ (เช่น Google TV Streamer, Nest Hub, Nest Mini ฯลฯ) หากทราบ "ไม่ทราบ" หากไม่ทราบ

BRAND_NAME

สตริง

ชื่อแบรนด์ของอุปกรณ์ (เช่น Google, LG, Sony ฯลฯ) หากทราบ สตริงว่างหากไม่ทราบ

OS_NAME

สตริง

ชื่อของระบบปฏิบัติการของอุปกรณ์ (เช่น Android, Fuchsia, Linux ฯลฯ) หากทราบ สตริงว่างหากไม่ทราบ หรือ "ไม่ใช่ Cast" หากไม่ใช่อุปกรณ์ Cast

OS_VERSION

สตริง

เวอร์ชันระบบปฏิบัติการของอุปกรณ์ (เช่น 14.0 เป็นต้น) หากทราบ สตริงว่างหากไม่ทราบ

สภาพแวดล้อม

สตริง

ประเภทสภาพแวดล้อมที่อุปกรณ์อยู่ (เช่น บ้าน รถยนต์ เครื่องบิน โรงแรม ฯลฯ) หากทราบ โดยปกติแล้วจะเป็น "หน้าแรก" สำหรับอุปกรณ์ส่วนใหญ่

DEVICE_ID

สตริง

รหัสที่ไม่ซ้ำกันของอุปกรณ์ตัวรับ หากทราบ จะมีค่าเดียวกับ รหัสตัวรับ Cast ที่ Sender SDK แสดง สตริงว่างหากไม่ทราบ

METADATA_FROM_FIRMWARE

สตริง

เฟิร์มแวร์ระบุข้อมูลอุปกรณ์หรือไม่

DisconnectReason

คงที่

สตริง

แสดงเหตุผลที่ทำให้การเชื่อมต่อขาดหาย

ค่า

REQUESTED_BY_SENDER

สตริง

แอปพลิเคชันของผู้ส่งขอปิดการเชื่อมต่ออย่างชัดเจน (โดยปกติแล้ว จะเกิดจากผู้ใช้)

ข้อผิดพลาด

สตริง

เกิดข้อผิดพลาดของโปรโตคอล

ไม่ทราบ

สตริง

ไม่ทราบว่าผู้ส่งขอตัดการเชื่อมต่ออย่างถูกต้องโดยการเรียก close() หรือไม่ (ส่วนใหญ่แล้วไม่น่าจะใช่ แต่ข้อความ "ปิด" อาจ สูญหายไป) โดยปกติแล้ว กรณีนี้จะเกิดขึ้นเมื่อเครือข่ายหมดเวลา เมื่อแอปพลิเคชันของผู้ส่งขัดข้อง หรือเมื่อระบบปฏิบัติการของผู้ส่งปิดซ็อกเก็ต

EventType

คงที่

สตริง

เหตุการณ์ของระบบที่ส่งโดย cast.framework.CastReceiverContext

ค่า

พร้อม

สตริง

เริ่มทำงานเมื่อระบบพร้อม

SHUTDOWN

สตริง

เริ่มทำงานเมื่อแอปพลิเคชันสิ้นสุด

SENDER_CONNECTED

สตริง

ทริกเกอร์เมื่อผู้ส่งรายใหม่เชื่อมต่อ

SENDER_DISCONNECTED

สตริง

เริ่มทำงานเมื่อผู้ส่งยกเลิกการเชื่อมต่อ

ข้อผิดพลาด

สตริง

เริ่มทำงานเมื่อเกิดข้อผิดพลาดของระบบ

SYSTEM_VOLUME_CHANGED

สตริง

ทริกเกอร์เมื่อระดับเสียงของระบบมีการเปลี่ยนแปลง

VISIBILITY_CHANGED

สตริง

ทริกเกอร์เมื่อระดับการเข้าถึงของแอปพลิเคชันมีการเปลี่ยนแปลง (เช่น หลังจากเปลี่ยนอินพุต HDMI หรือเมื่อปิดหรือเปิดทีวีและอุปกรณ์ Cast ใช้แหล่งจ่ายไฟภายนอก) โปรดทราบว่า API นี้มีผลเช่นเดียวกับ เหตุการณ์ "webkitvisibilitychange" ที่เบราว์เซอร์สร้างขึ้น ซึ่งมีให้ใช้งานเป็น API cast.framework.CastReceiverContext เพื่อความสะดวกและหลีกเลี่ยงการขึ้นอยู่กับเหตุการณ์ที่มีคำนำหน้า webkit

STANDBY_CHANGED

สตริง

ทริกเกอร์เมื่อสถานะสแตนด์บายของทีวีมีการเปลี่ยนแปลง เหตุการณ์นี้เกี่ยวข้องกับเหตุการณ์ cast.framework.system.EventType.VISIBILITY_CHANGED เนื่องจากหากทีวีอยู่ในโหมดสแตนด์บาย ระดับการเข้าถึงจะเป็น false

สถานะการมองเห็นมีความละเอียดมากกว่าสถานะสแตนด์บาย (เนื่องจากการมองเห็น ยังรวมถึงการเลือกช่องทีวีด้วย) แต่ตรวจหาได้อย่างไม่น่าเชื่อถือในทีวี บางรุ่น คุณใช้โหมดสแตนด์บายได้ในกรณีดังกล่าวเนื่องจากทีวีส่วนใหญ่มีฟีเจอร์นี้

MAX_VIDEO_RESOLUTION_CHANGED

สตริง

FEEDBACK_STARTED

สตริง

เริ่มทำงานเมื่อระบบเริ่มสร้างรายงานความคิดเห็น

LaunchedFrom

คงที่

สตริง

ซึ่งแสดงถึงประเภทคำขอที่เปิดตัวตัวรับ

ค่า

ไม่ทราบ

สตริง

ไม่สามารถระบุเจ้าของการเปิดตัวได้

DIAL

สตริง

แอปเปิดขึ้นโดยคำขอ DIAL

แคสต์

สตริง

แอปเปิดขึ้นโดยคำขอ Cast V2

คลาวด์

สตริง

แอปเปิดขึ้นตามคำขอของ Assistant (เช่น จากคำสั่งของ Google Assistant )

MessageType

คงที่

สตริง

ประเภทของข้อความที่กำหนดเอง

ค่า

STRING

สตริง

ข้อความคือสตริงรูปแบบอิสระ แอปพลิเคชันมีหน้าที่ เข้ารหัส/ถอดรหัสข้อมูลที่ส่ง

JSON

สตริง

ข้อความจะได้รับการเข้ารหัส JSON การรับส่งข้อมูลพื้นฐานจะใช้สตริงที่เข้ารหัส JSON

StandbyState

คงที่

สตริง

ซึ่งแสดงถึงสถานะสแตนด์บายปัจจุบันที่แพลตฟอร์มรายงาน อาจเป็น UNKNOWN หากแพลตฟอร์ม Cast ระบุสถานะไม่ได้

ค่า

สแตนด์บาย

สตริง

NOT_STANDBY

สตริง

ไม่ทราบ

สตริง

SystemState

คงที่

สตริง

ซึ่งแสดงถึงสถานะปัจจุบันของระบบ

ค่า

NOT_STARTED

สตริง

ยังไม่ได้ขอให้เริ่มแอปพลิเคชัน

STARTING_IN_BACKGROUND

สตริง

แอปพลิเคชันกำลังเริ่มต้น แต่ผู้ใช้มองไม่เห็น

กำลังเริ่ม

สตริง

กำลังเริ่มต้นแอปพลิเคชัน

พร้อม

สตริง

แอปพลิเคชันอยู่เบื้องหน้าและพร้อมส่งและรับข้อความ

STOPPING_IN_BACKGROUND

สตริง

แอปพลิเคชันหยุดทำงานขณะอยู่ในเบื้องหลัง

กำลังหยุด

สตริง

แอปพลิเคชันกำลังหยุดทำงาน

VisibilityState

คงที่

สตริง

ซึ่งแสดงถึงสถานะระดับการมองเห็นปัจจุบันที่แพลตฟอร์มรายงาน อาจเป็น UNKNOWN หากแพลตฟอร์ม Cast ระบุสถานะระดับการมองเห็นไม่ได้

ค่า

แสดง

สตริง

NOT_VISIBLE

สตริง

ไม่ทราบ

สตริง

พร็อพเพอร์ตี้

DeviceCapabilities

คงที่

สตริง

อธิบายความสามารถของการตั้งค่าปัจจุบัน ซึ่งประกอบด้วย อุปกรณ์ที่พร้อมใช้งาน Cast และอุปกรณ์แสดงผลที่เชื่อมต่อ อยู่ (หากมี)

ค่า

AUDIO_ASSISTANT

สตริง

การรองรับผู้ช่วยเสียง ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ที่รองรับ Audio Assistant ได้แก่ Google Home และ Google Home Mini

BLUETOOTH_SUPPORTED

สตริง

รองรับบลูทูธ

DISPLAY_SUPPORTED

สตริง

รองรับเอาต์พุตการแสดงผล ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ที่รองรับการแสดงผล ได้แก่ Chromecast และทีวีที่พร้อมใช้งาน Cast ตัวอย่างอุปกรณ์ที่พร้อมใช้งาน Cast ซึ่งไม่รองรับจอแสดงผล ได้แก่ Chromecast Audio และ Google Home

HI_RES_AUDIO_SUPPORTED

สตริง

รองรับเสียงความละเอียดสูง (สูงสุด 24 บิต / 96 KHz)

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

คงที่

สตริง

ค่าคงที่สำหรับคีย์ที่ถูกต้องใน cast.framework.CastReceiverContext.DeviceInformationObj

ค่า

MODEL_NAME

สตริง

ชื่อรุ่นอุปกรณ์ (เช่น Google TV Streamer, Nest Hub, Nest Mini ฯลฯ) หากทราบ "ไม่ทราบ" หากไม่ทราบ

BRAND_NAME

สตริง

ชื่อแบรนด์ของอุปกรณ์ (เช่น Google, LG, Sony ฯลฯ) หากทราบ สตริงว่างหากไม่ทราบ

OS_NAME

สตริง

ชื่อของระบบปฏิบัติการของอุปกรณ์ (เช่น Android, Fuchsia, Linux ฯลฯ) หากทราบ สตริงว่างหากไม่ทราบ หรือ "ไม่ใช่ Cast" หากไม่ใช่อุปกรณ์ Cast

OS_VERSION

สตริง

เวอร์ชันระบบปฏิบัติการของอุปกรณ์ (เช่น 14.0 เป็นต้น) หากทราบ สตริงว่างหากไม่ทราบ

สภาพแวดล้อม

สตริง

ประเภทสภาพแวดล้อมที่อุปกรณ์อยู่ (เช่น บ้าน รถยนต์ เครื่องบิน โรงแรม ฯลฯ) หากทราบ โดยปกติแล้วจะเป็น "หน้าแรก" สำหรับอุปกรณ์ส่วนใหญ่

DEVICE_ID

สตริง

รหัสที่ไม่ซ้ำกันของอุปกรณ์ตัวรับ หากทราบ จะมีค่าเดียวกับ รหัสตัวรับ Cast ที่ Sender SDK แสดง สตริงว่างหากไม่ทราบ

METADATA_FROM_FIRMWARE

สตริง

เฟิร์มแวร์ระบุข้อมูลอุปกรณ์หรือไม่

DisconnectReason

คงที่

สตริง

แสดงเหตุผลที่ทำให้การเชื่อมต่อขาดหาย

ค่า

REQUESTED_BY_SENDER

สตริง

แอปพลิเคชันของผู้ส่งขอปิดการเชื่อมต่ออย่างชัดเจน (โดยปกติแล้ว จะเกิดจากผู้ใช้)

ข้อผิดพลาด

สตริง

เกิดข้อผิดพลาดของโปรโตคอล

ไม่ทราบ

สตริง

ไม่ทราบว่าผู้ส่งขอตัดการเชื่อมต่ออย่างถูกต้องโดยการเรียก close() หรือไม่ (ส่วนใหญ่แล้วไม่น่าจะใช่ แต่ข้อความ "ปิด" อาจ สูญหายไป) โดยปกติแล้ว กรณีนี้จะเกิดขึ้นเมื่อเครือข่ายหมดเวลา เมื่อแอปพลิเคชันของผู้ส่งขัดข้อง หรือเมื่อระบบปฏิบัติการของผู้ส่งปิดซ็อกเก็ต

EventType

คงที่

สตริง

เหตุการณ์ของระบบที่ส่งโดย cast.framework.CastReceiverContext

ค่า

พร้อม

สตริง

เริ่มทำงานเมื่อระบบพร้อม

SHUTDOWN

สตริง

เริ่มทำงานเมื่อแอปพลิเคชันสิ้นสุด

SENDER_CONNECTED

สตริง

ทริกเกอร์เมื่อผู้ส่งรายใหม่เชื่อมต่อ

SENDER_DISCONNECTED

สตริง

เริ่มทำงานเมื่อผู้ส่งยกเลิกการเชื่อมต่อ

ข้อผิดพลาด

สตริง

เริ่มทำงานเมื่อเกิดข้อผิดพลาดของระบบ

SYSTEM_VOLUME_CHANGED

สตริง

ทริกเกอร์เมื่อระดับเสียงของระบบมีการเปลี่ยนแปลง

VISIBILITY_CHANGED

สตริง

ทริกเกอร์เมื่อระดับการเข้าถึงของแอปพลิเคชันมีการเปลี่ยนแปลง (เช่น หลังจากเปลี่ยนอินพุต HDMI หรือเมื่อปิดหรือเปิดทีวีและอุปกรณ์ Cast ใช้แหล่งจ่ายไฟภายนอก) โปรดทราบว่า API นี้มีผลเช่นเดียวกับ เหตุการณ์ "webkitvisibilitychange" ที่เบราว์เซอร์สร้างขึ้น ซึ่งมีให้ใช้งานเป็น API cast.framework.CastReceiverContext เพื่อความสะดวกและหลีกเลี่ยงการขึ้นอยู่กับเหตุการณ์ที่มีคำนำหน้า webkit

STANDBY_CHANGED

สตริง

ทริกเกอร์เมื่อสถานะสแตนด์บายของทีวีมีการเปลี่ยนแปลง เหตุการณ์นี้เกี่ยวข้องกับเหตุการณ์ cast.framework.system.EventType.VISIBILITY_CHANGED เนื่องจากหากทีวีอยู่ในโหมดสแตนด์บาย ระดับการเข้าถึงจะเป็น false

สถานะการมองเห็นมีความละเอียดมากกว่าสถานะสแตนด์บาย (เนื่องจากการมองเห็น ยังรวมถึงการเลือกช่องทีวีด้วย) แต่ตรวจหาได้อย่างไม่น่าเชื่อถือในทีวี บางรุ่น คุณใช้โหมดสแตนด์บายได้ในกรณีดังกล่าวเนื่องจากทีวีส่วนใหญ่มีฟีเจอร์นี้

MAX_VIDEO_RESOLUTION_CHANGED

สตริง

FEEDBACK_STARTED

สตริง

เริ่มทำงานเมื่อระบบเริ่มสร้างรายงานความคิดเห็น

LaunchedFrom

คงที่

สตริง

ซึ่งแสดงถึงประเภทคำขอที่เปิดตัวตัวรับ

ค่า

ไม่ทราบ

สตริง

ไม่สามารถระบุเจ้าของการเปิดตัวได้

DIAL

สตริง

แอปเปิดขึ้นโดยคำขอ DIAL

แคสต์

สตริง

แอปเปิดขึ้นโดยคำขอ Cast V2

คลาวด์

สตริง

แอปเปิดขึ้นตามคำขอของ Assistant (เช่น จากคำสั่งของ Google Assistant )

MessageType

คงที่

สตริง

ประเภทของข้อความที่กำหนดเอง

ค่า

STRING

สตริง

ข้อความคือสตริงรูปแบบอิสระ แอปพลิเคชันมีหน้าที่ เข้ารหัส/ถอดรหัสข้อมูลที่ส่ง

JSON

สตริง

ข้อความจะได้รับการเข้ารหัส JSON การรับส่งข้อมูลพื้นฐานจะใช้สตริงที่เข้ารหัส JSON

StandbyState

คงที่

สตริง

ซึ่งแสดงถึงสถานะสแตนด์บายปัจจุบันที่แพลตฟอร์มรายงาน อาจเป็น UNKNOWN หากแพลตฟอร์ม Cast ระบุสถานะไม่ได้

ค่า

สแตนด์บาย

สตริง

NOT_STANDBY

สตริง

ไม่ทราบ

สตริง

SystemState

คงที่

สตริง

ซึ่งแสดงถึงสถานะปัจจุบันของระบบ

ค่า

NOT_STARTED

สตริง

ยังไม่ได้ขอให้เริ่มแอปพลิเคชัน

STARTING_IN_BACKGROUND

สตริง

แอปพลิเคชันกำลังเริ่มต้น แต่ผู้ใช้มองไม่เห็น

กำลังเริ่ม

สตริง

กำลังเริ่มต้นแอปพลิเคชัน

พร้อม

สตริง

แอปพลิเคชันอยู่เบื้องหน้าและพร้อมส่งและรับข้อความ

STOPPING_IN_BACKGROUND

สตริง

แอปพลิเคชันหยุดทำงานขณะอยู่ในเบื้องหลัง

กำลังหยุด

สตริง

แอปพลิเคชันกำลังหยุดทำงาน

VisibilityState

คงที่

สตริง

ซึ่งแสดงถึงสถานะระดับการมองเห็นปัจจุบันที่แพลตฟอร์มรายงาน อาจเป็น UNKNOWN หากแพลตฟอร์ม Cast ระบุสถานะระดับการมองเห็นไม่ได้

ค่า

แสดง

สตริง

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