chrome. แคสต์
เนมสเปซของ chrome.cast
ชั้นเรียน
ApiConfig
ระงับการกําหนดค่าสําหรับ API เมื่อเริ่มต้น
ข้อมูลเข้าสู่ระบบ
ข้อมูลเข้าสู่ระบบที่ใช้เพื่อระบุข้อมูลเข้าสู่ระบบของผู้ส่ง
คําขอการโทร
คําขอเริ่มแอป DIAL
ข้อผิดพลาด
อธิบายข้อผิดพลาดที่ API แสดงผล โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
รูปภาพ
รูปภาพที่อธิบายแอปพลิเคชันของผู้รับหรือรายการสื่อ ซึ่งอาจเป็นไอคอนแอปพลิเคชัน ภาพหน้าปก หรือภาพปก
ผู้รับ
อธิบายตัวรับที่ใช้แอปพลิเคชัน โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
สถานะผู้รับจอแสดงผล
สถานะผู้รับที่แสดงต่อผู้ใช้ใน UI ของส่วนขยาย ใช้ได้เฉพาะกับผู้รับที่กําหนดเองเท่านั้น
แอปพลิเคชันผู้ส่ง
อธิบายแอปพลิเคชันของผู้ส่ง โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
เซสชัน
อธิบายสถานะของแอปพลิเคชัน Cast ที่ทํางานอยู่ในปัจจุบัน โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
คําขอเซสชัน
คําขอเริ่มหรือเชื่อมต่อกับเซสชัน
ระยะหมดเวลา
กําหนดค่าระยะหมดเวลาเริ่มต้นเป็นมิลลิวินาทีสําหรับเมธอด API
ระดับเสียง
ระดับเสียงของอุปกรณ์หรือสตรีมสื่อ
เนมสเปซ
สื่อ
การแจกแจง
นโยบายการผนวกอัตโนมัติ
สตริง
นโยบายการเข้าร่วมอัตโนมัติจะกําหนดเวลาที่ SDK จะเชื่อมต่อแอปพลิเคชันผู้ส่งกับเซสชันที่มีอยู่โดยอัตโนมัติหลังจากการเริ่มต้น API
ค่า |
|
---|---|
แท็บและต้นทาง |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันในแท็บและต้นทางของหน้าเดียวกัน |
ต้นทางต้นทาง |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันและต้นทางหน้าเว็บเดียวกัน (โดยไม่คํานึงถึงแท็บ) |
หน้ากระดาษ |
สตริง ไม่มีการเชื่อมต่ออัตโนมัติ |
ความสามารถ
สตริง
ความสามารถที่อุปกรณ์ตัวรับรองรับ
ค่า |
|
---|---|
วิดีโอ |
สตริง ผู้รับรองรับเอาต์พุตวิดีโอ |
เสียง |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตเสียง |
วิดีโอ |
สตริง ตัวรับสัญญาณรองรับอินพุตวิดีโอ (กล้อง) |
เสียง |
สตริง ตัวรับสัญญาณรองรับอินพุตเสียง (ไมโครโฟน) |
หลายกลุ่ม |
สตริง ผู้รับแสดงถึงกลุ่มที่มีหลายโซน |
นโยบายการทํางานเริ่มต้น
สตริง
นโยบายการดําเนินการเริ่มต้นจะกําหนดเวลาที่ SDK จะสร้างเซสชันโดยอัตโนมัติหลังจากเริ่มต้น API และยังควบคุมการดําเนินการเริ่มต้นสําหรับแท็บในป๊อปอัปส่วนขยายด้วย
ค่า |
|
---|---|
สร้างเซสชัน |
สตริง หากแท็บที่มีการแคสต์แอปอยู่เมื่อ API เริ่มต้น SDK จะหยุดแคสต์แท็บและเปิดแอปโดยอัตโนมัติ ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แอป |
แคสต์ THIS_TAB |
สตริง ไม่มีการเรียกใช้อัตโนมัติหลังจากเริ่มต้น API แม้ว่าระบบจะแคสต์แท็บอยู่ก็ตาม ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แท็บ |
สถานะแอป
สตริง
สถานะที่เป็นไปได้ของแอปพลิเคชัน DIAL
ค่า |
|
---|---|
วิ่ง |
สตริง |
หยุดแล้ว |
สตริง |
ข้อผิดพลาด |
สตริง ไม่ได้เป็นส่วนหนึ่งของข้อมูลจําเพาะ ใช้เพื่อส่งสัญญาณข้อผิดพลาด |
รหัสข้อผิดพลาด
สตริง
ข้อผิดพลาดที่ SDK อาจแสดงผล
ค่า |
|
---|---|
ยกเลิก |
สตริง ผู้ใช้ยกเลิกการดําเนินการ |
หมดเวลา |
สตริง การดําเนินการหมดเวลา |
API_ยังไม่เริ่มต้น |
สตริง API ไม่ได้เริ่มต้น |
พารามิเตอร์ไม่ถูกต้อง |
สตริง พารามิเตอร์สําหรับการดําเนินการไม่ถูกต้อง |
EXTENSION_NOT_COMPATIABLE |
สตริง สคริปต์ API ใช้ไม่ได้กับส่วนขยาย Cast ที่ติดตั้ง |
ส่วนขยายไม่มี |
สตริง ส่วนขยาย Cast ไม่พร้อมใช้งาน |
ได้รับแล้ว |
สตริง ไม่มีผู้รับที่ใช้ได้กับคําขอเซสชัน |
ข้อผิดพลาดเกี่ยวกับเซสชัน |
สตริง สร้างเซสชันไม่ได้ หรือเซสชันไม่ถูกต้อง |
ข้อผิดพลาดของช่อง |
สตริง ช่องรับไม่ได้ไม่พร้อมใช้งาน |
ล้มเหลวเมื่อเล่นสื่อไม่สําเร็จ |
สตริง โหลดสื่อไม่สําเร็จ |
การกระทําของผู้รับ
สตริง
สิ่งที่ผู้ใช้ดําเนินการกับผู้รับในส่วนขยายได้ พารามิเตอร์เหล่านี้ใช้เพื่อแสดงการเปลี่ยน UI ของแอปพลิเคชันผู้ส่งก่อนที่การดําเนินการแคสต์จะเสร็จสมบูรณ์ (หรือล้มเหลว) ได้
ค่า |
|
---|---|
แคสต์ |
สตริง ผู้ใช้เลือกผู้รับที่มีความตั้งใจที่จะแคสต์ไปยังผู้รับด้วยแอปพลิเคชันผู้ส่ง ระบบอาจไม่รู้จักตัวตนที่แน่นอนของผู้รับ |
หยุด |
สตริง ผู้ใช้ขอหยุดเซสชันที่ทํางานอยู่ในฝั่งผู้รับ |
ความพร้อมให้บริการของผู้รับ
สตริง
อธิบายความพร้อมให้บริการของตัวรับการแคสต์
ค่า |
|
---|---|
พร้อมใช้งาน |
สตริง มีผู้รับอย่างน้อย 1 รายที่เข้ากันได้กับคําขอของเซสชัน |
ไม่พร้อมให้บริการ |
สตริง ไม่มีผู้รับ |
ประเภทผู้รับ
สตริง
ค่า |
|
---|---|
แคสต์ |
สตริง ตัวรับการแคสต์ เช่น Chromecast |
ดิจิทัล |
สตริง อุปกรณ์ DIAL เช่น สมาร์ททีวี |
Hangouts |
สตริง ออกไปเที่ยว |
กำหนดเอง |
สตริง ผู้รับที่กําหนดเองมีให้โดยไคลเอ็นต์ |
แพลตฟอร์มผู้ส่ง
สตริง
อธิบายแพลตฟอร์มแอปพลิเคชันผู้ส่ง
ค่า |
|
---|---|
Chrome |
สตริง |
iOS |
สตริง |
Android |
สตริง |
สถานะเซสชัน
สตริง
อธิบายสถานะของเซสชันการแคสต์ให้กับแอปพลิเคชันตัวรับ
ค่า |
|
---|---|
เชื่อมต่อแล้ว |
สตริง เซสชันจะเชื่อมต่อกับแอปพลิเคชันของผู้รับ |
ยกเลิกการเชื่อมต่อแล้ว |
สตริง ยกเลิกการเชื่อมต่อเซสชันกับแอปพลิเคชันของผู้รับแล้ว แอปพลิเคชันตัวรับอาจทํางานหรือไม่ก็ได้ |
หยุดแล้ว |
สตริง หยุดแอปพลิเคชันตัวรับแล้ว |
ประเภทการควบคุมระดับเสียง
สตริง
อธิบายประเภทของการควบคุมระดับเสียง
ค่า |
|
---|---|
การทํางานอัตโนมัติ |
สตริง ปรับระดับเสียงของอุปกรณ์แคสต์ได้ |
คงที่ |
สตริง ระดับเสียงของอุปกรณ์แคสต์คงที่และเปลี่ยนแปลงไม่ได้ |
ต้นฉบับ |
สตริง ตัวควบคุมระดับเสียงของระบบหลัก เช่น ระดับเสียงของอุปกรณ์ทีวีหรือเสียงจะมีการเปลี่ยนแปลง |
พร็อพเพอร์ตี้
นโยบายการผนวกอัตโนมัติ
สตริง
นโยบายการเข้าร่วมอัตโนมัติจะกําหนดเวลาที่ SDK จะเชื่อมต่อแอปพลิเคชันผู้ส่งกับเซสชันที่มีอยู่โดยอัตโนมัติหลังจากการเริ่มต้น API
ค่า |
|
---|---|
แท็บและต้นทาง |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันในแท็บและต้นทางของหน้าเดียวกัน |
ต้นทางต้นทาง |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันและต้นทางหน้าเว็บเดียวกัน (โดยไม่คํานึงถึงแท็บ) |
หน้ากระดาษ |
สตริง ไม่มีการเชื่อมต่ออัตโนมัติ |
ความสามารถ
สตริง
ความสามารถที่อุปกรณ์ตัวรับรองรับ
ค่า |
|
---|---|
วิดีโอ |
สตริง ผู้รับรองรับเอาต์พุตวิดีโอ |
เสียง |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตเสียง |
วิดีโอ |
สตริง ตัวรับสัญญาณรองรับอินพุตวิดีโอ (กล้อง) |
เสียง |
สตริง ตัวรับสัญญาณรองรับอินพุตเสียง (ไมโครโฟน) |
หลายกลุ่ม |
สตริง ผู้รับแสดงถึงกลุ่มที่มีหลายโซน |
นโยบายการทํางานเริ่มต้น
สตริง
นโยบายการดําเนินการเริ่มต้นจะกําหนดเวลาที่ SDK จะสร้างเซสชันโดยอัตโนมัติหลังจากเริ่มต้น API และยังควบคุมการดําเนินการเริ่มต้นสําหรับแท็บในป๊อปอัปส่วนขยายด้วย
ค่า |
|
---|---|
สร้างเซสชัน |
สตริง หากแท็บที่มีการแคสต์แอปอยู่เมื่อ API เริ่มต้น SDK จะหยุดแคสต์แท็บและเปิดแอปโดยอัตโนมัติ ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แอป |
แคสต์ THIS_TAB |
สตริง ไม่มีการเรียกใช้อัตโนมัติหลังจากเริ่มต้น API แม้ว่าระบบจะแคสต์แท็บอยู่ก็ตาม ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แท็บ |
สถานะแอป
สตริง
สถานะที่เป็นไปได้ของแอปพลิเคชัน DIAL
ค่า |
|
---|---|
วิ่ง |
สตริง |
หยุดแล้ว |
สตริง |
ข้อผิดพลาด |
สตริง ไม่ได้เป็นส่วนหนึ่งของข้อมูลจําเพาะ ใช้เพื่อส่งสัญญาณข้อผิดพลาด |
รหัสข้อผิดพลาด
สตริง
ข้อผิดพลาดที่ SDK อาจแสดงผล
ค่า |
|
---|---|
ยกเลิก |
สตริง ผู้ใช้ยกเลิกการดําเนินการ |
หมดเวลา |
สตริง การดําเนินการหมดเวลา |
API_ยังไม่เริ่มต้น |
สตริง API ไม่ได้เริ่มต้น |
พารามิเตอร์ไม่ถูกต้อง |
สตริง พารามิเตอร์สําหรับการดําเนินการไม่ถูกต้อง |
EXTENSION_NOT_COMPATIABLE |
สตริง สคริปต์ API ใช้ไม่ได้กับส่วนขยาย Cast ที่ติดตั้ง |
ส่วนขยายไม่มี |
สตริง ส่วนขยาย Cast ไม่พร้อมใช้งาน |
ได้รับแล้ว |
สตริง ไม่มีผู้รับที่ใช้ได้กับคําขอเซสชัน |
ข้อผิดพลาดเกี่ยวกับเซสชัน |
สตริง สร้างเซสชันไม่ได้ หรือเซสชันไม่ถูกต้อง |
ข้อผิดพลาดของช่อง |
สตริง ช่องรับไม่ได้ไม่พร้อมใช้งาน |
ล้มเหลวเมื่อเล่นสื่อไม่สําเร็จ |
สตริง โหลดสื่อไม่สําเร็จ |
พร้อมใช้งาน
บูลีน
แจ้งลูกค้าเพื่อตรวจสอบว่าได้โหลด API หรือไม่
การกระทําของผู้รับ
สตริง
สิ่งที่ผู้ใช้ดําเนินการกับผู้รับในส่วนขยายได้ พารามิเตอร์เหล่านี้ใช้เพื่อแสดงการเปลี่ยน UI ของแอปพลิเคชันผู้ส่งก่อนที่การดําเนินการแคสต์จะเสร็จสมบูรณ์ (หรือล้มเหลว) ได้
ค่า |
|
---|---|
แคสต์ |
สตริง ผู้ใช้เลือกผู้รับที่มีความตั้งใจที่จะแคสต์ไปยังผู้รับด้วยแอปพลิเคชันผู้ส่ง ระบบอาจไม่รู้จักตัวตนที่แน่นอนของผู้รับ |
หยุด |
สตริง ผู้ใช้ขอหยุดเซสชันที่ทํางานอยู่ในฝั่งผู้รับ |
ความพร้อมให้บริการของผู้รับ
สตริง
อธิบายความพร้อมให้บริการของตัวรับการแคสต์
ค่า |
|
---|---|
พร้อมใช้งาน |
สตริง มีผู้รับอย่างน้อย 1 รายที่เข้ากันได้กับคําขอของเซสชัน |
ไม่พร้อมให้บริการ |
สตริง ไม่มีผู้รับ |
ประเภทผู้รับ
สตริง
ค่า |
|
---|---|
แคสต์ |
สตริง ตัวรับการแคสต์ เช่น Chromecast |
ดิจิทัล |
สตริง อุปกรณ์ DIAL เช่น สมาร์ททีวี |
Hangouts |
สตริง ออกไปเที่ยว |
กำหนดเอง |
สตริง ผู้รับที่กําหนดเองมีให้โดยไคลเอ็นต์ |
แพลตฟอร์มผู้ส่ง
สตริง
อธิบายแพลตฟอร์มแอปพลิเคชันผู้ส่ง
ค่า |
|
---|---|
Chrome |
สตริง |
iOS |
สตริง |
Android |
สตริง |
สถานะเซสชัน
สตริง
อธิบายสถานะของเซสชันการแคสต์ให้กับแอปพลิเคชันตัวรับ
ค่า |
|
---|---|
เชื่อมต่อแล้ว |
สตริง เซสชันจะเชื่อมต่อกับแอปพลิเคชันของผู้รับ |
ยกเลิกการเชื่อมต่อแล้ว |
สตริง ยกเลิกการเชื่อมต่อเซสชันกับแอปพลิเคชันของผู้รับแล้ว แอปพลิเคชันตัวรับอาจทํางานหรือไม่ก็ได้ |
หยุดแล้ว |
สตริง หยุดแอปพลิเคชันตัวรับแล้ว |
หมดเวลา
chrome.cast.Timeout ที่ไม่เป็นค่าว่าง
ค่าระยะหมดเวลาเริ่มต้นเป็นมิลลิวินาทีสําหรับเมธอด API
เวอร์ชัน
อาร์เรย์จํานวนที่ไม่เป็นค่าว่าง
เวอร์ชัน API หมายเลขแรกคือเวอร์ชันหลัก และเวอร์ชันที่สองเป็นเวอร์ชันย่อย
ประเภทการควบคุมระดับเสียง
สตริง
อธิบายประเภทของการควบคุมระดับเสียง
ค่า |
|
---|---|
การทํางานอัตโนมัติ |
สตริง ปรับระดับเสียงของอุปกรณ์แคสต์ได้ |
คงที่ |
สตริง ระดับเสียงของอุปกรณ์แคสต์คงที่และเปลี่ยนแปลงไม่ได้ |
ต้นฉบับ |
สตริง ตัวควบคุมระดับเสียงของระบบหลัก เช่น ระดับเสียงของอุปกรณ์ทีวีหรือเสียงจะมีการเปลี่ยนแปลง |
วิธีการ
เพิ่มการกระทําrListener
addReceiverActionListener(ผู้ฟัง)
เพิ่มฟังก์ชัน Listener ที่จะมีการเรียกใช้เมื่อผู้ใช้ดําเนินการผ่าน UI เพื่อเริ่มหรือหยุดแคสต์ แอปพลิเคชันผู้ส่งใช้ส่วนนี้เพื่อแสดงการเปลี่ยนในอินเทอร์เฟซผู้ใช้ (เช่น หยุดสื่อที่กําลังเล่นอยู่ในเครื่องชั่วคราว) ก่อนที่การดําเนินการแคสต์จะเสร็จสิ้นหรือล้มเหลว
- ไม่รับประกันว่า Listener จะเรียกใช้และแอปพลิเคชันไม่ควรพึ่งพาให้ Listener ทํางานได้อย่างถูกต้อง
- ระบบจะส่ง Listener ให้กับตัวรับที่ดําเนินการอยู่ (หากมี) อย่างไรก็ตาม ระบบอาจไม่รู้จักผู้รับและจะส่งต่อค่าว่างแทน
- ระบบจะเรียกใช้ Listener โดยเร็วที่สุดหลังจากที่ผู้ใช้ดําเนินการแล้ว ควรเรียกใช้ก่อนแอปพลิเคชันจะได้รับแจ้งการเปลี่ยนแปลงสถานะที่เกิดขึ้นผ่าน API
หากใช้เฟรมเวิร์ก API ให้ใช้ cast.framework.CastContext#addEventListener แทน แล้วฟังเหตุการณ์ cast.framework.CastContextEventType#CAST_STATE_CHANGED
พารามิเตอร์ |
|
---|---|
Listener |
chrome.cast.ReceiverActionListener ฟังก์ชัน Listener ที่จะเพิ่ม อาร์กิวเมนต์แรกสําหรับผู้ฟังคือตัวรับที่ได้รับ อาร์กิวเมนต์ที่ 2 ของผู้ฟังคือการทํางานที่ขอ (ดู chrome.cast.ReceiverAction) ค่าต้องไม่เป็นค่าว่าง |
เริ่มต้น
เริ่มต้น(apiConfig, successCallback, errorCallback)
เริ่มต้น API โปรดทราบว่าระบบจะเรียกsuccessCallback และ errorCallback ทันทีที่ API เริ่มต้นเสร็จเรียบร้อยแล้ว ระบบอาจเรียกใช้ sessionListener และ ReceiverListener ได้ทุกเมื่อหลังจากนั้น และอาจมากกว่า 1 ครั้ง
หากใช้เฟรมเวิร์ก API ให้ใช้ cast.framework.CastContext#setOptions แทนฟังก์ชันนี้
พารามิเตอร์ |
|
---|---|
API การกําหนดค่า |
ออบเจ็กต์ที่มีพารามิเตอร์สําหรับเริ่มต้น API ค่าต้องไม่เป็นค่าว่าง |
เรียกกลับสําเร็จ |
ฟังก์ชัน() |
errorCallback |
ฟังก์ชัน(ไม่เป็นค่าว่าง chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, invalid_PARAMETER, EXTENSION_MISSING |
ข้อความบันทึก
logMessage(ข้อความ)
บันทึกข้อความการแก้ไขข้อบกพร่องจากแอป ระบบอาจส่งข้อความนี้ในรายงานความคิดเห็นไปยัง Google หากผู้ใช้เลือกรวมบันทึกอย่างละเอียดอย่างชัดเจน
พารามิเตอร์ |
|
---|---|
ข้อความ |
สตริง ข้อความที่จะบันทึก |
- เลิกใช้
- ไม่รองรับ SDK ของ งานนําเสนอใน API การนําเสนอ
แคชล่วงหน้า
แคชล่วงหน้า(ข้อมูล)
ส่งคําขอเพื่อแคชข้อมูลล่วงหน้า หากเชื่อมต่อเซสชันแล้ว ระบบจะส่งคําขอโดยตรง ไม่เช่นนั้นระบบจะส่งคําขอไปยังอุปกรณ์ทุกเครื่องในเครือข่าย
พารามิเตอร์ |
|
---|---|
ข้อมูล |
สตริง ข้อมูลที่จะแคชล่วงหน้า |
นํา ReceiverActionListener ออก
removeReceiverActionListener(ผู้ฟัง)
นําฟังก์ชัน Listener ที่เพิ่มไว้ก่อนหน้านี้ด้วย addRecipientrActionListener ออก
พารามิเตอร์ |
|
---|---|
Listener |
chrome.cast.ReceiverActionListener ฟังก์ชัน Listener ที่จะนําออก ค่าต้องไม่เป็นค่าว่าง |
เซสชันคําขอ
requestSession(successCallback, errorCallback, คําขอเซสชัน)
คําขอที่มีการสร้างหรือเข้าร่วมเซสชันผู้รับ โดยค่าเริ่มต้น ระบบจะใช้เซสชันคําขอที่ส่งไปยัง API ณ เวลาที่เริ่มต้น ซึ่งอาจลบล้างได้โดยส่งคําขอเซสชันอื่นใน sessionRequest
หากใช้เฟรมเวิร์ก API ให้ใช้ cast.framework.CastContext#requestSession แทนฟังก์ชันนี้
พารามิเตอร์ |
|
---|---|
เรียกกลับสําเร็จ |
ฟังก์ชัน(ไม่เป็นค่าว่าง chrome.cast.Session) |
errorCallback |
ฟังก์ชัน(ไม่เป็นค่าว่าง chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, invalid_PARAMETER, API_NOT_INITIALIZED, ยกเลิก, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE และ EXTENSION_MISSING โปรดทราบว่าตัวจับเวลาจะหมดเวลาหลังจากที่ผู้ใช้เลือกผู้รับ การเลือกผู้รับต้องมีการดําเนินการของผู้ใช้ แต่ไม่มีระยะหมดเวลา หากคําขอเซสชันอยู่ระหว่างดําเนินการอยู่แล้ว ErrorCallback จะถูกเรียกใช้ด้วยรหัสข้อผิดพลาด invalid_PARAMETER และคําอธิบายที่อธิบายข้อผิดพลาด |
คําขอเซสชัน |
ไม่บังคับ ค่าต้องไม่เป็นค่าว่าง |
requestSessionById
requestSessionById(รหัสเซสชัน)
คําขอเข้าร่วมเซสชันที่มีอยู่กับรหัสที่ระบุ เมื่อเข้าร่วมแล้ว ระบบจะส่งเซสชันไปยัง sessionListener ที่กําหนดโดย chrome.cast.initialize
หากทราบเซสชันที่มี sessionId แล้วเมื่อมีการเรียกใช้ฟังก์ชันนี้ ระบบจะเรียก sessionListener ทันที มิเช่นนั้น เมื่อมีการพบเซสชันที่มี sessionId ที่ระบุไว้ ระบบจะเรียกใช้ sessionListener
พารามิเตอร์ |
|
---|---|
รหัสเซสชัน |
สตริง รหัสของเซสชันที่จะเข้าร่วม |
กําหนดผู้รับที่กําหนดเอง
setCustomReceivers(ผู้รับ, การเรียกกลับที่สําเร็จ, errorCallback)
ตั้งค่ารายการผู้รับที่กําหนดเอง
พารามิเตอร์ |
|
---|---|
ผู้รับ |
อาร์เรย์ของ chrome.cast.Receiver ที่ไม่เป็นค่าว่าง รายการใหม่ ค่าต้องไม่เป็นค่าว่าง |
เรียกกลับสําเร็จ |
ฟังก์ชัน() |
errorCallback |
ฟังก์ชัน(ไม่เป็นค่าว่าง chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, invalid_PARAMETER, CHANNEL_ERROR และ EXTENSION_MISSRING |
- เลิกใช้
- ไม่รองรับ SDK ของ งานนําเสนอใน API การนําเสนอ
ตั้งค่าบริบทของหน้า
setPageContext(ชนะ)
เริ่มต้นฟังก์ชัน Cast สําหรับหน้าเว็บที่โหลด Cast SDK ใน iframe ควรเรียกใช้หลังจากที่ SDK เริ่มต้น
พารามิเตอร์ |
|
---|---|
ชนะ |
หน้าต่าง ออบเจ็กต์หน้าต่างหน้า ค่าต้องไม่เป็นค่าว่าง |
กําหนดสถานะผู้รับ
setReceiverDisplayStatus(ตัวรับ, การติดต่อกลับที่สําเร็จ, errorCallback)
ตั้งชื่อผู้รับและสถานะการแสดงผล หากต้องการแสดงผู้รับเป็นไม่มีการใช้งาน ให้ตั้งค่า DisplayStatus เป็น Null
ใช้ได้เฉพาะกับผู้รับที่กําหนดเองเท่านั้น ระบบจะละเว้น DisplayStatus ของผู้รับหากตัวรับการแคสต์เป็น "แคสต์" แอปพลิเคชันของผู้รับจะได้รับการอัปเดตสถานะการแคสต์
พารามิเตอร์ |
|
---|---|
ผู้รับ |
ผู้รับเสียง ค่าต้องไม่เป็นค่าว่าง |
เรียกกลับสําเร็จ |
ฟังก์ชัน() โทรกลับเมื่อตั้งค่าสถานะสําเร็จ |
errorCallback |
ฟังก์ชัน(ไม่เป็นค่าว่าง chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, invalid_PARAMETER, API_NOT_INITIALIZED และ EXTENSION_MISSING |
- เลิกใช้
- ไม่รองรับ SDK ของ งานนําเสนอใน API การนําเสนอ
ไม่ใช้ Escape
สตริงหลีก(กําหนดเป็นอักขระหลีก)
วิธียูทิลิตีเพื่อหลบสตริงที่ใช้อักขระหลีกกับ URI เช่น ชื่อง่ายสําหรับผู้รับจะส่งคืนเป็นสตริงที่มีอักขระหลีกเป็น URI ใช้วิธีการนี้เพื่อเลิกซ่อนสตริงดังกล่าวหากจําเป็น
พารามิเตอร์ |
|
---|---|
ใช้ Escape |
สตริง สตริงสําหรับอักขระหลีก |
- การคืนสินค้า
-
string
สตริงที่ไม่ใช้ Escape
ประเภทนามธรรม
ReceiverActionListener
ReceiverActionListener()