คลาส: CastReceiverContext

cast.framework.CastReceiverContext

class   static

จัดการการโหลดไลบรารีพื้นฐานและเริ่มต้น SDK ของตัวรับ Cast พื้นฐาน

การขว้าง

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

เมธอด

getInstance

คงที่

getInstance() แสดงผล cast.framework.CastReceiverContext

แสดงผลอินสแตนซ์ Singleton ของ CastReceiverContext

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

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

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

พารามิเตอร์

เนมสเปซ

สตริง

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

Listener

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

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

addEventListener

addEventListener(type, handler)

เพิ่ม Listener สำหรับเหตุการณ์ของระบบ Cast

พารามิเตอร์

ประเภท

cast.framework.system.EventType

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

ตัวแฮนเดิล

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

canDisplayType

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

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

พารามิเตอร์

mimeType

สตริง

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

ตัวแปลงรหัส

ไม่บังคับ

สตริง

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

ความกว้าง

ไม่บังคับ

ตัวเลข

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

ส่วนสูง

ไม่บังคับ

ตัวเลข

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

framerate

ไม่บังคับ

ตัวเลข

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

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

getApplicationData

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

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

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

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

getDeviceCapabilities

getDeviceCapabilities() จะแสดงผล cast.receiver.CastReceiverManager.DeviceCapabilitiesObj

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

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

nullable cast.receiver.CastReceiverManager.DeviceCapabilitiesObj ข้อมูลความสามารถของอุปกรณ์ (คู่คีย์/ค่า) โดยจะเป็นค่าว่างหาก ระบบยังไม่พร้อม ซึ่งอาจเป็นออบเจ็กต์ว่างหากแพลตฟอร์ม ไม่แสดงข้อมูลความสามารถของอุปกรณ์

getDeviceInformation

getDeviceInformation() จะแสดงผล cast.receiver.CastReceiverManager.DeviceInformationObj

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

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

nullable cast.receiver.CastReceiverManager.DeviceInformationObj ข้อมูลอุปกรณ์ (คู่คีย์/ค่า) โดยจะเป็นค่าว่างหากระบบยังไม่พร้อม อาจเป็นออบเจ็กต์ว่างหากแพลตฟอร์มไม่แสดงข้อมูลนี้

getPlayerManager

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

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

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

non-null cast.framework.PlayerManager 

getSender

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

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

พารามิเตอร์

senderId

สตริง

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

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null 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 เช่น ค่าที่แสดงคือ UNKNOWN

getSystemState

getSystemState() จะแสดงผล 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 เช่น ค่าที่ส่งคืนคือ UNKNOWN

isSystemReady

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

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

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

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

เริ่มโหลด js ของเพลเยอร์ ใช้เพื่อเริ่มโหลดโค้ด js ของเพลเยอร์ในระยะแรกของการเริ่มต้นตัวรับก่อนเรียกใช้ start ฟังก์ชันนี้จะไม่มีผลหากโหลดเพลเยอร์แล้ว (มีการเรียกใช้ start)

พารามิเตอร์

useLegacyDashSupport

ไม่บังคับ

บูลีน

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

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

นำเครื่องฟังสัญญาณข้อความที่ลงทะเบียนไว้ก่อนหน้านี้ด้วย CastReceiverContext#addCustomMessageListener ออก

พารามิเตอร์

เนมสเปซ

สตริง

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

Listener

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

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

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

removeEventListener

removeEventListener(type, handler)

นำ Listener ออกเพื่อส่งกิจกรรมของระบบ

พารามิเตอร์

ประเภท

cast.framework.system.EventType

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

ตัวแฮนเดิล

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

ส่งข้อความถึงผู้ส่งที่เฉพาะเจาะจง

พารามิเตอร์

เนมสเปซ

สตริง

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

senderId

(สตริงหรือไม่ได้กำหนด)

senderId หรือ undefined สำหรับการออกอากาศ ไปยังผู้ส่งทั้งหมด

เพิ่มเติม

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

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

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

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

พารามิเตอร์

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

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

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

start

start(options) จะแสดงผล cast.framework.CastReceiverContext

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

พารามิเตอร์

ตัวเลือก

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

non-null cast.framework.CastReceiverContext 

แวะพัก

stop()

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