cast. เฟรมเวิร์ก PlayerManager
ควบคุมและตรวจสอบการเล่นสื่อ
- การขว้าง
-
non-null Error
หากใช้เครื่องมือสร้างโดยตรง คุณควรเข้าถึงPlayerManager
ด้วยการเรียก cast.framework.CastReceiverContext#getPlayerManager
วิธีการ
addEventListener
addEventListener(eventType, eventListener)
เพิ่ม Listener เหตุการณ์ที่ฟังเหตุการณ์การเล่น
พารามิเตอร์ |
|
---|---|
eventType |
(cast.framework.events.EventType ที่ไม่ใช่ null หรืออาร์เรย์ที่ไม่เป็นค่าว่างของ cast.framework.events.EventType) ประเภทเหตุการณ์หรืออาร์เรย์ของประเภทเหตุการณ์ |
eventListener |
function(non-null cast.framework.events.Event) |
- การขว้าง
-
non-null Error
หากอาร์กิวเมนต์ที่ระบุไม่ถูกต้อง
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
เพิ่มคำสั่งใหม่ที่รองรับลงในรายการคำสั่งสื่อที่รองรับที่มีอยู่
พารามิเตอร์ |
|
---|---|
supportedMediaCommands |
ตัวเลข บิตมาสก์ของคำสั่งสื่อที่แอปพลิเคชันรองรับ |
broadcastStatus |
ไม่บังคับ boolean
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
broadcastStatus
broadcastStatus(includeMedia, requestId, customData, includeQueueItems)
ส่งข้อความสถานะสื่อไปยังผู้ส่งทุกคน (ออกอากาศ) แอปพลิเคชันจะใช้วิธีนี้ในการส่งการเปลี่ยนแปลงสถานะที่กำหนดเอง
พารามิเตอร์ |
|
---|---|
includeMedia |
ไม่บังคับ boolean
|
requestId |
ไม่บังคับ ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดการตอบสนองนี้ |
customData |
ไม่บังคับ ออบเจ็กต์ ข้อมูลที่กำหนดเองเฉพาะแอปพลิเคชันของข้อความสถานะ ค่าอาจเป็น Null |
includeQueueItems |
ไม่บังคับ boolean ต้องการรวมรายการคิวในข้อความสถานะหรือไม่ ซึ่งโดยค่าเริ่มต้นจะไม่มีการรวม |
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() แสดงผลอาร์เรย์ของ 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 |
ตัวเลข เวลาสัมบูรณ์ของสื่อ โดยใช้เวลา UNIX Epoch (วินาทีนับตั้งแต่ Epoch ของ Unix) |
- การคืนสินค้า
-
nullable number
เวลาสื่อหรือnull
หากไม่มี
getPlaybackConfig
getPlayConfig() แสดงผล cast.framework.PlaybackConfig
แสดงผลการกำหนดค่าการเล่นหรือ null
หากไม่มีการลบล้างค่าเริ่มต้น
- การคืนสินค้า
-
nullable cast.framework.PlaybackConfig
getPlaybackRate
getPlayRate() แสดงผล ตัวเลข
แสดงอัตราการเล่นปัจจุบัน
แสดงผล 1
ก่อนเรียกใช้รีซีฟเวอร์ CastReceiverContext#start
- การคืนสินค้า
-
number
อัตราการเล่นปัจจุบัน
getPlayerState
getPlayerState() แสดงผล cast.framework.messages.PlayerState
รับสถานะ Player
- การคืนสินค้า
-
non-null cast.framework.messages.PlayerState
สถานะปัจจุบันของPlayer
getPreferredPlaybackRate
getPreferredPlayRate() แสดงผลตัวเลข
ดูอัตราการเล่นที่ต้องการ ใช้ได้เมื่อเกิดเหตุการณ์ปิดเครื่องเพื่อบันทึกอัตราการเล่นที่ต้องการล่าสุดไปยังพื้นที่เก็บข้อมูลถาวร เพื่อใช้ในเซสชันถัดไปในตัวเลือกการแคสต์
- การคืนสินค้า
-
number
getPreferredTextLanguage
getPreferredTextLanguage() จะแสดงผลสตริง
รับภาษาของแทร็กข้อความที่ต้องการ
- การคืนสินค้า
-
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
หากไม่มีการเล่นสื่อ
getStartAbsoluteTime
getStartAbsoluteTime() แสดงผล ตัวเลข
รับเวลาเริ่มต้นของสื่อสัมบูรณ์เป็นเวลา UNIX Epoch (วินาทีนับตั้งแต่ Epoch ของ Unix) เวลาสัมบูรณ์ใช้ได้กับสตรีมแบบสดเท่านั้น
- การคืนสินค้า
-
nullable number
getStats
getStats() returns 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 ที่ไม่เป็นค่าว่าง
แสดงผลข้อมูลเมตาที่กำหนดเวลาที่พบระหว่างการแยกวิเคราะห์ไฟล์ Manifest นี่คือ #EXT-X-DATERANGE
ใน HLS และ EventStream
ใน DASH
- การคืนสินค้า
-
non-null Array of non-null cast.framework.TimedMetadata
โหลด
load(loadRequest) แสดงคำสัญญาที่มี void
เริ่มต้นคำขอเพื่อโหลดสื่อ
พารามิเตอร์ |
|
---|---|
loadRequest |
cast.framework.messages.LoadRequestData คำขอโหลดสื่อ ค่าต้องไม่เป็นค่าว่าง |
- การคืนสินค้า
-
non-null Promise containing void
สัญญาว่าจะได้รับการแก้ไขเมื่อการดำเนินการสำเร็จ หรือถูกปฏิเสธหากไม่สำเร็จ
หยุดชั่วคราว
หยุดชั่วคราว()
หยุดสื่อที่เล่นอยู่ชั่วคราว
play
เล่น()
เปิดสื่อที่หยุดชั่วคราวอยู่
removeEventListener
removeEventListener(eventType, eventListener)
นำ Listener เหตุการณ์ที่เพิ่มไว้สำหรับเหตุการณ์การเล่นที่ระบุออก หากไม่มี Listener เหตุการณ์ที่ตรงกัน ระบบจะเพิกเฉยต่อการเรียกนี้
พารามิเตอร์ |
|
---|---|
eventType |
(cast.framework.events.EventType ที่ไม่ใช่ null หรืออาร์เรย์ที่ไม่เป็นค่าว่างของ cast.framework.events.EventType) eventType หรืออาร์เรย์ของประเภทเหตุการณ์ |
eventListener |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
นำคำสั่งออกจากรายการคำสั่งสื่อที่รองรับ
พารามิเตอร์ |
|
---|---|
supportedMediaCommands |
ตัวเลข บิตมาสก์ของคำสั่งสื่อที่แอปพลิเคชันรองรับ |
broadcastStatus |
ไม่บังคับ boolean
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
ค้นหา
การกรอวิดีโอ
กรอในสื่อปัจจุบัน
พารามิเตอร์ |
|
---|---|
seekTime |
ตัวเลข |
sendCustomState
sendCustomState(state)
ส่งสถานะที่กำหนดเองจากตรรกะการเล่นแอปพลิเคชันไปยังตรรกะ UI
วิธีนี้จะช่วยทำให้แยกตรรกะการเล่นและ UI ได้
การรักษาการแยกลอจิกและ UI ไว้จะทำให้หนึ่งใช้ตรรกะ UI เดียวกันสำหรับทั้งการเล่นในเครื่องและรีโมตคอนโทรลได้
สถานะที่กำหนดเองที่ส่งโดยวิธีการนี้จะพร้อมใช้งานใน UI ผ่านทาง PlayerData
พารามิเตอร์ |
|
---|---|
state |
ออบเจ็กต์ ออบเจ็กต์สถานะที่กำหนดเอง ค่าต้องไม่เป็นค่าว่าง |
- ดูเพิ่มเติม
- cast.framework.ui.PlayerData#customState
sendError
sendError(senderId, requestId, type, reason, customData)
ส่งข้อผิดพลาดไปยังผู้ส่งที่ระบุ
พารามิเตอร์ |
|
---|---|
senderId |
สตริง รหัสผู้ส่ง |
requestId |
ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดข้อผิดพลาดนี้ |
ประเภท |
cast.framework.messages.ErrorType ประเภทข้อผิดพลาด ค่าต้องไม่เป็นค่าว่าง |
เหตุผล |
ไม่บังคับ cast.framework.messages.ErrorReason สาเหตุของข้อผิดพลาด ค่าอาจเป็น Null |
customData |
ไม่บังคับ ออบเจ็กต์ ข้อมูลที่กำหนดเองเฉพาะแอปพลิเคชันของข้อความแสดงข้อผิดพลาด ค่าอาจเป็น Null |
sendLocalMediaRequest
sendLocalMediaRequest(request)
ส่งคำขอสื่อในเครื่อง
พารามิเตอร์ |
|
---|---|
ส่งคำขอ |
cast.framework.messages.RequestData ค่าต้องไม่เป็นค่าว่าง |
sendStatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
ส่งข้อความสถานะสื่อไปยังผู้ส่งที่ระบุ
พารามิเตอร์ |
|
---|---|
senderId |
สตริง รหัสผู้ส่ง |
requestId |
ตัวเลข รหัสของคำขอขาเข้าที่ทำให้เกิดการตอบสนองนี้ |
includeMedia |
ไม่บังคับ boolean
|
customData |
ไม่บังคับ ออบเจ็กต์ ข้อมูลที่กำหนดเองเฉพาะแอปพลิเคชันของข้อความสถานะ ค่าอาจเป็น Null |
includeQueueItems |
ไม่บังคับ boolean ต้องการรวมรายการคิวในข้อความสถานะหรือไม่ ซึ่งโดยค่าเริ่มต้นจะไม่มีการรวม |
setIdleReason
setIdleReason(idleReason)
กำหนดเหตุผลที่โปรแกรมเล่นอยู่ในสถานะ IDLE
ซึ่งจะช่วยให้แอปพลิเคชันที่ต้องการบังคับสถานะ IDLE
ระบุเหตุผลในการดำเนินการ (เช่น ข้อผิดพลาดที่กำหนดเอง)
ระบบจะส่งเหตุผลที่ไม่มีการใช้งานไปในข้อความสถานะถัดไป
หมายเหตุ แอปพลิเคชันส่วนใหญ่ไม่จำเป็นต้องตั้งค่านี้ และจำเป็นต้องทำเฉพาะในกรณีที่แอปต้องทำให้ Player
เป็นสถานะ IDLE
ในสถานการณ์พิเศษ และ IdleREASON ที่เป็นค่าเริ่มต้นไม่ได้แสดงถึงลักษณะการทำงานที่ต้องการ
พารามิเตอร์ |
|
---|---|
idleReason |
cast.framework.messages.IdleReason เหตุผลที่ต้องเป็นสถานะ ค่าต้องไม่เป็นค่าว่าง |
setMediaElement
setMediaElement(mediaElement)
ตั้งค่า HTMLMediaElement
เพื่อใช้ หากตั้งค่า Promise
ของ HTMLMediaElement
ไว้ สื่อจะเริ่มเล่นหลังจากแปลค่า Promise
แล้ว
พารามิเตอร์ |
|
---|---|
mediaElement |
(HTMLMediaElement ที่ไม่มีค่า Null หรือ non-null Promise ที่มี HTMLMediaElement ที่ไม่เป็นค่าว่าง)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
ตั้งค่าข้อมูลสื่อ
พารามิเตอร์ |
|
---|---|
mediaInformation |
cast.framework.messages.MediaInformation ค่าต้องไม่เป็นค่าว่าง |
opt_broadcast |
ไม่บังคับ boolean |
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 ค่าต้องไม่เป็นค่าว่าง |
ผู้ดักจับ |
function(non-null cast.framework.messages.RequestData) ค่าอาจเป็น Null |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
กำหนดค่าการเล่นใน PlayerManager
พารามิเตอร์ |
|
---|---|
playbackConfig |
ค่าต้องไม่เป็นค่าว่าง |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
ตั้งค่าคำสั่งสื่อที่ตัวรับรองรับ
พารามิเตอร์ |
|
---|---|
supportedMediaCommands |
ตัวเลข บิตมาสก์ของคำสั่งสื่อที่แอปพลิเคชันรองรับ |
broadcastStatus |
ไม่บังคับ boolean
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
แวะพัก
หยุด()
หยุดสื่อที่เล่นอยู่