ชั้นเรียน: StreamManager

StreamManager

class   public

จัดการสตรีมการแทรกโฆษณาแบบไดนามิก โดยจัดการการโต้ตอบกับแบ็กเอนด์ DAI รวมถึงจัดการการติดตาม Ping รวมถึงส่งต่อสตรีมและเหตุการณ์โฆษณาไปยังผู้เผยแพร่โฆษณา ตัวแฮนเดิลนี้ไม่ได้รับค่ามาจาก BaseAdsManager เนื่องจากไม่ใช่ตัวแฮนเดิลสําหรับโฆษณาที่เฉพาะเจาะจง แต่เป็นตัวแฮนเดิลสําหรับสตรีมทั้งสาย

ผู้ผลิต

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

เครื่องมือสร้าง

พารามิเตอร์

videoElement

องค์ประกอบวิดีโอ HTML ที่จะเริ่มเล่น

ค่าต้องไม่เท่ากับ Null

adUiElement

ไม่บังคับ

องค์ประกอบ HTML ที่จะใช้เก็บองค์ประกอบ UI ของโฆษณา เอลิเมนต์นี้ควรมีความสูงและความกว้างเท่ากับการเล่นวิดีโอ และควรวางซ้อนทับวิดีโอโดยตรง หากไม่ได้ระบุ ระบบจะไม่แสดง UI และจะไม่ขอโฆษณาที่ต้องใช้ UI เช่น โฆษณาที่ข้ามได้

uiSettings

ไม่บังคับ

การตั้งค่า UI ที่จะใช้สําหรับสตรีมนี้

ค่าต้องไม่เท่ากับ Null
การโยน

เมื่อพารามิเตอร์อินพุตไม่เป็นไปตามข้อกำหนด

พร็อพเพอร์ตี้

clickElement

HTMLElement ที่ไม่ใช่ค่า Null

clickElement

HTMLElement ที่ไม่ใช่ค่า Null

streamMonitor

PodServingStreamMonitor ที่ไม่ใช่ค่า Null

เมธอด

addEventListener

addEventListener(type, listener) แสดงผลเป็น void

เพิ่ม Listener สําหรับประเภทเหตุการณ์ที่ระบุ

พารามิเตอร์

ประเภท

สตริง

ประเภทเหตุการณ์ที่จะฟัง

Listener

function(non-null StreamEvent)

ฟังก์ชันที่เรียกใช้ทุกครั้งที่มีเหตุการณ์ประเภทนี้เกิดขึ้น
การคืนสินค้า

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) แสดงผลตัวเลข

แสดงเวลาของเนื้อหาที่ไม่มีโฆษณาสำหรับเวลาสตรีมหนึ่งๆ แสดงผลเวลาสตรีมที่กำหนดสำหรับสตรีมแบบสด

พารามิเตอร์

streamTime

ตัวเลข

เวลาสตรีมที่มีโฆษณาแทรก (เป็นวินาที)
การคืนสินค้า

number เวลาของเนื้อหาที่สอดคล้องกับเวลาในสตรีมเมื่อนำโฆษณาออก

โฟกัส

focus() แสดงผลเป็น void

โฟกัสที่ปุ่มข้าม (หากมี) หากไม่มี ความสนใจจะมุ่งไปที่องค์ประกอบแบบอินเทอร์แอกทีฟ ซึ่งรวมถึงไอคอนหรือครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ

การคืนสินค้า

void 

getAdSkippableState

getAdSkippableState() แสดงผลบูลีน

แสดงค่า "จริง" หากข้ามโฆษณาได้ในขณะนี้ เมื่อค่านี้เปลี่ยนแปลง StreamManager จะเรียกเหตุการณ์ StreamEvent.SKIPPABLE_STATE_CHANGED

การคืนสินค้า

boolean เป็นจริงหากข้ามโฆษณาได้ในขณะนี้ เป็นเท็จหากข้ามไม่ได้

loadStreamMetadata

loadStreamMetadata() แสดงผลเป็น void

ขอให้ SDK โหลดข้อมูลเมตาของโฆษณา แล้วออกอากาศ StreamEvent.LOADED คุณควรเรียกใช้การดำเนินการนี้ด้วยตนเองเมื่อดึงข้อมูลไฟล์ Manifest ของสตรีมจากโปรแกรมต่อเชื่อมวิดีโอของบุคคลที่สามแล้ว ตัวเลือกนี้ใช้สำหรับ VOD ที่แสดงผ่านพ็อดด้วยโปรแกรมต่อเชื่อมวิดีโอของบุคคลที่สามเท่านั้น และจะไม่มีผลกับคำขอสตรีมอื่นๆ

การคืนสินค้า

void 

onTimedMetadata

onTimedMetadata(metadata) แสดงผลเป็น void

ส่งพจนานุกรมของข้อมูลเมตาที่ประมวลผลแล้ว พจนานุกรมจะคาดหวังว่าคีย์ "TXXX" จะมีสตริงข้อมูลเมตาที่ผู้ใช้กำหนดเป็นค่า หากโปรแกรมเล่นให้ข้อมูลเมตาดิบ ให้เรียกใช้ StreamManager.processMetadata แทน

พารามิเตอร์

ข้อมูลเมตา

(ออบเจ็กต์ Null หรือ Non-Null ที่มีพร็อพเพอร์ตี้สตริง)

พจนานุกรมข้อมูลเมตา
การคืนสินค้า

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

แสดงผลจุดเริ่มต้นก่อนหน้าสำหรับเวลาในสตรีมที่กำหนด แสดงผล Null หากไม่มีจุดเริ่มต้นดังกล่าว เหตุการณ์นี้ใช้เพื่อใช้ฟีเจอร์ต่างๆ เช่น การส่งกลับ และเรียกใช้เมื่อผู้เผยแพร่โฆษณาตรวจพบว่าผู้ใช้กรอไปข้างหน้าเพื่อส่งผู้ใช้กลับไปยังช่วงพักโฆษณา

พารามิเตอร์

streamTime

ตัวเลข

เวลาในสตรีมที่กรอไป
การคืนสินค้า

(null or non-null CuePoint) จุดเริ่มต้นก่อนหน้าสำหรับเวลาในสตรีมที่กำหนด

processMetadata

processMetadata(type, data, timestamp) แสดงผลเป็น void

ประมวลผลข้อมูลเมตาแบบกำหนดเวลาสำหรับสตรีมแบบสด ใช้ในกรณีที่โปรแกรมเล่นวิดีโอของคุณระบุข้อมูลเมตาที่ยังไม่ได้แยกวิเคราะห์พร้อมกับการประทับเวลา หากไม่ ให้เรียกใช้ StreamManager.onTimedMetadata

พารามิเตอร์

ประเภท

สตริง

ประเภทสำหรับข้อมูลเมตา ต้องเท่ากับ "ID3" สำหรับ HLS หรือ URI รหัสรูปแบบข้อความเหตุการณ์สำหรับ DASH

เพิ่มเติม

(สตริงหรือ Uint8Array ที่ไม่ใช่ค่า Null)

ข้อมูลแท็กดิบ สำหรับ ID3 ต้องเป็นข้อมูลแท็กดิบทั้งหมด สําหรับข้อความเหตุการณ์ DASH จะเป็นสตริงข้อมูลข้อความ

การประทับเวลา

ตัวเลข

เวลาเป็นวินาทีที่ควรประมวลผลข้อมูล สําหรับ DASH ข้อมูลนี้คือเวลาเริ่มต้นของข้อความเหตุการณ์
การคืนสินค้า

void 

removeEventListener

removeEventListener(type, listener) แสดงผลเป็น void

นํา Listener ของประเภทเหตุการณ์ที่ระบุออก ฟังก์ชัน Listener ต้องเท่ากับการอ้างอิงไปยังฟังก์ชันที่ส่งไปยัง addEventListener ก่อนหน้านี้

พารามิเตอร์

ประเภท

สตริง

ประเภทเหตุการณ์ที่จะนํา Listener ออก

Listener

function(non-null StreamEvent)

ฟังก์ชันสำหรับนำออกในฐานะผู้ฟัง
การคืนสินค้า

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) แสดงผลเป็น void

แทนที่พารามิเตอร์แท็กโฆษณาทั้งหมดที่ใช้สำหรับคำขอโฆษณาที่กำลังมาใหม่สำหรับสตรีมแบบสด

พารามิเตอร์

adTagParameters

ออบเจ็กต์ที่มีพร็อพเพอร์ตี้สตริง

พารามิเตอร์แท็กโฆษณาใหม่ ต้องมีค่าสตริง

ค่าต้องไม่เท่ากับ Null
การคืนสินค้า

void 

requestStream

requestStream(streamRequest) แสดงผลเป็น void

ส่งคําขอโหลดสตรีมโดยใช้พารามิเตอร์สตรีมที่ระบุ

พารามิเตอร์

streamRequest

StreamRequest

มีพารามิเตอร์เพื่อโหลดข้อมูลเมตาของสตรีม

ค่าต้องไม่เท่ากับ Null
การคืนสินค้า

void 

รีเซ็ต

reset() แสดงผลเป็น void

รีเซ็ตเครื่องมือจัดการสตรีมและนำการสำรวจอย่างต่อเนื่องออก

การคืนสินค้า

void 

setClickElement

setClickElement(clickElement) แสดงผลเป็น void

ตั้งค่าองค์ประกอบการคลิกผ่านโฆษณา องค์ประกอบนี้ใช้เป็นตัวรับการคลิกหรือการแตะขณะที่โฆษณาเล่นอยู่ และอาจส่งผลให้ไปยังส่วนอื่นๆ ภายนอกหน้าปัจจุบัน ตอนนี้เราเลิกใช้งานแล้ว และควรส่ง adUiElement ไปยัง StreamManager แทน หากมี adUiElement ให้กับเครื่องมือสร้าง StreamManager วิธีการนี้จะใช้งานไม่ได้

พารามิเตอร์

clickElement

(องค์ประกอบ Null หรือไม่ใช่ Null)

องค์ประกอบที่ใช้เป็นคลิกผ่านโฆษณา
เลิกใช้
ระบุ adUiElement ให้กับตัวสร้าง StreamManager แทน
การคืนสินค้า

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) แสดงผลตัวเลข

แสดงเวลาสตรีมที่มีโฆษณาสำหรับเวลาเนื้อหาที่ระบุ แสดงผลเวลาของเนื้อหาที่ระบุสำหรับสตรีมแบบสด

พารามิเตอร์

contentTime

ตัวเลข

ระยะเวลาของเนื้อหาที่ไม่มีโฆษณา (เป็นวินาที)
การคืนสินค้า

number เวลาสตรีมที่สอดคล้องกับเวลาของเนื้อหาที่ระบุเมื่อแทรกโฆษณา