ชั้นเรียน: BreakManager

cast.เฟรมเวิร์ก.ช่วงพักโฆษณาBreakManager

class   static

ชั้นเรียนสำหรับจัดการช่วงพัก

วิธีการ

addBreak

addBreak(breakData, breakClips, broadCastMediaStatus) แสดงบูลีน

เพิ่มช่วงพักและคลิปหยุดพักแบบไดนามิก คลิปพักจะเชื่อมโยงกับช่วงพัก (break.breakClipIds และ break.duration จะอัปเดตตามคลิป)

พารามิเตอร์
breakData	cast.framework.messages.Break ค่าต้องไม่เป็นค่าว่าง
breakClips	อาร์เรย์ของ cast.framework.messages.BreakClip ที่ไม่มีค่า Null ค่าต้องไม่เป็นค่าว่าง
broadCastMediaStatus	ไม่บังคับ boolean CAF ควรตรวจสอบว่าสถานะช่วงพักโฆษณาปัจจุบันมีการเปลี่ยนแปลงหรือไม่ วิธีนี้อาจไม่เป็นที่ต้องการก่อนที่ จะเริ่มเล่น เนื่องจากผู้รับอาจต้องเพิ่มช่วงพัก (เช่น ระหว่างการโหลดเสร็จสมบูรณ์)

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

boolean จริงหากเพิ่มช่วงพักสำเร็จ

getBreakById

getBreakById(id) แสดงผล cast.framework.messages.Break

รับช่วงพักโฆษณาปัจจุบันตามรหัส

พารามิเตอร์
id	สตริง รหัสช่วงพักโฆษณา

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

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) returns cast.framework.messages.BreakClip

รับคลิปพักสื่อปัจจุบันตามรหัส

พารามิเตอร์
id	สตริง รหัสคลิป

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

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() จะแสดงผลตัวเลข

แสดงผลเวลาปัจจุบันในหน่วยวินาทีของคลิปหยุดพักที่กำลังเล่นอยู่

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

nullable number เวลาปัจจุบันในหน่วยวินาทีภายในคลิปหยุดพักปัจจุบัน Null หากโปรแกรมเล่นไม่ได้เล่นคลิปพัก

getBreakClipDurationSec

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

แสดงผลระยะเวลาเป็นวินาทีของคลิปหยุดพักที่กำลังเล่นอยู่

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

nullable number ระยะเวลาของคลิปพักปัจจุบัน Null หากโปรแกรมเล่นไม่ได้เล่นคลิปพัก

getBreakClips

getBreakClips() แสดงผลอาร์เรย์ของ cast.framework.messages.BreakClip ที่ไม่เป็นค่าว่าง

รับคลิปพักสื่อที่เป็นปัจจุบัน

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

non-null Array of non-null cast.framework.messages.BreakClip 

getBreaks

getBreaks() แสดงผลอาร์เรย์ของ cast.framework.messages.Break ที่ไม่เป็นค่าว่าง

รับช่วงพักสื่อปัจจุบัน

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

non-null Array of non-null cast.framework.messages.Break 

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) จะแสดงผล cast.framework.breaks.CreativeInformation

รับข้อมูลครีเอทีฟโฆษณาที่เชื่อมโยงกับเบรกคลิปตามรหัส

พารามิเตอร์
breakClipId	สตริง รหัสคลิป

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

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

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

แสดงค่า "จริง" หากควรเล่นช่วงพักที่ดู

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

boolean 

removeBreakById

removeBreakById(breakId) แสดงบูลีน

นำคลิปหยุดพักและคลิปหยุดพักที่เกี่ยวข้องออก

พารามิเตอร์
breakId	สตริง รหัสช่วงพักโฆษณา

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

boolean จริงหากนำช่วงพักออกเรียบร้อยแล้ว

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

มีตัวตรวจจับเพื่อให้นักพัฒนาซอฟต์แวร์แทรกคลิปพักเพิ่มเติมหรือแก้ไขคลิปหยุดพักปัจจุบันก่อนเริ่มช่วงพักได้

หากตัวตรวจจับมีค่า Null ระบบจะรีเซ็ตตัวตรวจจับเป็นค่าเริ่มต้น โดยค่าเริ่มต้น การดึงข้อมูล VAST และการแยกวิเคราะห์ตรรกะในตัวตรวจจับเริ่มต้น ดังนั้นหากนักพัฒนาซอฟต์แวร์ตั้งค่าตัวตรวจจับที่กำหนดเอง ระบบจะลบล้างตรรกะ VAST และนักพัฒนาซอฟต์แวร์ควรใช้ตรรกะการดึงข้อมูลและแยกวิเคราะห์ VAST ของตนในตัวตรวจจับที่ให้มา

พารามิเตอร์
ผู้ดักจับ	function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) ตัวตรวจจับการโหลดคลิปที่เป็นค่าเริ่มต้นจะแสดงคลิปหยุดพักเดียวกันกับอินพุต ค่าอาจเป็น Null

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

มอบตัวตรวจจับเพื่อให้นักพัฒนาแอประบุช่วงพักที่ต้องการเล่นหลังจากการกรอ

พารามิเตอร์
seekInterceptor	function(non-null cast.framework.breaks.BreakSeekData) ตัวตัดสัญญาณหรือ Null หากนักพัฒนาแอปต้องการรีเซ็ตเป็นค่าเริ่มต้น ตัวตรวจจับช่วงพักที่เป็นค่าเริ่มต้นจะแสดงช่วงพักที่ใกล้เคียงที่สุดจากค่า SeeTo ค่าอาจเป็น Null

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

ตั้งค่าธงเพื่อควบคุมว่าควรเล่นช่วงพักการเย็บไคลเอ็นต์ที่ดูแล้วหรือไม่

พารามิเตอร์
playWatchedBreak	boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

ระบุตัวตรวจจับเพื่อแก้ไข URL ติดตาม VAST ก่อนที่จะส่ง URL ไปยังเซิร์ฟเวอร์ ข้อมูลที่ป้อนของตัวตรวจจับคือสตริงของ URL ติดตาม ตัวตรวจจับอาจแสดงสตริง URL ที่มีการแก้ไขหรือ "คำมั่นสัญญาของสตริง URL ที่มีการแก้ไข" ก็ได้ ตัวสกัดกั้นยังสามารถแสดงผลเป็นค่าว่างได้ในกรณีที่คุณต้องการส่ง URL ติดตามผลโดยใช้โค้ดของคุณเองแทนการส่งด้วย CAF

พารามิเตอร์
ผู้ดักจับ	ฟังก์ชัน(สตริง) ตัวคัดกรองซึ่งแก้ไข URL ก่อนที่จะส่ง ค่าอาจเป็น Null