คลาส: CastReceiverContext

cast.framework.CastReceiverContext

class   static

จัดการการโหลดไลบรารีที่เกี่ยวข้องและเริ่มต้น SDK ของตัวรับสัญญาณ Cast ที่เกี่ยวข้อง

ส่ง

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

เมธอด

getInstance

static

getInstance() แสดงผลเป็น cast.framework.CastReceiverContext

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

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

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

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

พารามิเตอร์

เนมสเปซ

สตริง

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

Listener

function(non-null cast.framework.system.Message)
ส่ง

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

addEventListener

addEventListener(type, handler)

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

พารามิเตอร์

ประเภท

cast.framework.system.EventType

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

ตัวแฮนเดิล

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

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) แสดงผลเป็นบูลีน

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

พารามิเตอร์

mimeType

สตริง

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

ตัวแปลงรหัส

ไม่บังคับ

สตริง

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

ความกว้าง

ไม่บังคับ

ตัวเลข

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

ความสูง

ไม่บังคับ

ตัวเลข

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

framerate

ไม่บังคับ

ตัวเลข

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

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

getApplicationData

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

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

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

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

getDeviceCapabilities

getDeviceCapabilities() แสดงผล cast.framework.system.DeviceCapabilitiesObj

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

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

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

getDeviceInformation

getDeviceInformation() แสดงผล cast.framework.system.DeviceInformationObj

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

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

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

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() แสดงผลเป็นบูลีน

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

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

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

เริ่มโหลด JS ของเพลเยอร์ ซึ่งสามารถใช้เพื่อเริ่มโหลดโค้ด JS ของเพลเยอร์ในระยะเริ่มต้นของการเริ่มตัวรับสัญญาณก่อนที่จะเรียกใช้ start ฟังก์ชันนี้จะไม่มีผลหากโหลดโปรแกรมเล่นแล้ว (มีการเรียกใช้ start)

พารามิเตอร์

useLegacyDashSupport

ไม่บังคับ

บูลีน

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

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

นำ 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 หรือไม่ได้กำหนดไว้สำหรับการออกอากาศไปยังผู้ส่งทั้งหมด

เพิ่มเติม

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

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

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

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

พารามิเตอร์

feedbackMessage

สตริง
เลิกใช้
ใช้ cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

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

พารามิเตอร์

statusText

สตริง

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

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

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

พารามิเตอร์

feedbackHandler

function()

ค่าอาจเป็น Null

setInactivityTimeout

setInactivityTimeout(maxInactivity)

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

พารามิเตอร์

maxInactivity

ตัวเลข

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

setLoggerLevel

setLoggerLevel(level)

ตั้งค่าระดับการพูดรายละเอียดของบันทึก

พารามิเตอร์

ระดับ

cast.framework.LoggerLevel

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

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

start

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

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

พารามิเตอร์

ตัวเลือก

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

non-null cast.framework.CastReceiverContext 

หยุด

stop(closeReason)

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

พารามิเตอร์

closeReason

ไม่บังคับ

cast.framework.common.CloseReason

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

  • 13 (APP_CUSTOM_STOP): สำหรับ UI ของตัวรับที่กำหนดเอง/การดำเนินการทางธุรกิจ (เช่น ผู้ใช้คลิกปุ่ม "ออก" หรือ "ปิด" ในแอป การไปยังส่วนต่างๆ ของตัวรับที่กำหนดเองซึ่งไม่ใช่การแคสต์)
  • 15 (APP_ERROR): ข้อผิดพลาดร้ายแรงระดับแอปพลิเคชัน (เช่น การตรวจสอบสิทธิ์ที่กำหนดเองไม่สำเร็จ, การดึงข้อมูล DRM/ใบอนุญาตไม่สำเร็จ, API แบ็กเอนด์ขัดข้อง) ที่เกิดขึ้นนอกเหตุการณ์ข้อผิดพลาดของเพลเยอร์ในตัวของ CAF
  • 14 (APP_PLAYBACK_FINISHED): แอปใช้เพลย์ลิสต์/คิวจนหมดหรือประสบการณ์การใช้งานสื่อแบบสแตนด์อโลนเสร็จสมบูรณ์
  • 6 (APP_REQUEST): การทำงานสำรองทั่วไป/เดิมเมื่อแอปพลิเคชันขอสิ้นสุดการทำงานโดยไม่มีเหตุผลที่เจาะจงมากกว่านี้

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