แคสต์ เฟรมเวิร์ก PlayerManager
ควบคุมและตรวจสอบการเล่นสื่อ
- ผ้าคลุม
-
non-null Error
หากใช้ตัวสร้างโดยตรง ควรเข้าถึงPlayerManager
ได้โดยการเรียกใช้ cast.framework.CastReceiverContext#getPlayerManager
วิธีการ
เพิ่ม Listener เหตุการณ์
addEventListener(eventType, eventListener)
เพิ่ม Listener เหตุการณ์ที่จะฟังเหตุการณ์การเล่น
พารามิเตอร์ |
|
---|---|
ประเภทเหตุการณ์ |
(cast.framework.events.EventType เป็นค่าว่างหรืออาร์เรย์ที่ไม่ใช่ Null ของ cast.framework.events.EventType) ประเภทกิจกรรมหรืออาร์เรย์ของประเภทเหตุการณ์ |
Listener เหตุการณ์ |
function(non-null cast.framework.events.Event) |
- ผ้าคลุม
-
non-null Error
หากอาร์กิวเมนต์ที่ระบุไม่ถูกต้อง
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, castStatus)
เพิ่มคําสั่งใหม่ที่รองรับลงในรายการคําสั่งสื่อที่รองรับที่มีอยู่
พารามิเตอร์ |
|
---|---|
คําสั่งสื่อที่รองรับ |
หมายเลข คําสั่งคําสั่งสื่อที่แอปพลิเคชันรองรับ |
สถานะการออกอากาศ |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
สถานะการออกอากาศ
BroadStatus(includeMedia, requestId, customData, includeQueueItems)
ส่งข้อความสถานะสื่อให้ผู้ส่งทุกคน (ประกาศ) แอปพลิเคชันใช้ตัวนี้เพื่อส่งการเปลี่ยนแปลงสถานะที่กําหนดเอง
พารามิเตอร์ |
|
---|---|
includeMedia |
ไม่บังคับ บูลีน
|
รหัสคําขอ |
ไม่บังคับ หมายเลข รหัสของคําขอที่เข้ามาใหม่ซึ่งทําให้เกิดการตอบกลับนี้ |
ข้อมูลที่กําหนดเอง |
ไม่บังคับ ออบเจ็กต์ ข้อมูลที่กําหนดเองเฉพาะแอปพลิเคชันของข้อความสถานะ ค่าอาจเป็นค่าว่าง |
รวมถึงรายการคิว |
ไม่บังคับ บูลีน ระบุว่าต้องการรวมรายการคิวไว้ในข้อความสถานะหรือไม่ ซึ่งไม่รวม |
รับเวลาสัมบูรณ์ของสื่อ
getabsoluteTimeForMediaTime(mediaTime) แสดงจํานวน
แปลงเวลาของสื่อเป็นเวลาสัมบูรณ์ของสื่อ เวลาสัมบูรณ์ใช้ได้สําหรับสตรีมแบบสดเท่านั้น
พารามิเตอร์ |
|
---|---|
เวลาสื่อ |
หมายเลข เวลาสื่อ |
- การคืนสินค้า
-
nullable number
เวลาสัมบูรณ์หรือnull
หากไม่มี
getManagerTracksManager
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() returns number
รับระยะเวลาของสื่อที่เล่นอยู่เป็นวินาที
- การคืนสินค้า
-
number
ระยะเวลาของสื่อNaN
หากไม่มีการเล่นสื่อ
getLiveSeekableRange
getLiveSeekableRange() ส่งกลับ cast.framework.messages.LiveSeekableRange
แสดงผลช่วงการค้นหาแบบเรียลไทม์ที่มีเวลาเริ่มต้นและเวลาสิ้นสุดเป็นวินาที ค่าจะขึ้นอยู่กับเวลาสื่อ
- การคืนสินค้า
สื่อข้อมูล getmedia
getMediaInformation() จะส่งกลับ cast.framework.messages.MediaInformation
รับข้อมูลสื่อของสื่อปัจจุบัน
- การคืนสินค้า
getMediaTimeForabsoluteTime
getMediaTimeForabsoluteTime(absoluteTime) แสดงจํานวน
แปลงเวลาสัมบูรณ์ของสื่อเป็นเวลาสื่อ เวลาสัมบูรณ์ใช้ได้กับสตรีมแบบสดเท่านั้น
พารามิเตอร์ |
|
---|---|
ค่าสัมบูรณ์ |
หมายเลข เวลาสัมบูรณ์ของสื่อในรูปแบบเวลา UNIX Epoch (เป็นวินาทีนับจาก Epoch ของ Unix) |
- การคืนสินค้า
-
nullable number
เวลาสื่อหรือnull
หากไม่มี
รับการกําหนดค่าการเล่น
getplayConfig() แสดงผล cast.framework.playConfig
แสดงการกําหนดค่าการเล่น
- การคืนสินค้า
-
nullable cast.framework.PlaybackConfig
อัตราการเล่น
getPlayRate() จํานวนรายการส่งคืน
แสดงอัตราการเล่นปัจจุบัน
แสดงผล 1
ก่อนที่จะมีการเรียก CastReceiverContext#start
ของตัวรับ
- การคืนสินค้า
-
number
อัตราการเล่นปัจจุบัน
รับ getPlayerState
getPlayerState() แสดงผล cast.framework.messages.PlayerState
รับสถานะ Player
- การคืนสินค้า
-
non-null cast.framework.messages.PlayerState
สถานะของPlayer
ปัจจุบัน
อัตราการเล่นที่ต้องการ
getPreferredPlayRate() จํานวนรายการส่งคืน
ดูอัตราการเล่นที่ต้องการ ใช้ได้ในเหตุการณ์การปิดเพื่อบันทึกไว้ในอัตราการเล่นล่าสุดที่ต้องการไปยังพื้นที่เก็บข้อมูลถาวร เพื่อให้คุณใช้ได้ในเซสชันถัดไปในตัวเลือกการแคสต์
- การคืนสินค้า
-
number
รับข้อความที่ต้องการ
getPreferredTextLanguage() ส่งคืนสตริง
เลือกภาษาของข้อความแทร็กที่ต้องการ
- การคืนสินค้า
-
nullable string
รับรูปแบบข้อความที่ต้องการ
getPreferredTextStyle() แสดงผล cast.framework.messages.TextTrackStyle
รับสไตล์แทร็กข้อความที่ต้องการ
- การคืนสินค้า
รับเครื่องมือจัดการคิว
getQueueManager() ส่งกลับ (cast.framework.QueueManager หรือไม่ได้กําหนด)
รับอินสแตนซ์ QueueManager
- การคืนสินค้า
-
(non-null cast.framework.QueueManager or undefined)
getRawCurrentTimeSec
getRawCurrentTimeSec() แสดงจํานวน
รับเวลาเล่นที่ผ่านไปของสื่อปัจจุบันโดยไม่ลบเวลา ของช่วงพักโฆษณา
- การคืนสินค้า
-
number
เวลาที่ผ่านไปเป็นวินาที โดยจะเป็น0
หากไม่มีการเล่นสื่อ
getStartTimeTime
getStartabsoluteTime() แสดงจํานวน
รับเวลาเริ่มต้นของสื่อแบบสัมบูรณ์ในรูปแบบเวลา UNIX Epoch (เป็นวินาทีนับจาก 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
คําสั่งย่อยของคําสั่งสื่อที่แอปพลิเคชันรองรับ
getManagerTracksManager
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
เริ่มคําขอโหลดสื่อ
พารามิเตอร์ |
|
---|---|
คําขอโหลด |
cast.framework.messages.LoadRequestData คําขอโหลดสื่อ ค่าต้องไม่เป็นค่าว่าง |
- การคืนสินค้า
-
non-null Promise containing void
คํามั่นสัญญาที่ได้รับการแก้ไขเมื่อเสร็จสมบูรณ์ หรือถูกปฏิเสธหากล้มเหลว
หยุดชั่วคราว
หยุดชั่วคราว()
หยุดสื่อที่เล่นอยู่ชั่วคราว
play
เล่น()
เล่นสื่อที่หยุดไว้ชั่วคราวในขณะนี้
removeEventListener
removeEventListener(eventType, eventListener)
นํา Listener เหตุการณ์ที่เพิ่มสําหรับเหตุการณ์การเล่นที่กําหนดออก หากไม่มี Listener เหตุการณ์ที่ตรงกัน ระบบจะไม่สนใจสายนี้
พารามิเตอร์ |
|
---|---|
ประเภทเหตุการณ์ |
(cast.framework.events.EventType เป็นค่าว่างหรืออาร์เรย์ที่ไม่ใช่ Null ของ cast.framework.events.EventType) eventType หรืออาร์เรย์ของประเภทเหตุการณ์ |
Listener เหตุการณ์ |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, castStatus)
นําคําสั่งออกจากรายการคําสั่งสื่อที่รองรับ
พารามิเตอร์ |
|
---|---|
คําสั่งสื่อที่รองรับ |
หมายเลข คําสั่งคําสั่งสื่อที่แอปพลิเคชันรองรับ |
สถานะการออกอากาศ |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
ค้นหา
กรอ(eหนึ่งในTimeTime)
เรียกดูในสื่อปัจจุบัน
พารามิเตอร์ |
|
---|---|
เวลาสืบค้น |
หมายเลข |
ส่งสถานะที่กําหนดเอง
sendCustomState(state)
ส่งสถานะที่กําหนดเองจากตรรกะการเล่นแอปพลิเคชันไปยังตรรกะของ UI
เมธอดนี้ช่วยในการแยกตรรกะการเล่นและ UI
การแยกกันระหว่างตรรกะและ UI จะทําให้ตรรกะหนึ่งใช้ตรรกะ UI เดียวกันสําหรับทั้งการเล่นในเครื่องและการควบคุมระยะไกล
สถานะที่กําหนดเองที่ส่งโดยวิธีนี้ใช้ได้สําหรับ UI ผ่านทาง
PlayerData
พารามิเตอร์ |
|
---|---|
รัฐ |
ออบเจ็กต์ ออบเจ็กต์สถานะที่กําหนดเอง ค่าต้องไม่เป็นค่าว่าง |
- ดูเพิ่มเติม
- cast.framework.ui.PlayerData#customState
ส่งข้อผิดพลาด
sendError(senderId, requestId, type, reason, customData)
ส่งข้อผิดพลาดไปยังผู้ส่งที่ระบุ
พารามิเตอร์ |
|
---|---|
รหัสผู้ส่ง |
สตริง รหัสผู้ส่ง |
รหัสคําขอ |
หมายเลข รหัสของคําขอที่เข้ามาใหม่ซึ่งทําให้เกิดข้อผิดพลาดนี้ |
ประเภท |
cast.framework.messages.ErrorType ประเภทข้อผิดพลาด ค่าต้องไม่เป็นค่าว่าง |
สาเหตุ |
ไม่บังคับ cast.framework.messages.ErrorReason สาเหตุของข้อผิดพลาด ค่าอาจเป็นค่าว่าง |
ข้อมูลที่กําหนดเอง |
ไม่บังคับ ออบเจ็กต์ ข้อความแสดงข้อผิดพลาดเฉพาะแอปพลิเคชันของข้อความแสดงข้อผิดพลาด ค่าอาจเป็นค่าว่าง |
sendLocalMediaRequest
sendLocalMediaRequest(คําขอ)
ส่งคําขอสื่อภายในเครื่อง
พารามิเตอร์ |
|
---|---|
ส่งคำขอ |
cast.framework.messages.RequestData ค่าต้องไม่เป็นค่าว่าง |
สถานะการส่ง
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
ส่งข้อความสถานะสื่อไปยังผู้ส่งที่เฉพาะเจาะจง
พารามิเตอร์ |
|
---|---|
รหัสผู้ส่ง |
สตริง รหัสผู้ส่ง |
รหัสคําขอ |
หมายเลข รหัสของคําขอที่เข้ามาใหม่ซึ่งทําให้เกิดการตอบกลับนี้ |
includeMedia |
ไม่บังคับ บูลีน
|
ข้อมูลที่กําหนดเอง |
ไม่บังคับ ออบเจ็กต์ ข้อมูลที่กําหนดเองเฉพาะแอปพลิเคชันของข้อความสถานะ ค่าอาจเป็นค่าว่าง |
รวมถึงรายการคิว |
ไม่บังคับ บูลีน ระบุว่าต้องการรวมรายการคิวไว้ในข้อความสถานะหรือไม่ ซึ่งไม่รวม |
setIdleReason
setIdleReason(idleReason)
กําหนดเหตุผลที่โปรแกรมเล่นวิดีโออยู่ในสถานะ IDLE
ซึ่งจะทําให้แอปพลิเคชันที่ต้องการบังคับให้สถานะ IDLE
ระบุสาเหตุของการดําเนินการดังกล่าว (เช่น ข้อผิดพลาดที่กําหนดเอง)
เหตุผลที่ไม่มีการใช้งานจะถูกส่งในข้อความสถานะถัดไป
หมายเหตุ แอปพลิเคชันส่วนใหญ่ไม่จําเป็นต้องตั้งค่านี้ จําเป็นเฉพาะเมื่อแอปจําเป็นต้องทําให้ Player
เข้าสู่สถานะ IDLE
ในสถานการณ์พิเศษเท่านั้น และ SlackReason เริ่มต้นไม่ได้สะท้อนลักษณะการทํางานที่ต้องการ
พารามิเตอร์ |
|
---|---|
เหตุผลที่ไม่ใช้งาน |
cast.framework.messages.IdleReason เหตุผลที่อยู่ในสถานะ ค่าต้องไม่เป็นค่าว่าง |
setMediaElement
setMediaElement(mediaElement)
ตั้งค่า HTMLMediaElement
เพื่อใช้งาน หากตั้งค่า Promise
ของ HTMLMediaElement
ไว้ สื่อจะเริ่มเล่นหลังจากแก้ไข Promise
แล้ว
พารามิเตอร์ |
|
---|---|
องค์ประกอบสื่อ |
(HTMLMediaElement ที่ไม่เป็นค่าว่างหรือ Promise ที่ไม่เป็น Null ซึ่งมี HTMLMediaElement ที่ไม่เป็นค่าว่าง)
|
ตั้งค่าข้อมูลสื่อ
setMediaInformation(mediaInformation, opt_broadcast)
ตั้งค่าข้อมูลสื่อ
พารามิเตอร์ |
|
---|---|
ข้อมูลสื่อ |
cast.framework.messages.MediaInformation ค่าต้องไม่เป็นค่าว่าง |
Opt_Broadcast |
ไม่บังคับ บูลีน |
setMediaPlayInfoHandler
setMediaPlayInfoHandler(เครื่องจัดการ)
ตั้งค่าเครื่องจัดการให้กลับมาหรือแก้ไข cast.framework.playConfig สําหรับคําขอการโหลดเฉพาะ พารามิเตอร์เครื่องจัดการคือ LoadRequestData
และ PlaybackConfig
ที่เป็นค่าเริ่มต้นสําหรับผู้รับ (ที่ให้ไว้ใน CastReceiverOptions
) เครื่องจัดการควรส่งการกําหนดค่าการเล่นที่แก้ไขหรือ null
เพื่อป้องกันไม่ให้สื่อเล่น ค่าการแสดงผลอาจเป็น Promise
เพื่อให้รอข้อมูลจากเซิร์ฟเวอร์ได้
พารามิเตอร์ |
|
---|---|
เครื่องจัดการ |
function(non-null cast.framework.messages.LoadRequestData, null.framework.playConfig ที่ไม่เป็นค่าว่าง ฟังก์ชันสําหรับระบุการกําหนดค่าการเล่นที่เจาะจง ค่าอาจเป็นค่าว่าง |
setMediaUrlResolver
setMediaUrlResolver(แก้ปัญหา)
ตั้งค่าเครื่องจัดการเพื่อแสดง URL ของสื่อสําหรับคําขอ LOAD
เครื่องจัดการนี้จะใช้เพื่อหลีกเลี่ยงการเผยแพร่ URL เนื้อหาสื่อในสถานะสื่อได้ โดยค่าเริ่มต้น สื่อ contentId
จะใช้เป็น URL ของเนื้อหา
พารามิเตอร์ |
|
---|---|
รีโซลเวอร์ |
function(non-null cast.framework.messages.LoadRequestData) ฟังก์ชันสําหรับแก้ไข URL เนื้อหาสื่อ ค่าอาจเป็นค่าว่าง |
ตั้งค่าอินเตอร์เซ็ปเตอร์
setMessageInterceptor(ประเภท, อินเตอร์เซปเตอร์)
ตั้งค่าส่วนสกัดกั้นข้อความขาเข้าและขาออก
เจ้าหน้าที่สกัดกั้นสามารถอัปเดตข้อมูลคําขอและควรกลับไปยังข้อมูลที่อัปเดต Promise
พร้อมข้อมูลที่อัปเดต (หากไม่สามารถส่งคืนข้อมูลได้ทันที) หรือ null
หากไม่สามารถจัดการคําขอ
หมายเหตุ: หากมีผู้ส่งข้อความการดักจับข้อความ LOAD
แต่ไม่มีตัวแยก
แบบ PRELOAD
จะมีการเรียกใช้จุดตัดข้อความ LOAD
สําหรับข้อความ PRELOAD
พารามิเตอร์ |
|
---|---|
ประเภท |
cast.framework.messages.MessageType ค่าต้องไม่เป็นค่าว่าง |
สกัดกั้น |
function(non-null cast.framework.messages.RequestData) ค่าอาจเป็นค่าว่าง |
ตั้งค่าการกําหนดค่าการเล่น
setPlayConfig(playbackConfig)
ตั้งการกําหนดค่าการเล่นใน PlayerManager
พารามิเตอร์ |
|
---|---|
การกําหนดค่าการเล่น |
ค่าต้องไม่เป็นค่าว่าง |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, castStatus)
ตั้งค่าคําสั่งสื่อที่ตัวรับสัญญาณรองรับ
พารามิเตอร์ |
|
---|---|
คําสั่งสื่อที่รองรับ |
หมายเลข คําสั่งคําสั่งสื่อที่แอปพลิเคชันรองรับ |
สถานะการออกอากาศ |
ไม่บังคับ บูลีน
|
- ดูเพิ่มเติม
- cast.framework.messages.Command
หยุด
หยุด()
หยุดสื่อที่เล่นอยู่