cast. frameCastReceiverContext
จัดการการโหลดไลบรารีที่เกี่ยวข้องและเริ่มต้น SDK ตัวรับการแคสต์ เริ่มต้น
- ผ้าคลุม
-
non-null Error
หากไม่ได้สร้าง MediaElement ในเนื้อหาของเอกสาร หากมีการสร้างองค์ประกอบสื่อหลายรายการ นักพัฒนาซอฟต์แวร์ควรตั้งค่าคลาส "castMediaElement" เป็นองค์ประกอบใดองค์ประกอบหนึ่ง ซึ่งเป็นตัวรับ CAF ที่จะใช้
วิธีการ
รับอินสแตนซ์
getInstance() แสดงผล cast.framework.CastReceiverContext
แสดงผลอินสแตนซ์ CastReceiverContext เดี่ยว
- การคืนสินค้า
-
non-null cast.framework.CastReceiverContext
addCustomMessageListener
addCustomMessageListener(เนมสเปซ, Listener)
ตั้งค่าการฟังข้อความในช่องข้อความที่กําหนดเอง
พารามิเตอร์ |
|
---|---|
เนมสเปซ |
สตริง เนมสเปซ โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนําหน้าด้วยสตริง "urn:x-cast:" |
Listener |
function(non-null cast.framework.system.Event) |
- ผ้าคลุม
-
Error
หากระบบไม่พร้อมใช้งานหรือแอปพลิเคชันนี้ไม่รองรับเนมสเปซ
เพิ่ม Listener เหตุการณ์
addEventListener(ประเภท, เครื่องจัดการ)
เพิ่ม Listener เพื่อแคสต์เหตุการณ์ในระบบ
พารามิเตอร์ |
|
---|---|
ประเภท |
cast.framework.system.EventType ค่าต้องไม่เป็นค่าว่าง |
เครื่องจัดการ |
function(non-null cast.framework.system.Event) |
ประเภทดิสเพลย์
canDisplayType(mimeType, codecs, width, height, framerate) แสดงค่าบูลีน
ตรวจสอบว่าพารามิเตอร์สื่อของสตรีมวิดีโอหรือเสียงรองรับแพลตฟอร์มหรือไม่
พารามิเตอร์ |
|
---|---|
ประเภท MIME |
สตริง ประเภท MIME ของสื่อ รายการที่ประกอบไปด้วยประเภทและประเภทย่อยที่คั่นด้วย "/" อาจเป็นประเภทวิดีโอหรือ Mime ก็ได้ |
ตัวแปลงรหัส |
ไม่บังคับ สตริง สตริงที่ใส่เครื่องหมายคําพูดจะมีรายการรูปแบบที่คั่นด้วยเครื่องหมายจุลภาค ซึ่งแต่ละรูปแบบจะระบุประเภทตัวอย่างสื่อที่แสดงอยู่ในสตรีม |
ความกว้าง |
ไม่บังคับ หมายเลข อธิบายความละเอียดแนวนอนของสตรีมเป็นพิกเซล |
ส่วนสูง |
ไม่บังคับ หมายเลข อธิบายความละเอียดของแนวตั้งของสตรีมเป็นพิกเซล |
อัตราเฟรม |
ไม่บังคับ หมายเลข อธิบายอัตราเฟรมของสตรีม |
- การคืนสินค้า
-
boolean
หากสตรีมเล่นใน Chromecast ได้
รับข้อมูลแอปพลิเคชัน
getApplicationData() แสดงผล cast.framework.system.ApplicationData
ระบุข้อมูลแอปพลิเคชันเมื่อระบบพร้อมใช้งาน มิเช่นนั้นจะเป็น Null
- การคืนสินค้า
-
nullable cast.framework.system.ApplicationData
ข้อมูลแอปพลิเคชันหรือไม่มีข้อมูลหากระบบไม่พร้อมใช้งาน
รับความสามารถของอุปกรณ์
getDeviceCapabilities() จะส่งคืนออบเจ็กต์
ให้ข้อมูลความสามารถของอุปกรณ์เมื่อระบบพร้อมใช้งาน มิฉะนั้นจะเป็นค่าว่าง หากมีการส่งคืนออบเจ็กต์ที่ว่างเปล่า อุปกรณ์จะไม่เปิดเผยข้อมูลความสามารถ
- การคืนสินค้า
-
nullable Object
ข้อมูลความสามารถของอุปกรณ์ (คู่คีย์/ค่า) และจะเป็นค่าว่างหากระบบยังไม่พร้อม ออบเจ็กต์อาจจะเป็นว่างเปล่าหากแพลตฟอร์มไม่ได้เปิดเผยข้อมูลความสามารถของอุปกรณ์ใดๆ
ตัวจัดการ getPlayer
getPlayerManager() แสดงผล cast.framework.PlayerManager
รับอินสแตนซ์โปรแกรมเล่นที่ควบคุมและตรวจสอบการเล่นสื่อได้
- การคืนสินค้า
-
non-null cast.framework.PlayerManager
รับผู้ส่ง
getSender(senderId) แสดงผล cast.framework.system.Sender
รับผู้ส่งตามรหัสผู้ส่ง
พารามิเตอร์ |
|
---|---|
รหัสผู้ส่ง |
สตริง รหัสของผู้ส่งที่จะส่งคืน |
- การคืนสินค้า
-
nullable cast.framework.system.Sender
รับผู้ส่ง
getSenders() แสดงผลอาร์เรย์ของ cast.framework.system.Sender ที่ไม่เป็นค่าว่าง
รับรายชื่อผู้ส่งที่เชื่อมต่ออยู่
- การคืนสินค้า
-
non-null Array of non-null cast.framework.system.Sender
getStandbyState
getStandbyState() แสดงผล cast.framework.system.StandbyState
รายงานว่าอินพุต HDMI ของแอปพลิเคชันแคสต์อยู่ในโหมดสแตนด์บายไหม
- การคืนสินค้า
-
non-null cast.framework.system.StandbyState
อินพุตของ HDMI ของแอปพลิเคชันอยู่ในโหมดสแตนด์บายหรือไม่ หากระบุไม่ได้เนื่องจากทีวีไม่รองรับคําสั่ง CEC เช่น ค่าที่แสดงผลเป็น "ไม่ทราบ"
รับระบบ
getSystemState() แสดงผล cast.framework.system.SystemState
ระบุข้อมูลแอปพลิเคชันเกี่ยวกับสถานะระบบ
- การคืนสินค้า
-
non-null cast.framework.system.SystemState
สถานะของระบบ
รับสถานะการเปิดเผย
getVisibilityState() แสดงผล cast.framework.system.VisibilityState
รายงานว่าแอปพลิเคชันแคสต์เป็นอินพุต HDMI ที่ใช้งานอยู่
- การคืนสินค้า
-
non-null cast.framework.system.VisibilityState
แอปพลิเคชันเป็นอินพุต HDMI ที่ใช้งานอยู่หรือไม่ หากระบุไม่ได้เนื่องจากทีวีไม่รองรับคําสั่ง CEC เช่น ค่าที่แสดงผลไม่ทราบ
isSystemReady
isSystemReady() แสดงผลบูลีน
เมื่อการเรียกแอปพลิเคชันเริ่มต้น ระบบจะส่งเหตุการณ์ที่พร้อมใช้งานเพื่อระบุว่าข้อมูลแอปพลิเคชันพร้อมใช้งาน และแอปพลิเคชันสามารถส่งข้อความได้ทันทีที่มีผู้ส่ง 1 รายเชื่อมต่ออยู่
- การคืนสินค้า
-
boolean
ระบบพร้อมประมวลผลข้อความหรือไม่
ไลบรารีการโหลด Player
loadPlayerLibraries(useLegacyDashSupport)
เริ่มโหลด js ของโปรแกรมเล่น ซึ่งใช้เพื่อเริ่มโหลดโค้ด js ของโปรแกรมเล่นได้ในระยะเริ่มต้นการเริ่มรับตัวเรียกใช้งานก่อนเริ่มเรียก ฟังก์ชันนี้จะเป็น "ไม่มีการดําเนินการ" หากโหลดโปรแกรมเล่นไว้แล้ว (มีการเรียกใช้การเริ่มต้น)
พารามิเตอร์ |
|
---|---|
ใช้LegacyDashSupport |
ไม่บังคับ บูลีน ระบุว่าควรใช้ MPL สําหรับเนื้อหา DASH |
ลบข้อความที่กําหนดเอง
removeCustomMessageListener(namespace, Listener)
นํา Listener ข้อความออกในช่องข้อความที่กําหนดเอง
พารามิเตอร์ |
|
---|---|
เนมสเปซ |
สตริง เนมสเปซ โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนําหน้าด้วยสตริง "urn:x-cast:" |
Listener |
function(non-null cast.framework.system.Event) |
- ผ้าคลุม
-
Error
หากระบบไม่พร้อมใช้งานหรือแอปพลิเคชันนี้ไม่รองรับเนมสเปซ
removeEventListener
removeEventListener(ประเภท, เครื่องจัดการ)
นํา Listener ออกเพื่อแคสต์เหตุการณ์ในระบบ
พารามิเตอร์ |
|
---|---|
ประเภท |
cast.framework.system.EventType ค่าต้องไม่เป็นค่าว่าง |
เครื่องจัดการ |
function(non-null cast.framework.system.Event) |
ส่งข้อความที่กําหนดเอง
sendCustomMessage(namespace, senderId, message)
ส่งข้อความไปยังผู้ส่งที่ต้องการ
พารามิเตอร์ |
|
---|---|
เนมสเปซ |
สตริง เนมสเปซ โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนําหน้าด้วยสตริง "urn:x-cast:" |
รหัสผู้ส่ง |
(สตริงหรือไม่ได้ระบุ) ของผู้ส่งId หรือไม่ได้รับการกําหนดให้เผยแพร่ไปยังผู้ส่งทั้งหมด |
ข้อความ |
ประเภทใดก็ได้ ข้อความ ค่าต้องไม่เป็นค่าว่าง |
- ผ้าคลุม
-
Error
หากมีข้อผิดพลาดในการเตรียมข้อความ
ส่งความคิดเห็น
sendFeedbackMessage(feedbackMessage)
ควรเรียกใช้ฟังก์ชันนี้เพื่อตอบสนองต่อเหตุการณ์ feedbackstart หากแอปพลิเคชันเพิ่มข้อมูลสถานะการแก้ไขข้อบกพร่องลงในรายงานความคิดเห็น โดยจะใช้พารามิเตอร์ "message" ที่เป็นสตริงซึ่งแสดงข้อมูลการแก้ไขข้อบกพร่องที่แอปพลิเคชันต้องการบันทึก
พารามิเตอร์ |
|
---|---|
ข้อความความคิดเห็น |
สตริง |
- เลิกใช้
- ใช้ cast.framework.CastReceiverContext#setFeedbackHandler
ตั้งค่าแอปพลิเคชันแอปพลิเคชัน
setApplicationState(statusText)
ตั้งค่าสถานะแอปพลิเคชัน แอปพลิเคชันควรเรียกใช้ไฟล์นี้เมื่อมีการเปลี่ยนแปลงสถานะ หากไม่มีการกําหนดหรือตั้งค่าเป็นสตริงว่าง ระบบจะใช้ค่าของชื่อแอปพลิเคชันที่สร้างขึ้นระหว่างการลงทะเบียนแอปพลิเคชันสําหรับสถานะแอปพลิเคชันโดยค่าเริ่มต้น
พารามิเตอร์ |
|
---|---|
ข้อความสถานะ |
สตริง ข้อความสถานะ |
setHandleHandler
setFeedbackHandler(feedbackHandler)
ตั้งค่าเครื่องจัดการเพื่อให้ข้อมูลเพิ่มเติมในรายงานความคิดเห็น ระบบจะเรียกใช้เครื่องจัดการเมื่อมีการสร้างความคิดเห็นที่รายงานและควรแสดงข้อมูลเพิ่มเติมเป็นสตริงหรือคําสัญญาสตริง คุณควรแก้ไขสัญญาการคืนสินค้าภายใน 5 วินาทีเพื่อให้รายงานรวมอยู่ในรายงาน
พารามิเตอร์ |
|
---|---|
เครื่องจัดการความคิดเห็น |
function() ค่าอาจเป็นค่าว่าง |
setInactivity หมดเวลา
setInactivityTimeout(maxInactivity)
ตั้งค่าระยะหมดเวลาเมื่อไม่ได้ใช้งานตัวรับสัญญาณ ขอแนะนําให้ตั้งค่าจํานวนไม่มีการใช้งานสูงสุดเมื่อเรียกใช้ "เริ่มต้น" และไม่ได้ทําการเปลี่ยนแปลง API นี้ใช้สําหรับการพัฒนา/การแก้ไขข้อบกพร่อง
พารามิเตอร์ |
|
---|---|
ไม่มีการใช้งานสูงสุด |
หมายเลข ช่วงเวลาเป็นวินาทีก่อนปิดการเชื่อมต่อที่ไม่ตอบสนอง |
ตั้งค่าระดับการบันทึก
setLoggerLevel(ระดับ)
ตั้งค่าระดับการบันทึกรายละเอียดบันทึก
พารามิเตอร์ |
|
---|---|
ระดับ |
ระดับการบันทึก ค่าต้องไม่เป็นค่าว่าง |
เริ่มต้น
start(options) แสดงผล cast.framework.CastReceiverContext
เริ่มต้นโปรแกรมจัดการระบบและโปรแกรมจัดการสื่อเพื่อให้แอปของผู้รับได้รับคําขอจากผู้ส่งได้
พารามิเตอร์ |
|
---|---|
ตัวเลือก |
(ไม่บังคับ ใช้ cast.framework.CastReceiverOptions หรือออบเจ็กต์ที่ไม่ใช่ Null) |
- การคืนสินค้า
-
non-null cast.framework.CastReceiverContext
หยุด
หยุด()
ปิดแอปพลิเคชันตัวรับสัญญาณ