Class StreamManager


จัดการสตรีมการแทรกโฆษณาแบบไดนามิก คลาสนี้จัดการการโต้ตอบกับเซิร์ฟเวอร์ DAI จัดการการปิงการติดตาม และปล่อยเหตุการณ์สตรีมและโฆษณา
ผู้ผลิต
constructor
เมธอด
addEventListener
เพิ่ม Listener สำหรับประเภทเหตุการณ์ที่ระบุ
contentTimeForStreamTime
แสดงเวลาของเนื้อหาที่ไม่มีโฆษณาสำหรับเวลาสตรีมที่ระบุ
focus
โฟกัสที่ปุ่มข้าม (หากมี)
getAdSkippableState
แสดงค่า true หากผู้ใช้ข้ามโฆษณาปัจจุบันได้
loadStreamMetadata
ขอให้ DAI SDK โหลดข้อมูลเมตาของโฆษณาและปล่อยเหตุการณ์ LOADED stream
onTimedMetadata
ส่งในพจนานุกรมของข้อมูลเมตาที่ประมวลผลแล้ว
previousCuePointForStreamTime
แสดงผลคิวพอยต์ก่อนหน้าสำหรับเวลาสตรีมที่ระบุ
processMetadata
ประมวลผลข้อมูลเมตาที่กำหนดเวลาไว้สำหรับสตรีม
removeEventListener
นำ Listener สำหรับประเภทเหตุการณ์ StreamEvent ที่ระบุออก
replaceAdTagParameters
แทนที่พารามิเตอร์แท็กโฆษณาทั้งหมดที่ใช้สำหรับคำขอโฆษณาที่กำลังมาใหม่สำหรับสตรีมแบบสด
requestStream
ขอสตรีมสำหรับ IMA DAI เพื่อโหลดโดยใช้พารามิเตอร์สตรีมที่ระบุ
reset
รีเซ็ต Stream Manager และนำการสำรวจอย่างต่อเนื่องออก
streamTimeForContentTime
แสดงเวลาสตรีมทั้งหมดที่มีโฆษณาสำหรับเวลาเนื้อหาที่ระบุ

ผู้ผลิต


constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
พารามิเตอร์
videoElement: HTMLVideoElement องค์ประกอบวิดีโอ HTML ที่มีการเล่น
Optional adUiElement: HTMLElement องค์ประกอบที่ UI ของโฆษณาแสดง
Optional uiSettings: UiSettings การตั้งค่า UI ที่จะใช้สำหรับสตรีมนี้
การคืนสินค้า
StreamManager

เมธอด


addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
เพิ่ม Listener สำหรับประเภทเหตุการณ์ที่ระบุ
พารามิเตอร์
type: Type | Type[] ประเภทเหตุการณ์โฆษณาหรืออาร์เรย์ของประเภทเหตุการณ์
listener: ((event: StreamEvent) => void) ฟังก์ชัน Callback สำหรับเครื่องมือฟังโฆษณา

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
แสดงเวลาของเนื้อหาที่ไม่มีโฆษณาสำหรับเวลาสตรีมที่ระบุ แสดงผลเวลาของสตรีมที่ระบุ สำหรับไลฟ์สด
พารามิเตอร์
streamTime: number เวลาสตรีมเป็นวินาที โดยรวมเนื้อหาและโฆษณา
การคืนสินค้า
number เวลาของเนื้อหาสำหรับเวลาสตรีมที่ระบุ โดยไม่รวมโฆษณา

โฟกัส

focus(): void
โฟกัสไปที่ปุ่มข้าม (หากมี) หากไม่มีโฟกัส ระบบจะย้ายโฟกัสกลับไปที่ องค์ประกอบแบบอินเทอร์แอกทีฟ

getAdSkippableState

getAdSkippableState(): boolean
แสดงค่า true หากผู้ใช้ข้ามโฆษณาปัจจุบันได้ เมื่อค่านี้ เปลี่ยนแปลง คลาส StreamManager จะปล่อย เหตุการณ์สตรีม SKIPPABLE_STATE_CHANGED
การคืนสินค้า
boolean true หากผู้ใช้ข้ามโฆษณาปัจจุบันได้ false มิเช่นนั้น

loadStreamMetadata

loadStreamMetadata(): void
ขอให้ DAI SDK โหลดข้อมูลเมตาของโฆษณาและปล่อยLOADEDเหตุการณ์สตรีม เรียกใช้เมธอดนี้ด้วยตนเองเมื่อดึงข้อมูลไฟล์ Manifest ของสตรีมจากโปรแกรมรวมวิดีโอของบุคคลที่สาม วิธีนี้ใช้ได้กับสตรีม VOD ที่แสดงในพ็อดที่มีโปรแกรมต่อวิดีโอของบุคคลที่สามเท่านั้น

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
ส่งในพจนานุกรมของข้อมูลเมตาที่ประมวลผลแล้ว พจนานุกรมคาดหวังคีย์ที่แน่นอน "TXXX" โดยมีสตริงข้อมูลเมตาที่ผู้ใช้กำหนดเป็นค่า หากเพลเยอร์ ให้ข้อมูลเมตาดิบ ให้เรียกใช้เมธอด StreamManager.processMetadata แทน
พารามิเตอร์
metadata: {
  [key: string]: string;
}
พจนานุกรมของข้อมูลเมตา

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
แสดงผลคิวพอยต์ก่อนหน้าสำหรับเวลาสตรีมที่ระบุ หากไม่มี Cue Point ก่อนหน้า จะแสดง null ใช้วิธีนี้เพื่อใช้ฟีเจอร์ต่างๆ เช่น Snapback โดยการเรียกใช้เมธอดเมื่อผู้ใช้ต้องการกลับไปยังช่วงพักโฆษณา
พารามิเตอร์
streamTime: number เวลาสตรีมที่ผู้ใช้ต้องการ
การคืนสินค้า
CuePoint คิวพอยต์ก่อนหน้าสำหรับเวลาสตรีมที่ระบุ

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
ประมวลผลข้อมูลเมตาที่กำหนดเวลาไว้สำหรับสตรีม ใช้วิธีนี้หากวิดีโอเพลเยอร์มี ข้อมูลเมตาที่ยังไม่ได้แยกวิเคราะห์พร้อมการประทับเวลา หรือเรียกใช้ StreamManager.onTimedMetadata
พารามิเตอร์
type: string ประเภทสำหรับข้อมูลเมตา ต้องเป็นสตริง 'ID3' สำหรับ HLS หรือ URI รหัสรูปแบบข้อความเหตุการณ์สำหรับ DASH
data: string | Uint8Array ข้อมูลแท็กดิบ สำหรับ ID3 ต้องเป็นข้อมูลแท็กดิบทั้งหมด สำหรับข้อความเหตุการณ์ DASH นี่คือสตริงข้อมูลข้อความ
timestamp: number เวลาในหน่วยวินาทีที่จะประมวลผลข้อมูล สำหรับ DASH พารามิเตอร์นี้คือเวลาเริ่มต้นของข้อความเหตุการณ์

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
นำ Listener สำหรับประเภทเหตุการณ์ StreamEvent ที่ระบุออก หากต้องการนำ Listener ออกให้สำเร็จ พารามิเตอร์ Listener ที่คุณส่งไปยังเมธอดนี้ ต้องเท่ากันโดยการอ้างอิงกับพารามิเตอร์ที่ส่งไปยังเมธอด addEventListener ก่อนหน้านี้
พารามิเตอร์
type: Type ประเภทของเหตุการณ์ที่จะนำ Listener ออก
listener: ((event: StreamEvent) => void) ฟังก์ชันในการนำออกจากการเป็นผู้ฟัง

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
แทนที่พารามิเตอร์แท็กโฆษณาทั้งหมดที่ใช้สำหรับคำขอโฆษณาที่กำลังมาใหม่สำหรับสตรีมแบบสด
พารามิเตอร์
adTagParameters: {
  [key: string]: string;
}
พารามิเตอร์แท็กโฆษณาที่จะใช้แทน ต้องมีค่าสตริง

requestStream

requestStream(streamRequest: StreamRequest): void
ขอสตรีมสำหรับ IMA DAI เพื่อโหลดโดยใช้พารามิเตอร์สตรีมที่ระบุ
พารามิเตอร์
streamRequest: StreamRequest มีพารามิเตอร์ในการโหลดข้อมูลเมตาสตรีม

รีเซ็ต

reset(): void
รีเซ็ต Stream Manager และนำการสำรวจอย่างต่อเนื่องออก

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
แสดงเวลาสตรีมทั้งหมดที่มีโฆษณาสำหรับเวลาเนื้อหาที่ระบุ แสดงเวลาเนื้อหาที่ระบุสำหรับไลฟ์สด
พารามิเตอร์
contentTime: number เวลาของเนื้อหาที่ไม่มีโฆษณาเป็นวินาที
การคืนสินค้า
number เวลาสตรีมทั้งหมดที่สอดคล้องกับเวลาเนื้อหาที่ระบุหลังจากที่ DAI แทรกโฆษณา