chrome.
อธิบายสถานะของแอปพลิเคชัน Cast ที่ทำงานอยู่ในปัจจุบัน โดยปกติแล้ว ไคลเอ็นต์ไม่ควรสร้างออบเจ็กต์เหล่านี้
ผู้ผลิต
เซสชัน
ใหม่ Session(sessionId, appId, displayName, appImages, Receiver)
พารามิเตอร์ |
|
|---|---|
|
sessionId |
สตริง ตัวระบุเซสชัน |
|
appId |
สตริง ตัวระบุแอปพลิเคชันของผู้รับ |
|
displayName |
สตริง ชื่อที่แสดงของแอปพลิเคชัน |
|
appImages |
อาร์เรย์ของ chrome.cast.Image ที่ไม่ใช่ null รูปภาพที่เชื่อมโยงกับแอป ค่าต้องไม่เป็นค่าว่าง |
|
ผู้รับ |
เครื่องรับที่เรียกใช้แอป ค่าต้องไม่เป็นค่าว่าง |
พร็อพเพอร์ตี้
appId
สตริง
ตัวระบุของแอปพลิเคชัน Cast ไม่ได้มีไว้เพื่อแสดง
appImages
อาร์เรย์ที่ไม่เป็นค่าว่างของ chrome.cast.Image
อาร์เรย์ของรูปภาพที่อธิบายแอปพลิเคชัน
displayName
สตริง
ชื่อแอปพลิเคชัน Cast ที่มนุษย์อ่านได้ เช่น "YouTube"
สื่อ
อาร์เรย์แบบ non-null ของ chrome.cast.media.Media ที่ไม่มีค่า Null
สื่อที่อยู่ในเซสชันการแคสต์นี้ รวมถึงสื่อที่โหลดโดยผู้ส่งรายอื่น
เนมสเปซ
อาร์เรย์ที่ไม่ใช่ Null ของ {name: string}
รายการเนมสเปซที่แอปพลิเคชันฝั่งผู้รับรองรับ
ผู้รับ
chrome.cast.Receiver ที่ไม่เป็น null
รีซีฟเวอร์ที่เรียกใช้แอปพลิเคชัน
senderApps
อาร์เรย์ที่ไม่ใช่ null ของ chrome.cast.SenderApplication แบบไม่เป็น Null
แอปพลิเคชันของผู้ส่งที่รองรับโดยแอปพลิเคชันของผู้รับ ซึ่งอาจใช้เพื่อแจ้งให้ผู้ใช้ติดตั้งหรือไปที่แอปพลิเคชันของผู้ส่ง
sessionId
สตริง
ระบุอินสแตนซ์ของแอปพลิเคชันฝั่งผู้รับโดยไม่ซ้ำกัน
สถานะ
chrome.cast.SessionStatus ที่ไม่ใช่ Null
สถานะของเซสชันการแคสต์นี้ไปยังแอปพลิเคชันเครื่องรับ
statusText
สตริงที่เว้นว่างได้
ข้อความอธิบายเนื้อหาแอปพลิเคชันปัจจุบัน เช่น "ภาพสไลด์งานแต่งงานของฉัน"
transportId
สตริง
ตัวระบุที่อธิบายเซสชันนี้โดยไม่ซ้ำกันเพื่อวัตถุประสงค์ในการขนส่ง ช่องทางนี้เป็นช่องทางการสื่อสารภายใน
วิธีการ
addMediaListener
addMediaListener(listener)
เพิ่ม Listener ที่ถูกเรียกใช้เมื่อผู้ส่งรายอื่นสร้างเซสชันสื่อ
พารามิเตอร์ |
|
|---|---|
|
Listener |
function(non-null chrome.cast.media.Media) Listener ที่จะเพิ่ม |
addMessageListener
addMessageListener(namespace, listener)
เพิ่ม Listener ที่ถูกเรียกใช้เมื่อได้รับข้อความจาก แอปพลิเคชันตัวรับ ระบบจะเรียกใช้ Listener พร้อมเนมสเปซเป็นอาร์กิวเมนต์แรก และข้อความเป็นอาร์กิวเมนต์ที่ 2
พารามิเตอร์ |
|
|---|---|
|
เนมสเปซ |
สตริง เนมสเปซที่จะฟัง เช่น "urn:x-cast:com.example.namespace" |
|
Listener |
ฟังก์ชัน(สตริง, สตริง) Listener ที่จะเพิ่ม |
addUpdateListener
addUpdateListener(listener)
เพิ่ม Listener ที่ถูกเรียกใช้เมื่อเซสชันมีการเปลี่ยนแปลง การเปลี่ยนแปลงพร็อพเพอร์ตี้ต่อไปนี้จะเรียก Listener: statusText, เนมสเปซ, สถานะ และระดับเสียงของรีซีฟเวอร์
ผู้ฟังควรตรวจสอบพร็อพเพอร์ตี้ status ของเซสชันเพื่อระบุสถานะการเชื่อมต่อ เลิกใช้งานพารามิเตอร์บูลีน isAlive แล้วเพื่อใช้พร็อพเพอร์ตี้เซสชัน status แทน ระบบจะส่งพารามิเตอร์ isAlive สำหรับความเข้ากันได้แบบย้อนหลัง และเป็นจริงเว้นแต่ status =
chrome.cast.SessionStatus.STOPPED
พารามิเตอร์ |
|
|---|---|
|
Listener |
function(boolean) Listener ที่จะเพิ่ม |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
รับข้อมูลแอป DIAL
พารามิเตอร์ |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
จะออก
ออก(URL ติดต่อกลับ, ข้อผิดพลาดการโทรกลับ)
ออกจาก (ยกเลิกการเชื่อมต่อ) จากแอปพลิเคชันตัวรับสัญญาณที่ทำงานอยู่ซึ่งเชื่อมโยงกับเซสชัน
ระบบจะยกเลิกการเชื่อมต่อไคลเอ็นต์เดิมที่อยู่ในขอบเขตที่กำหนดโดย Auto JoinPolicy ของไคลเอนต์นี้ ลูกค้าในอนาคตจะไม่เข้าร่วมเซสชันที่เหลือโดยอัตโนมัติ
ไคลเอ็นต์ที่ไม่ได้เชื่อมต่อทั้งหมดจะมีการเรียก Listener การอัปเดตเซสชันด้วย isAlive = true ผู้ฟังควรตรวจสอบพร็อพเพอร์ตี้ status ของเซสชันเพื่อระบุสถานะการเชื่อมต่อ เนื่องจาก isAlive เลิกใช้งานแล้ว ในกรณีนี้คือ status = chrome.cast.SessionStatus.DISCONNECTED
พารามิเตอร์ |
|
|---|---|
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
โหลดสื่อลงในแอปพลิเคชันตัวรับสัญญาณที่ทำงานอยู่
พารามิเตอร์ |
|
|---|---|
|
loadRequest |
คำขอโหลดสื่อ ค่าต้องไม่เป็นค่าว่าง |
|
successCallback |
function(non-null chrome.cast.media.Media) เรียกใช้ด้วยสื่อที่โหลดเรียบร้อยแล้ว |
|
errorCallback |
function(non-null chrome.cast.Error) เรียกใช้เมื่อเกิดข้อผิดพลาด ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
queueLoad
queueLoad(queueLoadRequest, successCallback, errorCallback)
โหลดและเริ่มเล่นคิวของรายการสื่อใหม่ไปยังแอปพลิเคชันตัวรับที่กำลังทำงานอยู่
พารามิเตอร์ |
|
|---|---|
|
queueLoadRequest |
chrome.cast.media.QueueLoadRequest ขอให้โหลดคิวใหม่ของรายการสื่อ ค่าต้องไม่เป็นค่าว่าง |
|
successCallback |
function(non-null chrome.cast.media.Media) เรียกใช้ด้วยสื่อที่โหลดเรียบร้อยแล้ว |
|
errorCallback |
function(non-null chrome.cast.Error) เรียกใช้เมื่อเกิดข้อผิดพลาด ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
- เลิกใช้
- ใช้ cast.framework.CastSession#loadMedia และระบุ chrome.cast.media.LoadRequest#queueData ที่เกี่ยวข้อง
removeMediaListener
removeMediaListener(listener)
นำ Listener ที่เพิ่มไว้ก่อนหน้านี้ด้วย addMediaListener ออก
พารามิเตอร์ |
|
|---|---|
|
Listener |
function(non-null chrome.cast.media.Media) Listener ที่จะนำออก |
removeMessageListener
removeMessageListener(namespace, listener)
นำ Listener ที่เพิ่มก่อนหน้านี้ออกจากข้อความ
พารามิเตอร์ |
|
|---|---|
|
เนมสเปซ |
สตริง เนมสเปซที่ฟัง เช่น "urn:x-cast:com.example.namespace" |
|
Listener |
ฟังก์ชัน(สตริง, สตริง) Listener ที่จะนำออก |
removeUpdateListener
removeUpdateListener(listener)
นำ Listener ที่เพิ่มไว้ก่อนหน้าสำหรับเซสชันนี้ออก
พารามิเตอร์ |
|
|---|---|
|
Listener |
function(boolean) Listener ที่จะนำออก |
sendMessage
sendMessage(namespace, message, successCallback, errorCallback)
ส่งข้อความไปยังแอปพลิเคชันฝั่งผู้รับในเนมสเปซที่ระบุ ระบบจะเรียกใช้การเรียกกลับเมื่อเสร็จสมบูรณ์เมื่อมีการส่งข้อความไปยังช่องทางการรับส่งข้อความ การส่งไปยังแอปพลิเคชันผู้รับเป็นวิธีที่ดีที่สุดและไม่รับประกัน
พารามิเตอร์ |
|
|---|---|
|
เนมสเปซ |
สตริง เนมสเปซที่จะส่งข้อความ เช่น "urn:x-cast:com.example.namespace" |
|
ข้อความ |
(non-null Object or string) |
|
successCallback |
ฟังก์ชัน() เรียกใช้เมื่อส่งข้อความแล้ว |
|
errorCallback |
function(non-null chrome.cast.Error) เรียกใช้เมื่อเกิดข้อผิดพลาด ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
ตั้งค่าระดับเสียงตัวรับ
พารามิเตอร์ |
|
|---|---|
|
ปิดเสียงอยู่ |
boolean สถานะปิดเสียงใหม่ |
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
ตั้งค่าระดับเสียงตัวรับ
พารามิเตอร์ |
|
|---|---|
|
newLevel |
ตัวเลข ระดับเสียงใหม่ระหว่าง 0.0 ถึง 1.0 |
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |
แวะพัก
หยุด(Callback ความสำเร็จ, ข้อผิดพลาดการโทรกลับ)
หยุดแอปพลิเคชันตัวรับที่ทำงานอยู่ที่เชื่อมโยงกับเซสชัน
พารามิเตอร์ |
|
|---|---|
|
successCallback |
ฟังก์ชัน() |
|
errorCallback |
function(non-null chrome.cast.Error) ข้อผิดพลาดที่เป็นไปได้คือ TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR และ EXTENSION_MISSING |