คลาส: CastReceiverContext

cast.เฟรมเวิร์กCastReceiverContext

class   static

จัดการการโหลดไลบรารีที่สำคัญและเริ่มต้น SDK ของอุปกรณ์รับการแคสต์พื้นฐาน

การขว้าง

non-null Error หากไม่ได้สร้าง MediaElement ในเนื้อหาเอกสาร หากมีการสร้างองค์ประกอบสื่อหลายรายการ นักพัฒนาซอฟต์แวร์ควรตั้งค่าคลาส "castMediaElement" เป็นคลาสใดองค์ประกอบหนึ่ง ซึ่งตัวรับ CAF จะใช้

วิธีการ

getInstance

คงที่

getInstance() returns cast.framework.CastReceiverContext

แสดงผลอินสแตนซ์เดี่ยวของ CastReceiverContext

การคืนสินค้า

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

ตั้งค่าการฟังข้อความสำหรับช่องทางข้อความที่กำหนดเอง อนุญาตให้มี Listener มากกว่า 1 ตัวสำหรับเนมสเปซ

พารามิเตอร์

เนมสเปซ

สตริง

Namespace โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนำหน้าด้วยสตริง "urn:x-cast:"

Listener

function(non-null cast.framework.system.Message)
การขว้าง

Error หากระบบไม่พร้อมใช้งานหรือแอปพลิเคชันนี้ไม่รองรับเนมสเปซ

addEventListener

addEventListener(type, handler)

เพิ่ม Listener เพื่อแคสต์เหตุการณ์ของระบบ

พารามิเตอร์

ประเภท

cast.framework.system.EventType

ค่าต้องไม่เป็นค่าว่าง

ตัวแฮนเดิล

function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

ตรวจสอบว่าแพลตฟอร์มรองรับพารามิเตอร์สื่อของสตรีมวิดีโอหรือเสียงที่ระบุหรือไม่

พารามิเตอร์

mimeType

สตริง

ประเภท MIME ของสื่อ ซึ่งประกอบด้วยประเภทและประเภทย่อยที่คั่นด้วย "/" โดยอาจเป็นประเภท MIME ที่เป็นวิดีโอหรือเสียงก็ได้

ตัวแปลงรหัส

ไม่บังคับ

สตริง

สตริงที่ยกมามีรายการรูปแบบที่คั่นด้วยคอมมา โดยแต่ละรูปแบบจะระบุประเภทตัวอย่างสื่อที่ปรากฏในสตรีม

ความกว้าง

ไม่บังคับ

ตัวเลข

อธิบายความละเอียดแนวนอนของสตรีมเป็นพิกเซล

ส่วนสูง

ไม่บังคับ

ตัวเลข

อธิบายความละเอียดแนวตั้งของสตรีมเป็นพิกเซล

อัตราเฟรม

ไม่บังคับ

ตัวเลข

อธิบายอัตราเฟรมของสตรีม
การคืนสินค้า

boolean หากสตรีมเล่นใน Chromecast ได้

getApplicationData

getApplicationData() จะแสดงผล cast.framework.system.ApplicationData

ระบุข้อมูลแอปพลิเคชันเมื่อระบบพร้อมแล้ว มิเช่นนั้นจะเป็น Null

การคืนสินค้า

nullable cast.framework.system.ApplicationData ข้อมูลแอปพลิเคชันหรือ Null หากระบบยังไม่พร้อม

getDeviceCapabilities

getDeviceCapabilities() แสดงผลออบเจ็กต์

ระบุข้อมูลความสามารถของอุปกรณ์เมื่อระบบพร้อมใช้งาน มิเช่นนั้นจะเป็น Null หากแสดงผลออบเจ็กต์ที่ว่างเปล่า อุปกรณ์จะไม่แสดงข้อมูลความสามารถใดๆ

การคืนสินค้า

nullable Object ข้อมูลความสามารถของอุปกรณ์ (คู่คีย์/ค่า) ซึ่งจะเป็น Null หากระบบยังไม่พร้อม ออบเจ็กต์ดังกล่าวอาจเป็นออบเจ็กต์ที่ว่างเปล่าหากแพลตฟอร์มไม่เปิดเผยข้อมูลความสามารถของอุปกรณ์

getPlayerManager

getPlayerManager() แสดงผล cast.framework.PlayerManager

รับอินสแตนซ์โปรแกรมเล่นที่ควบคุมและตรวจสอบการเล่นสื่อได้

การคืนสินค้า

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) แสดงผล cast.framework.system.Sender

ดูผู้ส่งตามรหัสผู้ส่ง

พารามิเตอร์

senderId

สตริง

รหัสของผู้ส่งที่จะส่งคืน
การคืนสินค้า

nullable cast.framework.system.Sender 

getSenders

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

getSystemState() returns cast.framework.system.SystemState

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

การคืนสินค้า

non-null cast.framework.system.SystemState สถานะของระบบ

getVisibilityState

getVisibilityState() แสดงผล cast.framework.system.VisibilityState

รายงานว่าแอปพลิเคชันแคสต์เป็นอินพุต HDMI ที่ใช้งานได้

การคืนสินค้า

non-null cast.framework.system.VisibilityState แอปพลิเคชันเป็นอินพุตแบบ HDMI ที่ใช้งานได้หรือไม่ หากไม่สามารถระบุได้เนื่องจากทีวีไม่รองรับคำสั่ง CEC เช่น ค่าที่แสดงผลคือ "ไม่ทราบ"

isSystemReady

isSystemReady() จะแสดงผลบูลีน

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

การคืนสินค้า

boolean ระบุว่าระบบพร้อมที่จะประมวลผลข้อความหรือไม่

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

เริ่มโหลด Player js ซึ่งอาจใช้เพื่อเริ่มโหลดโค้ด JavaScript ของโปรแกรมเล่นในช่วงเริ่มต้นของการเริ่มรีซีฟเวอร์ก่อนที่จะเรียกใช้โค้ด ฟังก์ชันนี้จะไม่ดำเนินการหากโหลดผู้เล่นไว้แล้ว (โดยจะเรียกเริ่ม)

พารามิเตอร์

useLegacyDashSupport

ไม่บังคับ

boolean

ระบุว่าควรใช้ MPL สำหรับเนื้อหา DASH

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

นำ Listener ข้อความที่ลงทะเบียนกับ CastReceiverContext#addCustomMessageListener ออก

พารามิเตอร์

เนมสเปซ

สตริง

Namespace โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนำหน้าด้วยสตริง "urn:x-cast:"

Listener

function(non-null cast.framework.system.Message)

ฟังก์ชัน Listener ข้อความเพื่อยกเลิกการลงทะเบียน
การขว้าง

Error หากระบบไม่พร้อมใช้งานหรือแอปพลิเคชันนี้ไม่รองรับเนมสเปซ

removeEventListener

removeEventListener(type, handler)

นำ Listener ออกเพื่อแคสต์เหตุการณ์ของระบบ

พารามิเตอร์

ประเภท

cast.framework.system.EventType

ค่าต้องไม่เป็นค่าว่าง

ตัวแฮนเดิล

function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

ส่งข้อความไปยังผู้ส่งที่ระบุ

พารามิเตอร์

เนมสเปซ

สตริง

Namespace โปรดทราบว่าเนมสเปซที่ถูกต้องจะต้องนำหน้าด้วยสตริง "urn:x-cast:"

senderId

(สตริงหรือไม่ระบุ)

"SenderId" หรือ "ไม่ได้กำหนดสำหรับการประกาศ" ไปยังผู้ส่งทุกคน

ข้อมูล

ประเภทใดก็ได้

เพย์โหลดของข้อความ

ค่าต้องไม่เป็นค่าว่าง
การขว้าง

Error หากมีข้อผิดพลาดในการเตรียมข้อความ

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

ควรเรียกใช้ฟังก์ชันนี้เพื่อตอบสนองต่อเหตุการณ์ feedbackstarted หากแอปพลิเคชันเพิ่มข้อมูลสถานะแก้ไขข้อบกพร่องลงในรายงานความคิดเห็น โดยจะใช้พารามิเตอร์ "message" ที่เป็นสตริงที่แสดงข้อมูลการแก้ไขข้อบกพร่องที่แอปพลิเคชันต้องการบันทึก

พารามิเตอร์

feedbackMessage

สตริง
เลิกใช้
ใช้ Cast.framework.CastReceiverContext#setfeedbackHandler

setApplicationState

setApplicationState(statusText)

ตั้งค่าสถานะแอปพลิเคชัน แอปพลิเคชันควรเรียกใช้เมื่อมีการเปลี่ยนแปลงสถานะ หากไม่ได้กำหนดหรือตั้งค่าเป็นสตริงว่างเปล่า ระบบจะใช้ค่าของชื่อแอปพลิเคชันที่สร้างขึ้นระหว่างการลงทะเบียนแอปพลิเคชันสำหรับสถานะของแอปพลิเคชันโดยค่าเริ่มต้น

พารามิเตอร์

statusText

สตริง

ข้อความสถานะ

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

ตั้งค่าเครื่องจัดการเพื่อให้ข้อมูลเพิ่มเติมในรายงานความคิดเห็น ระบบจะเรียกใช้เครื่องจัดการเมื่อมีการสร้างความคิดเห็นที่รายงาน และควรแสดงผลข้อมูลเพิ่มเติมเป็นสตริงหรือสตริงสัญญา ควรระบุการคืนสินค้าภายใน 5 วินาทีเพื่อให้ปรากฏในรายงาน

พารามิเตอร์

feedbackHandler

ฟังก์ชัน()

ค่าอาจเป็น Null

setInactivityTimeout

setInactivityTimeout(maxInactivity)

กำหนดระยะหมดเวลาเมื่อไม่มีการใช้งานตัวรับสัญญาณ ขอแนะนำให้กำหนดค่าการไม่ใช้งานสูงสุดเมื่อเรียกใช้ Start และไม่ต้องทำการเปลี่ยนแปลงใดๆ API นี้มีไว้เพื่อการพัฒนา/แก้ไขข้อบกพร่องเท่านั้น

พารามิเตอร์

maxInactivity

ตัวเลข

ช่วงเวลาเป็นวินาทีก่อนปิดการเชื่อมต่อที่ไม่ตอบสนอง

setLoggerLevel

setLoggerLevel(level)

ตั้งค่าระดับการอธิบายบันทึก

พารามิเตอร์

ระดับ

cast.framework.LoggerLevel

ระดับการบันทึก

ค่าต้องไม่เป็นค่าว่าง

เริ่มต้น

start(ตัวเลือก) จะแสดงผล cast.framework.CastReceiverContext

เริ่มต้นตัวจัดการระบบและตัวจัดการสื่อ เพื่อให้แอปผู้รับสามารถ รับคำขอจากผู้ส่งได้

พารามิเตอร์

ตัวเลือก

(cast.framework.CastReceiverOptions หรือออบเจ็กต์ที่ไม่บังคับที่ไม่ใช่ Null)
การคืนสินค้า

non-null cast.framework.CastReceiverContext 

แวะพัก

หยุด()

ปิดแอปพลิเคชันตัวรับสัญญาณ