chrome.
นี่คือเนมสเปซ chrome.cast
คลาส
ApiConfig
เก็บการกำหนดค่าสำหรับ API เมื่อเริ่มต้น
CredentialsData
ข้อมูลเข้าสู่ระบบที่ใช้เพื่อระบุข้อมูลเข้าสู่ระบบของผู้ส่ง
DialRequest
คำขอเพื่อเริ่มแอป DIAL
ข้อผิดพลาด
อธิบายข้อผิดพลาดที่ API แสดงผล โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
รูปภาพ
อิมเมจที่อธิบายแอปพลิเคชันตัวรับสัญญาณหรือรายการสื่อ ซึ่งอาจเป็นไอคอนแอปพลิเคชัน ภาพหน้าปก หรือภาพขนาดย่อ
ผู้รับ
อธิบายรีซีฟเวอร์ที่เรียกใช้แอปพลิเคชัน โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
ReceiverDisplayStatus
สถานะผู้รับที่แสดงให้ผู้ใช้เห็นใน UI ของส่วนขยาย ใช้ได้เฉพาะกับผู้รับ CUSTOM รายการ
SenderApplication
อธิบายแอปพลิเคชันของผู้ส่ง โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
เซสชัน
อธิบายสถานะของแอปพลิเคชัน Cast ที่ทำงานอยู่ในปัจจุบัน โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
SessionRequest
คำขอเริ่มหรือเชื่อมต่อกับเซสชัน
หมดเวลา
กำหนดค่าระยะหมดเวลาเริ่มต้นเป็นมิลลิวินาทีสำหรับเมธอด API
ระดับเสียง
ระดับเสียงของอุปกรณ์หรือสตรีมสื่อ
เนมสเปซ
สื่อ
การแจกแจง
AutoJoinPolicy
สตริง
นโยบายการเข้าร่วมอัตโนมัติจะกำหนดว่า SDK จะเชื่อมต่อแอปพลิเคชันของผู้ส่งกับเซสชันที่มีอยู่โดยอัตโนมัติเมื่อใดหลังจากการเริ่มต้น API
ค่า |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันในแท็บและต้นทางของหน้าเดียวกัน |
|
ORIGIN_SCOPED |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันและต้นทางของหน้าเดียวกัน (โดยไม่คำนึงถึงแท็บ) |
|
PAGE_SCOPED |
สตริง ไม่มีการเชื่อมต่ออัตโนมัติ |
ความสามารถ
สตริง
ความสามารถที่อุปกรณ์ตัวรับรองรับ
ค่า |
|
|---|---|
|
VIDEO_OUT |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตวิดีโอ |
|
AUDIO_OUT |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตเสียง |
|
VIDEO_IN |
สตริง ตัวรับสัญญาณรองรับอินพุตวิดีโอ (กล้อง) |
|
AUDIO_IN |
สตริง ตัวรับสัญญาณรองรับอินพุตเสียง (ไมโครโฟน) |
|
MULTIZONE_GROUP |
สตริง รีซีฟเวอร์จะเป็นตัวแทนของกลุ่มมัลติโซน |
DefaultActionPolicy
สตริง
นโยบายการดำเนินการเริ่มต้นจะกำหนดว่า SDK จะสร้างเซสชันโดยอัตโนมัติเมื่อใดหลังจากเริ่มต้น API การดำเนินการนี้ยังควบคุมการดำเนินการเริ่มต้นสำหรับแท็บในป๊อปอัปส่วนขยายด้วย
ค่า |
|
|---|---|
|
CREATE_SESSION |
สตริง หากระบบกำลังแคสต์แท็บที่มีแอปอยู่เมื่อ API เริ่มต้นการทำงาน SDK จะหยุดแคสต์แท็บและเปิดแอปโดยอัตโนมัติ ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แอป |
|
CAST_THIS_TAB |
สตริง ระบบจะไม่เปิดอัตโนมัติหลังจากเริ่มต้น API แม้ว่าจะกำลังแคสต์แท็บก็ตาม ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แท็บ |
DialAppState
สตริง
สถานะที่เป็นไปได้ของแอปพลิเคชัน DIAL
ค่า |
|
|---|---|
|
ทำงาน |
สตริง |
|
หยุดแล้ว |
สตริง |
|
ข้อผิดพลาด |
สตริง ไม่ใช่ส่วนหนึ่งของข้อกำหนด ใช้เพื่อส่งสัญญาณข้อผิดพลาด |
ErrorCode
สตริง
ข้อผิดพลาดที่ SDK อาจส่งคืน
ค่า |
|
|---|---|
|
ยกเลิก |
สตริง ผู้ใช้ยกเลิกการดำเนินการ |
|
หมดเวลา |
สตริง หมดเวลาการดำเนินการ |
|
API_NOT_INITIALIZED |
สตริง API จะไม่เริ่มต้น |
|
INVALID_PARAMETER |
สตริง พารามิเตอร์ไปยังการดำเนินการไม่ถูกต้อง |
|
EXTENSION_NOT_COMPATIBLE |
สตริง สคริปต์ API ใช้งานร่วมกับส่วนขยาย Cast ที่ติดตั้งไม่ได้ |
|
EXTENSION_MISSING |
สตริง ส่วนขยาย Cast ไม่พร้อมใช้งาน |
|
RECEIVER_UNAVAILABLE |
สตริง ไม่มีตัวรับที่เข้ากันได้กับคำขอเซสชัน |
|
SESSION_ERROR |
สตริง ไม่สามารถสร้างเซสชัน หรือเซสชันไม่ถูกต้อง |
|
CHANNEL_ERROR |
สตริง ช่องสำหรับผู้รับไม่พร้อมให้บริการ |
|
LOAD_MEDIA_FAILED |
สตริง การโหลดสื่อล้มเหลว |
ReceiverAction
สตริง
การดำเนินการที่ผู้ใช้ดำเนินการกับผู้รับในส่วนขยายได้ ซึ่งอาจใช้เพื่อแสดงการเปลี่ยนใน UI ของแอปพลิเคชันของผู้ส่งก่อนที่การดำเนินการแคสต์จะเสร็จสมบูรณ์ (หรือล้มเหลว)
ค่า |
|
|---|---|
|
CAST |
สตริง ผู้ใช้เลือกผู้รับโดยตั้งใจจะแคสต์ไปยังผู้รับด้วยแอปพลิเคชันของผู้ส่ง อาจไม่ทราบข้อมูลระบุตัวตนที่แน่ชัดของผู้รับ |
|
หยุด |
สตริง ผู้ใช้ขอให้หยุดเซสชันที่ทำงานบนตัวรับ |
ReceiverAvailability
สตริง
อธิบายความพร้อมใช้งานของเครื่องรับการแคสต์
ค่า |
|
|---|---|
|
มีให้บริการ |
สตริง มีตัวรับสัญญาณอย่างน้อย 1 ตัวที่เข้ากันได้กับคำขอเซสชัน |
|
ไม่พร้อมให้บริการ |
สตริง ไม่มีรีซีฟเวอร์ที่พร้อมใช้งาน |
ReceiverType
สตริง
ค่า |
|
|---|---|
|
CAST |
สตริง อุปกรณ์รับการแคสต์ เช่น Chromecast |
|
โทรออก |
สตริง อุปกรณ์ที่ใช้โทร เช่น สมาร์ททีวี |
|
Hangouts |
สตริง ออกไปเที่ยว |
|
กำหนดเอง |
สตริง รีซีฟเวอร์ที่กำหนดเองโดยไคลเอ็นต์ |
SenderPlatform
สตริง
อธิบายแพลตฟอร์มแอปพลิเคชันของผู้ส่ง
ค่า |
|
|---|---|
|
Chrome |
สตริง |
|
iOS |
สตริง |
|
ANDROID |
สตริง |
SessionStatus
สตริง
อธิบายสถานะของเซสชันการแคสต์แก่แอปพลิเคชันตัวรับสัญญาณ
ค่า |
|
|---|---|
|
เชื่อมต่อแล้ว |
สตริง เซสชันเชื่อมต่อกับแอปพลิเคชันฝั่งผู้รับ |
|
ยกเลิกการเชื่อมต่อแล้ว |
สตริง เซสชันถูกตัดการเชื่อมต่อจากแอปพลิเคชันฝั่งผู้รับ แอปพลิเคชันผู้รับอาจจะกำลังทำงานอยู่หรือไม่ |
|
หยุดแล้ว |
สตริง หยุดแอปพลิเคชันฝั่งผู้รับแล้ว |
VolumeControlType
สตริง
อธิบายประเภทของการควบคุมระดับเสียง
ค่า |
|
|---|---|
|
การเข้าร่วม |
สตริง ระดับเสียงของอุปกรณ์แคสต์เปลี่ยนแปลงได้ |
|
แก้ไขแล้ว |
สตริง ระดับเสียงของอุปกรณ์แคสต์คงที่และเปลี่ยนแปลงไม่ได้ |
|
มาสเตอร์ |
สตริง การควบคุมระดับเสียงของระบบหลัก เช่น ระดับเสียงของทีวีหรืออุปกรณ์เสียงมีการเปลี่ยนแปลง |
พร็อพเพอร์ตี้
AutoJoinPolicy
สตริง
นโยบายการเข้าร่วมอัตโนมัติจะกำหนดว่า SDK จะเชื่อมต่อแอปพลิเคชันของผู้ส่งกับเซสชันที่มีอยู่โดยอัตโนมัติเมื่อใดหลังจากการเริ่มต้น API
ค่า |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันในแท็บและต้นทางของหน้าเดียวกัน |
|
ORIGIN_SCOPED |
สตริง เชื่อมต่อโดยอัตโนมัติเมื่อเซสชันเริ่มต้นด้วย appId เดียวกันและต้นทางของหน้าเดียวกัน (โดยไม่คำนึงถึงแท็บ) |
|
PAGE_SCOPED |
สตริง ไม่มีการเชื่อมต่ออัตโนมัติ |
ความสามารถ
สตริง
ความสามารถที่อุปกรณ์ตัวรับรองรับ
ค่า |
|
|---|---|
|
VIDEO_OUT |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตวิดีโอ |
|
AUDIO_OUT |
สตริง ตัวรับสัญญาณรองรับเอาต์พุตเสียง |
|
VIDEO_IN |
สตริง ตัวรับสัญญาณรองรับอินพุตวิดีโอ (กล้อง) |
|
AUDIO_IN |
สตริง ตัวรับสัญญาณรองรับอินพุตเสียง (ไมโครโฟน) |
|
MULTIZONE_GROUP |
สตริง รีซีฟเวอร์จะเป็นตัวแทนของกลุ่มมัลติโซน |
DefaultActionPolicy
สตริง
นโยบายการดำเนินการเริ่มต้นจะกำหนดว่า SDK จะสร้างเซสชันโดยอัตโนมัติเมื่อใดหลังจากเริ่มต้น API การดำเนินการนี้ยังควบคุมการดำเนินการเริ่มต้นสำหรับแท็บในป๊อปอัปส่วนขยายด้วย
ค่า |
|
|---|---|
|
CREATE_SESSION |
สตริง หากระบบกำลังแคสต์แท็บที่มีแอปอยู่เมื่อ API เริ่มต้นการทำงาน SDK จะหยุดแคสต์แท็บและเปิดแอปโดยอัตโนมัติ ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แอป |
|
CAST_THIS_TAB |
สตริง ระบบจะไม่เปิดอัตโนมัติหลังจากเริ่มต้น API แม้ว่าจะกำลังแคสต์แท็บก็ตาม ป๊อปอัปส่วนขยายจะแจ้งให้ผู้ใช้แคสต์แท็บ |
DialAppState
สตริง
สถานะที่เป็นไปได้ของแอปพลิเคชัน DIAL
ค่า |
|
|---|---|
|
ทำงาน |
สตริง |
|
หยุดแล้ว |
สตริง |
|
ข้อผิดพลาด |
สตริง ไม่ใช่ส่วนหนึ่งของข้อกำหนด ใช้เพื่อส่งสัญญาณข้อผิดพลาด |
ErrorCode
สตริง
ข้อผิดพลาดที่ SDK อาจส่งคืน
ค่า |
|
|---|---|
|
ยกเลิก |
สตริง ผู้ใช้ยกเลิกการดำเนินการ |
|
หมดเวลา |
สตริง หมดเวลาการดำเนินการ |
|
API_NOT_INITIALIZED |
สตริง API จะไม่เริ่มต้น |
|
INVALID_PARAMETER |
สตริง พารามิเตอร์ไปยังการดำเนินการไม่ถูกต้อง |
|
EXTENSION_NOT_COMPATIBLE |
สตริง สคริปต์ API ใช้งานร่วมกับส่วนขยาย Cast ที่ติดตั้งไม่ได้ |
|
EXTENSION_MISSING |
สตริง ส่วนขยาย Cast ไม่พร้อมใช้งาน |
|
RECEIVER_UNAVAILABLE |
สตริง ไม่มีตัวรับที่เข้ากันได้กับคำขอเซสชัน |
|
SESSION_ERROR |
สตริง ไม่สามารถสร้างเซสชัน หรือเซสชันไม่ถูกต้อง |
|
CHANNEL_ERROR |
สตริง ช่องสำหรับผู้รับไม่พร้อมให้บริการ |
|
LOAD_MEDIA_FAILED |
สตริง การโหลดสื่อล้มเหลว |
isAvailable
boolean
แจ้งให้ลูกค้าทราบเพื่อตรวจสอบว่า API โหลดหรือไม่
ReceiverAction
สตริง
การดำเนินการที่ผู้ใช้ดำเนินการกับผู้รับในส่วนขยายได้ ซึ่งอาจใช้เพื่อแสดงการเปลี่ยนใน UI ของแอปพลิเคชันของผู้ส่งก่อนที่การดำเนินการแคสต์จะเสร็จสมบูรณ์ (หรือล้มเหลว)
ค่า |
|
|---|---|
|
CAST |
สตริง ผู้ใช้เลือกผู้รับโดยตั้งใจจะแคสต์ไปยังผู้รับด้วยแอปพลิเคชันของผู้ส่ง อาจไม่ทราบข้อมูลระบุตัวตนที่แน่ชัดของผู้รับ |
|
หยุด |
สตริง ผู้ใช้ขอให้หยุดเซสชันที่ทำงานบนตัวรับ |
ReceiverAvailability
สตริง
อธิบายความพร้อมใช้งานของเครื่องรับการแคสต์
ค่า |
|
|---|---|
|
มีให้บริการ |
สตริง มีตัวรับสัญญาณอย่างน้อย 1 ตัวที่เข้ากันได้กับคำขอเซสชัน |
|
ไม่พร้อมให้บริการ |
สตริง ไม่มีรีซีฟเวอร์ที่พร้อมใช้งาน |
ReceiverType
สตริง
ค่า |
|
|---|---|
|
CAST |
สตริง อุปกรณ์รับการแคสต์ เช่น Chromecast |
|
โทรออก |
สตริง อุปกรณ์ที่ใช้โทร เช่น สมาร์ททีวี |
|
Hangouts |
สตริง ออกไปเที่ยว |
|
กำหนดเอง |
สตริง รีซีฟเวอร์ที่กำหนดเองโดยไคลเอ็นต์ |
SenderPlatform
สตริง
อธิบายแพลตฟอร์มแอปพลิเคชันของผู้ส่ง
ค่า |
|
|---|---|
|
Chrome |
สตริง |
|
iOS |
สตริง |
|
ANDROID |
สตริง |
SessionStatus
สตริง
อธิบายสถานะของเซสชันการแคสต์แก่แอปพลิเคชันตัวรับสัญญาณ
ค่า |
|
|---|---|
|
เชื่อมต่อแล้ว |
สตริง เซสชันเชื่อมต่อกับแอปพลิเคชันฝั่งผู้รับ |
|
ยกเลิกการเชื่อมต่อแล้ว |
สตริง เซสชันถูกตัดการเชื่อมต่อจากแอปพลิเคชันฝั่งผู้รับ แอปพลิเคชันผู้รับอาจจะกำลังทำงานอยู่หรือไม่ |
|
หยุดแล้ว |
สตริง หยุดแอปพลิเคชันฝั่งผู้รับแล้ว |
เวลานอก
chrome.cast.Timeout ที่ไม่เป็นค่าว่าง
ค่าระยะหมดเวลาเริ่มต้นเป็นมิลลิวินาทีสำหรับเมธอด API
เวอร์ชัน
อาร์เรย์ของตัวเลขที่ไม่เป็นค่าว่าง
เวอร์ชันของ API หมายเลขแรกคือหมายเลขหลัก และหมายเลขรองที่ 2
VolumeControlType
สตริง
อธิบายประเภทของการควบคุมระดับเสียง
ค่า |
|
|---|---|
|
การเข้าร่วม |
สตริง ระดับเสียงของอุปกรณ์แคสต์เปลี่ยนแปลงได้ |
|
แก้ไขแล้ว |
สตริง ระดับเสียงของอุปกรณ์แคสต์คงที่และเปลี่ยนแปลงไม่ได้ |
|
มาสเตอร์ |
สตริง การควบคุมระดับเสียงของระบบหลัก เช่น ระดับเสียงของทีวีหรืออุปกรณ์เสียงมีการเปลี่ยนแปลง |
วิธีการ
addReceiverActionListener
addReceiverActionListener(listener)
เพิ่มฟังก์ชัน Listener ที่จะเรียกใช้เมื่อผู้ใช้ดำเนินการผ่าน UI เพื่อเริ่มหรือหยุดแคสต์ แอปพลิเคชันของผู้ส่งอาจใช้วิธีนี้เพื่อแสดงการเปลี่ยนแปลงในอินเทอร์เฟซผู้ใช้ (เช่น หยุดสื่อที่เล่นในเครื่องชั่วคราว) ก่อนที่การแคสต์จะเสร็จสิ้นหรือล้มเหลว
- ทั้งนี้ เราไม่รับประกันว่า Listener จะเรียกใช้ และแอปพลิเคชันไม่ควรใช้ Listener เพื่อให้ทำงานได้อย่างถูกต้อง
- ระบบจะส่งผู้ฟังที่ได้รับการดำเนินการ (หากมี) แต่ผู้รับอาจไม่รู้จักและระบบจะส่ง Null แทน
- ระบบจะเรียก Listener โดยเร็วที่สุดหลังจากที่ผู้ใช้ดำเนินการแล้ว ควรมีการเรียกใช้โค้ดก่อนที่แอปพลิเคชันจะได้รับแจ้งเกี่ยวกับการเปลี่ยนแปลงสถานะที่เกิดขึ้นผ่าน API
หากใช้ Framework API ให้ใช้ cast.framework.CastContext#addEventListener แทน และฟังเหตุการณ์ Cast.framework.CastContextEventType#CAST_STATE_CHANGED
พารามิเตอร์ |
|
|---|---|
|
Listener |
chrome.cast.ReceiverActionListener ฟังก์ชัน Listener ที่จะเพิ่ม อาร์กิวเมนต์แรกสำหรับผู้ฟังคือรีซีฟเวอร์ที่ได้รับการดำเนินการ อาร์กิวเมนต์ที่ 2 ของ Listener คือการดำเนินการที่ขอ (ดู chrome.cast.ReceiverAction) ค่าต้องไม่เป็นค่าว่าง |
initialize
เริ่มต้น(apiConfig, successCallback, errorCallback)
เริ่มต้น API โปรดทราบว่าจะมีการเรียกใช้ successCallback และ errorCallback เมื่อ API เริ่มต้นทำงานเสร็จแล้ว อาจมีการเรียกใช้ sessionListener และ ReceiverListener ภายหลังได้ทุกเมื่อและอาจมากกว่า 1 ครั้ง
หากใช้ Framework API ให้ใช้ cast.framework.CastContext#setOptions แทนฟังก์ชันนี้
พารามิเตอร์ |
|
|---|---|
|
apiConfig |
ออบเจ็กต์ที่มีพารามิเตอร์เพื่อเริ่มต้น API ค่าต้องไม่เป็นค่าว่าง |
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING |
logMessage
logMessage(message)
บันทึกข้อความการแก้ไขข้อบกพร่องจากแอป อาจมีการส่งข้อความนี้ในรายงานความคิดเห็นถึง Google หากผู้ใช้เลือกใส่บันทึกแบบละเอียดอย่างชัดแจ้ง
พารามิเตอร์ |
|
|---|---|
|
ข้อความ |
สตริง ข้อความที่จะบันทึก |
- เลิกใช้
- ไม่รองรับ Cast SDK ที่อิงตาม Presentation API
แคชล่วงหน้า
แคชล่วงหน้า(ข้อมูล)
ส่งคำขอเพื่อแคชข้อมูลล่วงหน้า หากมีการเชื่อมต่อเซสชัน ก็จะส่งคำขอโดยตรง ไม่เช่นนั้นก็จะส่งคำขอไปยังอุปกรณ์ทั้งหมดในเครือข่าย
พารามิเตอร์ |
|
|---|---|
|
ข้อมูล |
สตริง ข้อมูลที่จะแคชล่วงหน้า |
- เลิกใช้
- ไม่รองรับ
removeReceiverActionListener
removeReceiverActionListener(listener)
นำฟังก์ชัน Listener ที่เพิ่มไว้ก่อนหน้านี้ด้วย addReceiverActionListener ออก
พารามิเตอร์ |
|
|---|---|
|
Listener |
chrome.cast.ReceiverActionListener ฟังก์ชัน Listener ที่จะนำออก ค่าต้องไม่เป็นค่าว่าง |
requestSession
requestSession(successCallback, errorCallback, sessionRequest)
คำขอเพื่อสร้างหรือเข้าร่วมเซสชันแอปพลิเคชันของผู้รับ โดยค่าเริ่มต้น ระบบจะใช้ SessionRequest ที่ส่งผ่านไปยัง API ในเวลาเริ่มต้น ซึ่งอาจลบล้างได้โดยการส่งคำขอเซสชันอื่นใน sessionRequest
หากใช้ Framework API ให้ใช้ cast.framework.CastContext#requestSession แทนฟังก์ชันนี้
พารามิเตอร์ |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.Session) |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE และ EXTENSION_MISSING โปรดทราบว่าตัวจับเวลาการหมดเวลาจะเริ่มต้นหลังจากที่ผู้ใช้เลือกรีซีฟเวอร์ ผู้ใช้ต้องดำเนินการเลือกตัวรับสัญญาณ ซึ่งจะไม่มีการหมดเวลา หากคำขอเซสชันอยู่ระหว่างดำเนินการ ระบบจะเรียกใช้ errorCallback พร้อมรหัสข้อผิดพลาด INVALID_PARAMETER และคำอธิบายที่อธิบายข้อผิดพลาด |
|
sessionRequest |
ไม่บังคับ ค่าต้องไม่เป็นค่าว่าง |
requestSessionById
requestSessionById(sessionId)
คำขอเข้าร่วมเซสชันที่มีอยู่ที่มีรหัสที่ระบุ เมื่อเข้าร่วมแล้ว ระบบจะส่งเซสชันไปยัง sessionListener ที่ตั้งค่าโดย chrome.cast.initialize
หากทราบเซสชันที่มี sessionId ที่ระบุอยู่แล้วเมื่อมีการเรียกใช้ฟังก์ชันนี้ ระบบจะเรียกใช้ sessionListener ทันที มิเช่นนั้น เมื่อระบบพบเซสชันที่มี sessionId ที่กำหนด ระบบจะเรียกใช้ sessionListener
พารามิเตอร์ |
|
|---|---|
|
sessionId |
สตริง รหัสของเซสชันที่จะเข้าร่วม |
setCustomReceivers
setCustomReceivers(receivers, successCallback, errorCallback)
ตั้งค่ารายการผู้รับที่กำหนดเอง
พารามิเตอร์ |
|
|---|---|
|
รีซีฟเวอร์ |
อาร์เรย์ของ chrome.cast.Receiver ที่ไม่มีค่า Null รายการใหม่ ค่าต้องไม่เป็นค่าว่าง |
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR และ EXTENSION_MISSRING |
- เลิกใช้
- ไม่รองรับ Cast SDK ที่อิงตาม Presentation API
setPageContext
setPageContext(win)
เริ่มต้นฟังก์ชันแคสต์สำหรับหน้าเว็บที่โหลด Cast SDK ใน iframe ควรเรียกใช้หลังจากเริ่มต้น SDK
พารามิเตอร์ |
|
|---|---|
|
ชนะ |
หน้าต่าง ออบเจ็กต์หน้าต่างของหน้า ค่าต้องไม่เป็นค่าว่าง |
setReceiverDisplayStatus
setReceiverDisplayStatus(receiver, successCallback, errorCallback)
ตั้งชื่อผู้รับและสถานะที่แสดง หากต้องการแสดงผู้รับว่าไม่ได้ใช้งาน ให้ตั้งค่า displayStatus เป็น Null
ใช้ได้เฉพาะกับผู้รับ CUSTOM รายการ ระบบจะไม่สนใจ displayStatus ของผู้รับหากตัวรับนี้เป็น CAST และแอปจะอัปเดตสถานะเครื่องรับการแคสต์
พารามิเตอร์ |
|
|---|---|
|
ผู้รับ |
ผู้รับ ค่าต้องไม่เป็นค่าว่าง |
|
successCallback |
ฟังก์ชัน() ติดต่อกลับเมื่อตั้งสถานะสำเร็จ |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED และ EXTENSION_MISSING |
- เลิกใช้
- ไม่รองรับ Cast SDK ที่อิงตาม Presentation API
unescape
unEscape(ใช้ Escape) แสดงสตริง
เมธอดของยูทิลิตีในการยกเลิกการหลีกสตริงที่กำหนดเป็นอักขระหลีก URI เช่น ระบบแสดงชื่อที่จดจำง่ายของฝั่งผู้รับเป็นสตริงที่ Escape URI ใช้วิธีนี้เพื่อยกเลิกการกำหนดเป็นอักขระหลีกสตริงนั้นหากจำเป็น
พารามิเตอร์ |
|
|---|---|
|
หลบหนี |
สตริง สตริงสำหรับยกเลิกการกำหนดเป็นอักขระหลีก |
- การคืนสินค้า
-
stringสตริงที่ไม่ใช้ Escape
ประเภทภาพแอบสแตรก
ReceiverActionListener
ReceiverActionListener()