ชั้นเรียน: StreamManager

ผู้ผลิต

StreamManager

ใหม่ StreamManager(videoElement, adUiElement, uiSettings)

พารามิเตอร์

videoElement

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

ค่าต้องไม่เป็นค่าว่าง

adUiElement

ไม่บังคับ

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

ค่าต้องไม่เป็นค่าว่าง

uiSettings

ไม่บังคับ

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

ค่าต้องไม่เป็นค่าว่าง

การใช้งาน
EventTarget
การขว้าง

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

วิธีการ

contentTimeForStreamTime

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

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

พารามิเตอร์

streamTime

ตัวเลข

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

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

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

โฟกัส

โฟกัส()

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

getAdSkippableState

getAdcrossState() แสดงบูลีน

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

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

boolean จริง หากข้ามโฆษณาได้ในปัจจุบัน หากไม่เลือกให้เป็นเท็จ

loadStreamMetadata

loadStreamMetadata()

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

onTimedMetadata

onTimedMetadata(metadata)

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

พารามิเตอร์

ข้อมูลเมตา

ออบเจ็กต์

พจนานุกรมของข้อมูลเมตา

ค่าต้องไม่เป็นค่าว่าง

previousCuePointForStreamTime

beforeCuePointForStreamTime(streamTime) แสดงผล CuePoint

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

พารามิเตอร์

streamTime

ตัวเลข

เวลาที่ต้องการสตรีม

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

nullable CuePoint จุดเริ่มโฆษณาก่อนหน้าสำหรับเวลาสตรีมที่ระบุ

processMetadata

processMetadata(type, data, timestamp)

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

พารามิเตอร์

ประเภท

สตริง

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

ข้อมูล

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

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

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

ตัวเลข

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

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

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

พารามิเตอร์

adTagParameters

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

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

ค่าต้องไม่เป็นค่าว่าง

requestStream

requestStream(streamRequest)

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

พารามิเตอร์

streamRequest

StreamRequest

มีพารามิเตอร์สำหรับโหลดข้อมูลเมตาของสตรีม

ค่าต้องไม่เป็นค่าว่าง

ตั้งค่าใหม่

รีเซ็ต()

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

setClickElement

setClickElement(clickElement)

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

พารามิเตอร์

clickElement

องค์ประกอบ

องค์ประกอบที่ใช้เป็นการคลิกผ่าน

ค่าอาจเป็น Null

เลิกใช้
ใส่ adUiElement ลงในเครื่องมือสร้าง StreamManager แทน

streamTimeForContentTime

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

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

พารามิเตอร์

contentTime

ตัวเลข

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

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

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