cast. framework. PlayerManager
ควบคุมและตรวจสอบการเล่นสื่อ
- การขว้าง
-
non-null Errorหากใช้ตัวสร้างโดยตรงPlayerManagerควรเข้าถึงได้โดยการเรียกใช้ cast.framework.CastReceiverContext#getPlayerManager เท่านั้น
เมธอด
addEventListener
addEventListener(eventType, eventListener)
เพิ่ม Listener เหตุการณ์ที่รอเหตุการณ์การเล่น
พารามิเตอร์ |
|
|---|---|
|
eventType |
(non-null cast.framework.events.EventType หรืออาร์เรย์ non-null ของ cast.framework.events.EventType) ประเภทกิจกรรมหรือ อาร์เรย์ของประเภทกิจกรรม |
|
eventListener |
function(non-null cast.framework.events.Event) |
- การขว้าง
-
non-null Errorหากอาร์กิวเมนต์ที่ระบุไม่ถูกต้อง
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
เพิ่มคำสั่งใหม่ที่รองรับลงในรายการคำสั่งสื่อที่รองรับที่มีอยู่
พารามิเตอร์ |
|
|---|---|
|
supportedMediaCommands |
ตัวเลข บิตแมสก์ของคำสั่งสื่อ ที่แอปพลิเคชันรองรับ |
|
broadcastStatus |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
broadcastStatus
broadcastStatus(includeMedia, requestId, customData, includeQueueItems)
ส่งข้อความสถานะสื่อไปยังผู้ส่งทั้งหมด (ออกอากาศ) แอปพลิเคชันใช้พารามิเตอร์นี้เพื่อส่งการเปลี่ยนแปลงสถานะที่กำหนดเอง
พารามิเตอร์ |
|
|---|---|
|
includeMedia |
ไม่บังคับ บูลีน
|
|
requestId |
ไม่บังคับ ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดการตอบกลับนี้ |
|
customData |
ไม่บังคับ วัตถุ ข้อมูลที่กำหนดเองของข้อความสถานะเฉพาะแอปพลิเคชัน ค่าอาจเป็น Null |
|
includeQueueItems |
ไม่บังคับ บูลีน รวมรายการในคิวไว้ใน ข้อความสถานะหรือไม่ โดยค่าเริ่มต้น ระบบจะไม่รวม |
getAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) จะแสดงผลเป็นตัวเลข
แปลงเวลาของสื่อเป็นเวลาสัมบูรณ์ของสื่อ เวลาที่แน่นอนใช้ได้กับไลฟ์สดเท่านั้น
พารามิเตอร์ |
|
|---|---|
|
mediaTime |
ตัวเลข เวลาดูสื่อ |
- การคืนสินค้า
-
nullable numberเวลาที่แน่นอนหรือnullหากไม่มี
getAudioTracksManager
getAudioTracksManager() จะแสดงผล cast.framework.AudioTracksManager
รับอินสแตนซ์ AudioTracksManager
- การคืนสินค้า
-
non-null cast.framework.AudioTracksManager
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() จะแสดงผลเป็นตัวเลข
แสดงผลเวลาปัจจุบันของคลิปช่วงพักที่กำลังเล่นอยู่ หน่วยเป็นวินาที
- การคืนสินค้า
-
nullable numberเวลาปัจจุบันในหน่วยวินาทีภายในคลิปช่วงพักปัจจุบันnullเมื่อPlayerไม่ได้เล่นคลิปพัก
getBreakClipDurationSec
getBreakClipDurationSec() จะแสดงผลเป็นตัวเลข
แสดงผลระยะเวลาของคลิปช่วงพักที่กำลังเล่นเป็นวินาที
- การคืนสินค้า
-
nullable numberระยะเวลาของคลิปช่วงพักปัจจุบันnullเมื่อPlayerไม่ได้เล่นคลิปพัก
getBreakManager
getBreakManager() จะแสดงผล cast.framework.breaks.BreakManager
รับอินสแตนซ์ BreakManager
- การคืนสินค้า
-
non-null cast.framework.breaks.BreakManager
getBreaks
getBreaks() returns Array of non-null cast.framework.messages.Break
แสดงรายการช่วงพัก
- การคืนสินค้า
-
non-null Array of non-null cast.framework.messages.Break
getCurrentSupportedMediaCommands
getCurrentSupportedMediaCommands() แสดงผลเป็นตัวเลข
รับคำสั่งสื่อที่ตัวรับสัญญาณรองรับในปัจจุบัน
ค่าที่ส่งคืนของเมธอดนี้จะเปลี่ยนแปลงแบบไดนามิกตามสถานะการเล่นปัจจุบัน ซึ่งต่างจาก getSupportedMediaCommands()
เช่น
ขณะเล่นโฆษณา ระบบอาจไม่รองรับคำสั่ง SEEK
ควรรอให้เรียกใช้เครื่องรับ
CastReceiverContext#start ก่อนจึงเรียกใช้วิธีนี้ ไม่เช่นนั้นวิธีนี้จะแสดงผลเป็น 0
- ดูเพิ่มเติม
- cast.framework.messages.Command
- การคืนสินค้า
-
numberบิตมาสก์ของคำสั่งสื่อที่แอปพลิเคชันรองรับ
getCurrentTimeSec
getCurrentTimeSec() แสดงผลเป็นตัวเลข
รับเวลาเล่นที่ผ่านไปของสื่อปัจจุบัน
- การคืนสินค้า
-
numberเวลาที่ผ่านไปเป็นวินาที โดยจะแสดงเป็น0หากไม่มีสื่อ เล่นอยู่
getDurationSec
getDurationSec() แสดงผลเป็นตัวเลข
รับระยะเวลาของสื่อที่กำลังเล่นอยู่เป็นวินาที
- การคืนสินค้า
-
numberระยะเวลาของสื่อNaNหากไม่มีสื่อ เล่นอยู่
getLiveSeekableRange
getLiveSeekableRange() จะแสดง cast.framework.messages.LiveSeekableRange
แสดงช่วงที่สามารถข้ามได้ในไลฟ์สดพร้อมเวลาเริ่มต้นและเวลาสิ้นสุดเป็นวินาที ค่าต่างๆ จะอิงตามเวลาของสื่อ
- การคืนสินค้า
getMediaInformation
getMediaInformation() จะแสดงผล cast.framework.messages.MediaInformation
รับข้อมูลสื่อของสื่อปัจจุบัน
- การคืนสินค้า
getMediaTimeForAbsoluteTime
getMediaTimeForAbsoluteTime(absoluteTime) จะแสดงผลเป็นตัวเลข
แปลงเวลาแบบสัมบูรณ์ของสื่อเป็นเวลาของสื่อ เวลาที่แน่นอนใช้ได้กับ ไลฟ์สดเท่านั้น
พารามิเตอร์ |
|
|---|---|
|
absoluteTime |
ตัวเลข เวลาสัมบูรณ์ของสื่อในรูปแบบ เวลา Epoch ของ UNIX (วินาทีนับตั้งแต่ Epoch ของ UNIX) |
- การคืนสินค้า
-
nullable numberเวลาของสื่อหรือnullหากไม่มี
getPlaybackConfig
getPlaybackConfig() จะแสดงผล cast.framework.PlaybackConfig
ส่งคืนการกำหนดค่าการเล่นหรือ null หากไม่ได้ลบล้างค่าเริ่มต้น
- การคืนสินค้า
-
nullable cast.framework.PlaybackConfig
getPlaybackRate
getPlaybackRate() จะแสดงผลเป็นตัวเลข
แสดงผลอัตราการเล่นปัจจุบัน
ส่งคืน 1 ก่อนเรียกใช้ตัวรับ CastReceiverContext#start
- การคืนสินค้า
-
numberอัตราการเล่นปัจจุบัน
getPlayerState
getPlayerState() จะแสดงผล cast.framework.messages.PlayerState
รับสถานะ Player
- การคืนสินค้า
-
non-null cast.framework.messages.PlayerStateสถานะของPlayerปัจจุบัน
getPreferredPlaybackRate
getPreferredPlaybackRate() จะแสดงผลเป็นตัวเลข
รับอัตราการเล่นที่ต้องการ ใช้ในเหตุการณ์ปิดเพื่อบันทึกอัตราการเล่นที่ต้องการล่าสุด ไปยังพื้นที่เก็บข้อมูลถาวร เพื่อให้ใช้ในเซสชันถัดไปในตัวเลือกการแคสต์ได้
- การคืนสินค้า
-
number
getPreferredTextLanguage
getPreferredTextLanguage() แสดงผล string
รับภาษาของแทร็กข้อความที่ต้องการ
- การคืนสินค้า
-
nullable string
getPreferredTextStyle
getPreferredTextStyle() จะแสดงผล cast.framework.messages.TextTrackStyle
รับรูปแบบแทร็กข้อความที่ต้องการ
- การคืนสินค้า
getQueueManager
getQueueManager() returns (cast.framework.QueueManager or undefined)
รับอินสแตนซ์ QueueManager
- การคืนสินค้า
-
(non-null cast.framework.QueueManager or undefined)
getRawCurrentTimeSec
getRawCurrentTimeSec() แสดงผลเป็นตัวเลข
รับเวลาเล่นที่ผ่านไปของสื่อปัจจุบันโดยไม่หักเวลาพักโฆษณา
- การคืนสินค้า
-
numberเวลาที่ผ่านไปเป็นวินาที โดยจะแสดงเป็น0หากไม่มีสื่อ เล่นอยู่
getRawSeekableRange
getRawSeekableRange() จะแสดงผล cast.framework.messages.Range
แสดงผลช่วงที่ค้นหาได้ของสื่อปัจจุบัน
หมายเหตุ: ค่านี้ตรงกับหน่วยของ getRawCurrentTimeSec() แต่ไม่ใช่
seek()! ค่านี้ไม่ได้คำนึงถึงโฆษณาหรือออฟเซ็ตสื่ออื่นๆ
คุณควรใช้ getLiveSeekableRange() แทน เว้นแต่จะแน่ใจว่าต้องการค่าดิบ
- การคืนสินค้า
-
nullable cast.framework.messages.Range
getStartAbsoluteTime
getStartAbsoluteTime() จะแสดงผลเป็นตัวเลข
รับเวลาเริ่มต้นของสื่อแบบสัมบูรณ์เป็น เวลา Epoch ของ UNIX (วินาทีนับตั้งแต่ Epoch ของ UNIX) เวลาที่แน่นอนใช้ได้กับไลฟ์สดเท่านั้น
- การคืนสินค้า
-
nullable number
getStats
getStats() จะแสดงผล cast.framework.stats.Stats
แสดงสถิติการเล่น ระบบจะรวบรวมสถิติตลอด เซสชันการเล่นเมื่อเหมาะสม
- การคืนสินค้า
-
non-null cast.framework.stats.Stats
getSupportedMediaCommands
getSupportedMediaCommands() แสดงผลเป็นตัวเลข
รับคำสั่งสื่อที่ตัวรับสัญญาณรองรับ ควรเรียกใช้หลังจากเรียกใช้
CastReceiverContext#start() เท่านั้น ไม่เช่นนั้นจะแสดงผล 0 ค่าคำสั่งสื่อที่รองรับ
จะควบคุมโดยแอปพลิเคชันตัวรับสัญญาณเท่านั้น
ระบบจะไม่อัปเดตโดยอัตโนมัติตาม MediaStatus
- ดูเพิ่มเติม
- cast.framework.messages.Command
- การคืนสินค้า
-
numberบิตมาสก์ของคำสั่งสื่อที่แอปพลิเคชันรองรับ
getTextTracksManager
getTextTracksManager() จะแสดงผล cast.framework.TextTracksManager
รับอินสแตนซ์ TextTracksManager
- การคืนสินค้า
-
non-null cast.framework.TextTracksManager
getTimedMetadata
getTimedMetadata() จะแสดงผลอาร์เรย์ของ cast.framework.TimedMetadata ที่ไม่ใช่ค่า Null
แสดงข้อมูลเมตาที่กำหนดเวลาซึ่งพบระหว่างการแยกวิเคราะห์ไฟล์ Manifest ซึ่งคือ
#EXT-X-DATERANGE ใน HLS และ EventStream ใน DASH
- การคืนสินค้า
-
non-null Array of non-null cast.framework.TimedMetadata
โหลด
load(loadRequest) returns Promise containing void
เริ่มคำขอโหลดสื่อ
พารามิเตอร์ |
|
|---|---|
|
loadRequest |
cast.framework.messages.LoadRequestData คำขอ เพื่อโหลดสื่อ ค่าต้องไม่เป็นค่า Null |
- การคืนสินค้า
-
non-null Promise containing voidPromise ที่ได้รับการแก้ไขเมื่อการดำเนินการสำเร็จ หรือถูกปฏิเสธหากล้มเหลว
หยุดชั่วคราว
pause()
หยุดสื่อที่กำลังเล่นอยู่ชั่วคราว
play
play()
เล่นสื่อที่หยุดชั่วคราวอยู่
removeEventListener
removeEventListener(eventType, eventListener)
นำ Listener เหตุการณ์ที่เพิ่มสำหรับเหตุการณ์การเล่นที่ระบุออก หากไม่มี Listener เหตุการณ์ที่ตรงกัน ระบบจะข้ามการเรียกนี้
พารามิเตอร์ |
|
|---|---|
|
eventType |
(non-null cast.framework.events.EventType หรืออาร์เรย์ non-null ของ cast.framework.events.EventType) eventType หรือ อาร์เรย์ของประเภทเหตุการณ์ |
|
eventListener |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
นำคำสั่งออกจากรายการคำสั่งสื่อที่รองรับ
พารามิเตอร์ |
|
|---|---|
|
supportedMediaCommands |
ตัวเลข บิตแมสก์ของคำสั่งสื่อ ที่แอปพลิเคชันรองรับ |
|
broadcastStatus |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
ค้นหา
seek(seekTime)
กรอในสื่อปัจจุบัน
พารามิเตอร์ |
|
|---|---|
|
seekTime |
ตัวเลข |
sendCustomState
sendCustomState(state)
ส่งสถานะที่กำหนดเองจากตรรกะการเล่นแอปพลิเคชันไปยังตรรกะ UI
วิธีนี้ช่วยให้แยกตรรกะการเล่นและ UI ออกจากกันได้
การแยกตรรกะและ UI ออกจากกันช่วยให้ใช้ตรรกะ UI เดียวกันได้ทั้งสำหรับการเล่นในเครื่องและการควบคุมระยะไกล
UI จะเข้าถึงสถานะที่กำหนดเองซึ่งส่งโดยเมธอดนี้ได้ผ่าน PlayerData
พารามิเตอร์ |
|
|---|---|
|
รัฐ |
วัตถุ ออบเจ็กต์สถานะที่กำหนดเอง ค่าต้องไม่เป็นค่า Null |
- ดูเพิ่มเติม
- cast.framework.ui.PlayerData#customState
sendError
sendError(senderId, requestId, type, reason, customData)
ส่งข้อผิดพลาดไปยังผู้ส่งที่เฉพาะเจาะจง
พารามิเตอร์ |
|
|---|---|
|
senderId |
สตริง รหัสผู้ส่ง |
|
requestId |
ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดข้อผิดพลาดนี้ |
|
ประเภท |
cast.framework.messages.ErrorType ประเภทข้อผิดพลาด ค่าต้องไม่เป็นค่า Null |
|
เหตุผล |
ไม่บังคับ cast.framework.messages.ErrorReason สาเหตุของข้อผิดพลาด ค่าอาจเป็น Null |
|
customData |
ไม่บังคับ วัตถุ ข้อความแสดงข้อผิดพลาด ข้อมูลที่กำหนดเองเฉพาะแอปพลิเคชัน ค่าอาจเป็น Null |
sendLocalMediaRequest
sendLocalMediaRequest(request)
ส่งคำขอสื่อในเครื่อง
พารามิเตอร์ |
|
|---|---|
|
ส่งคำขอ |
cast.framework.messages.RequestData ค่าต้องไม่เป็นค่า Null |
sendStatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
ส่งข้อความสถานะสื่อไปยังผู้ส่งที่ระบุ
พารามิเตอร์ |
|
|---|---|
|
senderId |
สตริง รหัสผู้ส่ง |
|
requestId |
ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดการตอบกลับนี้ |
|
includeMedia |
ไม่บังคับ บูลีน
|
|
customData |
ไม่บังคับ วัตถุ ข้อมูลที่กำหนดเองของข้อความสถานะเฉพาะแอปพลิเคชัน ค่าอาจเป็น Null |
|
includeQueueItems |
ไม่บังคับ บูลีน รวมรายการในคิวไว้ใน ข้อความสถานะหรือไม่ โดยค่าเริ่มต้น ระบบจะไม่รวม |
setIdleReason
setIdleReason(idleReason)
ตั้งค่าเหตุผลที่เพลเยอร์อยู่ในสถานะ IDLE
ซึ่งจะช่วยให้แอปพลิเคชันที่ต้องการบังคับสถานะ IDLE
ระบุเหตุผลในการดำเนินการดังกล่าวได้ (เช่น ข้อผิดพลาดที่กำหนดเอง)
ระบบจะส่งเหตุผลที่ไม่ได้ใช้งานในข้อความสถานะถัดไป
หมายเหตุ แอปพลิเคชันส่วนใหญ่ไม่จำเป็นต้องตั้งค่านี้ โดยจะจำเป็นก็ต่อเมื่อ
แอปต้องทำให้ Player เปลี่ยนเป็นสถานะ IDLE ในกรณีพิเศษ
และ idleReason เริ่มต้นไม่ได้แสดงลักษณะการทำงานที่ต้องการ
พารามิเตอร์ |
|
|---|---|
|
idleReason |
cast.framework.messages.IdleReason เหตุผลที่ต้องอยู่ในสถานะ ค่าต้องไม่เป็นค่า Null |
setMediaElement
setMediaElement(mediaElement)
ตั้งค่า HTMLMediaElement ที่จะใช้ หากตั้งค่า Promise ของ
HTMLMediaElement ไว้ สื่อจะเริ่มเล่นหลังจากที่ระบบ
แก้ไข Promise แล้ว
พารามิเตอร์ |
|
|---|---|
|
mediaElement |
(HTMLMediaElement ที่ไม่ใช่ค่าว่างหรือ Promise ที่ไม่ใช่ค่าว่างซึ่งมี HTMLMediaElement ที่ไม่ใช่ค่าว่าง)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
ตั้งค่าข้อมูลสื่อ
พารามิเตอร์ |
|
|---|---|
|
mediaInformation |
cast.framework.messages.MediaInformation ค่าต้องไม่เป็นค่า Null |
|
opt_broadcast |
ไม่บังคับ บูลีน |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
ตั้งค่าตัวแฮนเดิลเพื่อส่งคืนหรือแก้ไข cast.framework.PlaybackConfig
สำหรับคำขอโหลดที่เฉพาะเจาะจง พารามิเตอร์ของตัวแฮนเดิลคือ
LoadRequestData และค่าเริ่มต้น PlaybackConfig สำหรับตัวรับ (ระบุ
ใน CastReceiverOptions) ตัวแฮนเดิลควรแสดงผลการกำหนดค่าการเล่นที่แก้ไขแล้ว หรือ null เพื่อป้องกันไม่ให้เล่นสื่อ ค่าที่ส่งคืน
อาจเป็น Promise เพื่อให้รอข้อมูลจากเซิร์ฟเวอร์ได้
พารามิเตอร์ |
|
|---|---|
|
ตัวแฮนเดิล |
function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig) ฟังก์ชันสำหรับระบุ การกำหนดค่าการเล่นที่เฉพาะเจาะจงสำหรับคำขอ ค่าอาจเป็น Null |
setMediaUrlResolver
setMediaUrlResolver(resolver)
กำหนดตัวแฮนเดิลเพื่อแสดงผล URL ของสื่อสำหรับคำขอ LOAD
โดยสามารถใช้ตัวแฮนเดิลนี้เพื่อหลีกเลี่ยงการเผยแพร่ URL เนื้อหาสื่อ
เป็นส่วนหนึ่งของสถานะสื่อ โดยค่าเริ่มต้น ระบบจะใช้สื่อ contentId เป็น URL เนื้อหา
พารามิเตอร์ |
|
|---|---|
|
รีโซลเวอร์ |
function(non-null cast.framework.messages.LoadRequestData) ฟังก์ชันสำหรับแก้ไข URL ของเนื้อหาสื่อ ค่าอาจเป็น Null |
setMessageInterceptor
setMessageInterceptor(type, interceptor)
ตั้งค่าตัวสกัดกั้นข้อความขาเข้าและขาออก
อินเทอร์เซ็ปเตอร์สามารถอัปเดตข้อมูลคำขอ และควรส่งคืนข้อมูลที่อัปเดตแล้ว Promise พร้อมข้อมูลที่อัปเดต (หากส่งคืนข้อมูลไม่ได้ทันที) หรือ null หากไม่ควรจัดการคำขอ
หมายเหตุ: หากมีการระบุตัวสกัดกั้นข้อความ LOAD แต่ไม่มีการระบุตัวสกัดกั้น PRELOAD แยกต่างหาก ระบบจะเรียกใช้ตัวสกัดกั้น LOAD สำหรับข้อความ PRELOAD
พารามิเตอร์ |
|
|---|---|
|
ประเภท |
cast.framework.messages.MessageType ค่าต้องไม่เป็นค่า Null |
|
สกัดกั้น |
function(non-null cast.framework.messages.RequestData) ค่าอาจเป็น Null |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
กำหนดค่าการเล่นใน PlayerManager
พารามิเตอร์ |
|
|---|---|
|
playbackConfig |
ค่าต้องไม่เป็นค่า Null |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
ตั้งค่าคำสั่งสื่อที่ตัวรับรองรับ
พารามิเตอร์ |
|
|---|---|
|
supportedMediaCommands |
ตัวเลข บิตแมสก์ของคำสั่งสื่อ ที่แอปพลิเคชันรองรับ |
|
broadcastStatus |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
แวะพัก
stop()
หยุดสื่อที่กำลังเล่นอยู่