StreamManager
จัดการสตรีมการแทรกโฆษณาแบบไดนามิก โดยจะจัดการการโต้ตอบกับ แบ็กเอนด์ DAI และจัดการคำสั่ง ping ของการติดตาม รวมถึงการส่งต่อสตรีมและเหตุการณ์โฆษณาไปยังผู้เผยแพร่โฆษณา บัญชีดูแลจัดการนี้ไม่ได้รับช่วงมาจาก BaseAdsManager เนื่องจากไม่ใช่ผู้จัดการสำหรับโฆษณาใดโดยเฉพาะ แต่เป็นตัวจัดการสำหรับทั้งสตรีม
ผู้ผลิต
StreamManager
ใหม่ StreamManager(videoElement, adUiElement, uiSettings)
พารามิเตอร์ |
|
|---|---|
|
videoElement |
องค์ประกอบวิดีโอ HTML ที่การเล่นจะเกิดขึ้น ค่าต้องไม่เป็นค่าว่าง |
|
adUiElement |
ไม่บังคับ องค์ประกอบ HTML ที่จะใช้ในการเก็บองค์ประกอบ UI โฆษณา องค์ประกอบนี้ควรมีความสูงและความกว้างเท่ากับการเล่นวิดีโอ และควรซ้อนทับองค์ประกอบดังกล่าวโดยตรง หากไม่ระบุ UI จะไม่แสดง และจะไม่ขอโฆษณาที่ต้องใช้ UI เช่น โฆษณาที่ข้ามได้ ค่าต้องไม่เป็นค่าว่าง |
|
uiSettings |
ไม่บังคับ การตั้งค่า UI ที่จะใช้สำหรับสตรีมนี้ ค่าต้องไม่เป็นค่าว่าง |
- การขว้าง
-
เมื่อพารามิเตอร์อินพุตไม่เป็นไปตามข้อกำหนด
วิธีการ
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) แสดงตัวเลข
แสดงผลเวลาของเนื้อหาโดยไม่มีโฆษณาสำหรับเวลาการสตรีมที่ระบุ แสดงผลเวลาสตรีมที่ระบุสำหรับสตรีมแบบสด
พารามิเตอร์ |
|
|---|---|
|
streamTime |
ตัวเลข เวลาสตรีมที่มีโฆษณาที่แทรก (เป็นวินาที) |
- การคืนสินค้า
-
numberเวลาของเนื้อหาที่ตรงกับเวลาของสตรีมที่ระบุเมื่อมีการนำโฆษณาออก
โฟกัส
โฟกัส()
โฟกัสที่ปุ่มข้าม หากมี หากไม่มี โฟกัสจะอยู่ที่องค์ประกอบแบบอินเทอร์แอกทีฟ รวมถึงไอคอนหรือครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ
getAdSkippableState
getAddoubleclickState() แสดงผลบูลีน
แสดงค่า "จริง" หากข้ามโฆษณาได้ในขณะนี้ เมื่อค่านี้มีการเปลี่ยนแปลง StreamManager จะเริ่มเหตุการณ์ StreamEvent.SKIPPABLE_STATE_CHANGED
- การคืนสินค้า
-
booleanจริง หากสามารถข้ามโฆษณาได้ในขณะนี้ แต่หากไม่เป็นเช่นนั้น
loadStreamMetadata
loadStreamMetadata()
ขอ SDK เพื่อโหลดข้อมูลเมตาของโฆษณา แล้วเผยแพร่ StreamEvent.LOADED สิ่งนี้ควรทริกเกอร์ด้วยตนเองเมื่อได้ไฟล์ Manifest ของสตรีมจากเครื่องมือต่อเชื่อมวิดีโอของบุคคลที่สามแล้ว ตัวเลือกนี้ใช้สำหรับ VOD ที่แสดงในพ็อดที่มีเครื่องมือต่อเชื่อมวิดีโอของบุคคลที่สามเท่านั้น และจะไม่ดำเนินการสำหรับคำขอสตรีมอื่นๆ
onTimedMetadata
onTimedMetadata(metadata)
บัตรในพจนานุกรมของข้อมูลเมตาที่ประมวลผล พจนานุกรมต้องการคีย์ "TXXX" ที่มีสตริงข้อมูลเมตาที่ผู้ใช้กำหนดเป็นค่า หากโปรแกรมเล่นของคุณมีข้อมูลเมตาดิบ ให้เรียกใช้ StreamManager.processMetadata แทน
พารามิเตอร์ |
|
|---|---|
|
ข้อมูลเมตา |
ออบเจ็กต์ พจนานุกรมของข้อมูลเมตา ค่าต้องไม่เป็นค่าว่าง |
previousCuePointForStreamTime
ก่อนหน้าCuePointForStreamTime(streamTime) แสดงผล CuePoint
แสดงจุดเริ่มโฆษณาก่อนหน้าสำหรับเวลาสตรีมที่ระบุ แสดงผล Null หากไม่มีจุดเริ่มโฆษณาดังกล่าว โดยจะใช้เพื่อใช้งานฟีเจอร์ต่างๆ เช่น การสแนปกลับ และเรียกใช้เมื่อผู้เผยแพร่โฆษณาตรวจพบว่าผู้ใช้ต้องการเพื่อนำผู้ใช้ไปยังช่วงพักโฆษณา
พารามิเตอร์ |
|
|---|---|
|
streamTime |
ตัวเลข เวลาสตรีมที่ต้องการ |
- การคืนสินค้า
-
nullable CuePointจุดเริ่มโฆษณาก่อนหน้าสำหรับเวลาสตรีมที่ระบุ
processMetadata
processMetadata(type, data, timestamp)
ประมวลผลข้อมูลเมตาที่กำหนดเวลาไว้สำหรับสตรีมแบบสด ใช้ในกรณีที่โปรแกรมเล่นวิดีโอมีข้อมูลเมตาที่ไม่ได้แยกวิเคราะห์พร้อมกับการประทับเวลา หรือให้เรียกใช้ StreamManager.onTimedMetadata
พารามิเตอร์ |
|
|---|---|
|
ประเภท |
string พิมพ์ข้อมูลเมตา ต้องเป็น "ID3" สำหรับ HLS หรือ URI รหัสรูปแบบข้อความเหตุการณ์สำหรับ DASH |
|
ข้อมูล |
(อาร์เรย์หรือสตริง Uint8 ที่ไม่เป็นค่าว่าง) ข้อมูลแท็กดิบ สำหรับ ID3 ต้องเป็นข้อมูลแท็กดิบทั้งหมด สำหรับข้อความเหตุการณ์ DASH นี่คือสตริงข้อมูลข้อความ |
|
การประทับเวลา |
ตัวเลข เวลาเป็นวินาทีที่ควรประมวลผลข้อมูล สำหรับ DASH นี่คือเวลาเริ่มต้นของข้อความกิจกรรม |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
แทนที่พารามิเตอร์แท็กโฆษณาทั้งหมดที่ใช้สำหรับคำขอโฆษณาที่กำลังจะมาถึงสำหรับสตรีมแบบสด
พารามิเตอร์ |
|
|---|---|
|
adTagParameters |
ออบเจ็กต์ที่มีพร็อพเพอร์ตี้สตริง พารามิเตอร์แท็กโฆษณาใหม่ ต้องมีค่าสตริง ค่าต้องไม่เป็นค่าว่าง |
requestStream
requestStream(streamRequest)
ขอให้โหลดสตรีมโดยใช้พารามิเตอร์สตรีมที่ระบุไว้
พารามิเตอร์ |
|
|---|---|
|
streamRequest |
มีพารามิเตอร์ที่จะโหลดข้อมูลเมตาของสตรีม ค่าต้องไม่เป็นค่าว่าง |
ตั้งค่าใหม่
รีเซ็ต()
รีเซ็ตตัวจัดการสตรีมและนำแบบสำรวจที่ต่อเนื่องออก
setClickElement
setClickElement(clickElement)
ตั้งค่าองค์ประกอบการคลิกผ่านของโฆษณา ระบบใช้องค์ประกอบนี้เป็นตัวรับการคลิกหรือแตะขณะที่โฆษณากำลังเล่นอยู่ และอาจส่งผลให้มีการออกจากหน้าปัจจุบัน ขณะนี้เลิกใช้งานแล้ว และควรส่ง adUiElement ใน StreamManager แทน หากมีการกำหนด adUiElement กับตัวสร้าง StreamManager เมธอดนี้จะกลายเป็น no-op
พารามิเตอร์ |
|
|---|---|
|
clickElement |
องค์ประกอบ องค์ประกอบที่ใช้เป็นการคลิกผ่านโฆษณา ค่าอาจเป็น Null |
- เลิกใช้
- ระบุ adUiElement ไปยังตัวสร้าง StreamManager แทน
streamTimeForContentTime
StreamTimeForContentTime(contentTime) แสดงตัวเลข
แสดงผลเวลาสตรีมแบบมีโฆษณาสำหรับเวลาเนื้อหาที่ระบุ แสดงผลเวลาของเนื้อหาที่กำหนดสำหรับสตรีมแบบสด
พารามิเตอร์ |
|
|---|---|
|
contentTime |
ตัวเลข เวลาที่แสดงเนื้อหาที่ไม่มีโฆษณาใดๆ (เป็นวินาที) |
- การคืนสินค้า
-
numberเวลาสตรีมที่สอดคล้องกับเวลาเนื้อหาที่ระบุเมื่อมีการแทรกโฆษณา