ชั้นเรียน: CastSession

ผู้ผลิต

CastSession

ใหม่ CastSession(sessionObj, สถานะ)

พารามิเตอร์

sessionObj

chrome.cast.Session

ข้อมูลเซสชัน

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

state

cast.framework.SessionState

สถานะเซสชัน

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

วิธีการ

addEventListener

addEventListener(type, handler)

เพิ่ม Listener เหตุการณ์

พารามิเตอร์

ประเภท

cast.framework.SessionEventType

ประเภทของกิจกรรม

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

ตัวแฮนเดิล

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

addMessageListener

addMessageListener(namespace, listener)

เพิ่ม Listener ที่ถูกเรียกใช้เมื่อได้รับข้อความจาก แอปพลิเคชันตัวรับ ระบบจะเรียกใช้ Listener พร้อมเนมสเปซเป็นอาร์กิวเมนต์แรก และข้อความเป็นอาร์กิวเมนต์ที่ 2

พารามิเตอร์

เนมสเปซ

สตริง

เนมสเปซที่จะฟัง เช่น "urn:x-cast:com.example.namespace"

Listener

ฟังก์ชัน(สตริง, สตริง)

Listener ที่จะเพิ่ม

endSession

endSession(stopCasting)

สิ้นสุดเซสชันปัจจุบัน

พารามิเตอร์

stopCasting

boolean

ควรหยุดแอปพลิเคชันฝั่งผู้รับเมื่อสิ้นสุดเซสชันปัจจุบันหรือไม่

getActiveInputState

getActiveInputState() แสดงผล cast.framework.ActiveInputState

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

non-null cast.framework.ActiveInputState สถานะอินพุตที่ใช้งานอยู่ของผู้รับ

getApplicationMetadata

getApplicationMetadata() จะแสดงผล cast.framework.ApplicationMetadata

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

non-null cast.framework.ApplicationMetadata ข้อมูลเมตาของแอปพลิเคชัน

getApplicationStatus

getApplicationStatus() จะแสดงผลสตริง

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

nullable string สตริงสถานะแอปพลิเคชัน

getCastDevice

getCastDevice() แสดงผล chrome.cast.Receiver

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

non-null chrome.cast.Receiver ข้อมูลเมตาของอุปกรณ์แคสต์

getMediaSession

getMediaSession() แสดงผล chrome.cast.media.Media

แสดงผลเซสชันสื่อปัจจุบัน หากมี

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

nullable chrome.cast.media.Media เซสชันสื่อปัจจุบัน

getSessionId

getSessionId() แสดงผลสตริง

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

string รหัสที่ไม่ซ้ำกันสำหรับเซสชันนี้

getSessionObj

getSessionObj() แสดงผล chrome.cast.Session

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

non-null chrome.cast.Session ข้อมูลเซสชัน

getSessionState

getSessionState() แสดงผล cast.framework.SessionState

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

cast.framework.SessionState สถานะเซสชันปัจจุบัน

getVolume

getVolume() แสดงผลจำนวน

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

nullable number ระดับเสียงตัวรับ (หากมี)

isMute

isMute() แสดงบูลีน

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

nullable boolean สถานะปิดเสียงของผู้รับ (หากมี)

loadMedia

loadMedia(loadRequest) แสดงคำสัญญาที่มี chrome.cast.ErrorCode ที่เป็นค่าว่างได้

โหลดสื่อลงในแอปพลิเคชันตัวรับสัญญาณที่ทำงานอยู่

พารามิเตอร์

loadRequest

chrome.cast.media.LoadRequest

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

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

non-null Promise containing nullable chrome.cast.ErrorCode สัญญาว่าจะส่งโหลดไปยังผู้รับได้สำเร็จหรือล้มเหลว (เซสชันส่งผ่านไปยังเหตุการณ์ media_session)

removeEventListener

removeEventListener(type, handler)

นำ Listener เหตุการณ์ออก

พารามิเตอร์

ประเภท

cast.framework.SessionEventType

ประเภทของกิจกรรม

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

ตัวแฮนเดิล

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

removeMessageListener

removeMessageListener(namespace, listener)

นำ Listener ที่เพิ่มก่อนหน้านี้ออกจากข้อความ

พารามิเตอร์

เนมสเปซ

สตริง

เนมสเปซที่ฟัง เช่น "urn:x-cast:com.example.namespace"

Listener

ฟังก์ชัน(สตริง, สตริง)

Listener ที่จะนำออก

sendMessage

sendMessage(namespace, data) แสดงผลคำสัญญาที่มี chrome.cast.ErrorCode ที่เป็นค่าว่างได้

ส่งข้อความถึงผู้รับ

พารามิเตอร์

เนมสเปซ

สตริง

เนมสเปซที่จะส่งข้อความ เช่น "urn:x-cast:com.example.namespace"

ข้อมูล

(non-null Object or string)

ข้อมูลที่จะส่ง

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

non-null Promise containing nullable chrome.cast.ErrorCode แก้ไขคำสัญญาเมื่อส่งข้อความแล้ว หรือถูกปฏิเสธโดยมีรหัสข้อผิดพลาดหากไม่สำเร็จ

setMute

setMute(isMute) แสดงคำสัญญาที่มี chrome.cast.ErrorCode ที่เป็นค่าว่างได้

ปิดเสียงหรือปิดเสียงผู้รับ

พารามิเตอร์

isMute

boolean

สถานะปิดเสียงใหม่

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

non-null Promise containing nullable chrome.cast.ErrorCode มีการอัปเดตโปรแกรมรับคำสัญญาที่แก้ไขปัญหาแล้ว หรือถูกปฏิเสธโดยมีรหัสข้อผิดพลาดหากไม่สำเร็จ

setVolume

setVolume(Volume) จะแสดงผล Promise ที่มี chrome.cast.ErrorCode ซึ่งมีค่า Nullable

ตั้งค่าระดับเสียงตัวรับ

พารามิเตอร์

ระดับเสียง

ตัวเลข

ระดับเสียงใหม่ระหว่าง 0.0 ถึง 1.0

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

non-null Promise containing nullable chrome.cast.ErrorCode มีการอัปเดตโปรแกรมรับคำสัญญาที่แก้ไขปัญหาแล้ว หรือถูกปฏิเสธโดยมีรหัสข้อผิดพลาดหากไม่สำเร็จ