مدیر جریان کلاس


مدیریت جریان‌های درج تبلیغات پویا. این کلاس تعاملات با سرورهای DAI را مدیریت می‌کند، پینگ‌های ردیابی را مدیریت می‌کند و رویدادهای پخش جریان و تبلیغات را منتشر می‌کند.
سازنده‌ها
constructor
روش‌ها
add Event Listener
یک شنونده (listener) برای نوع رویداد داده شده اضافه می‌کند.
content Time For Stream Time
مدت زمان پخش محتوا بدون تبلیغات را برای یک زمان پخش مشخص برمی‌گرداند.
focus
در صورت وجود، فوکوس را روی دکمه‌ی رد شدن قرار می‌دهد.
get Ad Skippable State
اگر کاربر بتواند تبلیغ فعلی را رد کند، مقدار true را برمی‌گرداند.
load Stream Metadata
از DAI SDK درخواست می‌کند تا متادیتای تبلیغ را بارگذاری کند و رویداد پخش جریان LOADED را منتشر می‌کند.
on Timed Metadata
در یک دیکشنری از فراداده‌های پردازش‌شده قرار می‌گیرد.
previous Cue Point For Stream Time
نقطه شروع قبلی را برای زمان پخش داده شده برمی‌گرداند.
process Metadata
فراداده‌های زمان‌بندی‌شده برای جریان‌ها را پردازش می‌کند.
remove Event Listener
یک شنونده (listener) را برای نوع رویداد StreamEvent داده شده حذف می‌کند.
replace Ad Tag Parameters
جایگزین تمام پارامترهای برچسب تبلیغ مورد استفاده برای درخواست‌های تبلیغ آتی برای پخش زنده می‌شود.
request Stream
با استفاده از پارامترهای ارائه شده، درخواست بارگذاری یک جریان برای IMA DAI را می‌دهد.
reset
مدیر جریان را مجدداً تنظیم می‌کند و هرگونه نظرسنجی مداوم را حذف می‌کند.
stream Time For Content Time
کل زمان پخش زنده به همراه تبلیغات را برای یک محتوای مشخص برمی‌گرداند.

سازنده‌ها


سازنده

new StreamManager ( videoElement : HTMLVideoElement , adUiElement ?: HTMLElement , uiSettings ?: UiSettings ) : StreamManager
پارامترها
videoElement : HTMLVideoElement عنصر ویدئوی HTML که پخش در آن رخ می‌دهد.
Optional adUiElement : HTMLElement عنصری که رابط کاربری تبلیغ در آن رندر می‌شود.
Optional uiSettings : UiSettings تنظیمات رابط کاربری مورد استفاده برای این استریم.
بازگشت‌ها
StreamManager

روش‌ها


addEventListener

addEventListener ( type : Type | Type [] , listener : ( ( event : StreamEvent ) => void ) ) : void
یک شنونده (listener) برای نوع رویداد داده شده اضافه می‌کند.
پارامترها
type : Type | Type [] نوع رویداد تبلیغ یا مجموعه‌ای از انواع رویدادها.
listener : ( ( event : StreamEvent ) => void ) یک تابع فراخوانی برای شنونده‌ی تبلیغ.

زمان برای پخش محتوا

contentTimeForStreamTime ( streamTime : number ) : number
مدت زمان پخش محتوا بدون تبلیغات را برای یک زمان پخش مشخص برمی‌گرداند. مدت زمان پخش مشخص برای پخش زنده را برمی‌گرداند.
پارامترها
streamTime : number زمان پخش زنده بر حسب ثانیه، شامل ترکیب محتوا و تبلیغات.
بازگشت‌ها
number زمان پخش محتوا برای زمان پخش داده شده، بدون احتساب تبلیغات.

تمرکز

focus ( ) : void
در صورت وجود، فوکوس را روی دکمه‌ی رد شدن قرار می‌دهد. در صورت عدم وجود، فوکوس دوباره روی عنصر تعاملی قرار می‌گیرد.

getAdSkippableState

getAdSkippableState ( ) : boolean
اگر کاربر بتواند تبلیغ فعلی را رد کند، مقدار true را برمی‌گرداند. وقتی این مقدار تغییر کند، کلاس StreamManager رویداد استریم SKIPPABLE_STATE_CHANGED را منتشر می‌کند.
بازگشت‌ها
boolean اگر کاربر بتواند تبلیغ فعلی را رد کند، true و در غیر این صورت false .

بارگذاریفراداده

loadStreamMetadata ( ) : void
از DAI SDK درخواست می‌کند تا متادیتای تبلیغات را بارگذاری کند و رویداد پخش جریان LOADED را منتشر می‌کند. هنگام بازیابی مانیفست پخش جریان از دستگاه دوخت ویدیوی شخص ثالث، این متد را به صورت دستی فراخوانی کنید. این متد فقط برای پخش جریان‌های VOD از طریق دستگاه دوخت ویدیوی شخص ثالث است.

فراداده‌ی زمان‌بندی‌شده

onTimedMetadata ( metadata : {
  [ key : string ] : string ;
} ) : void
یک دیکشنری از فراداده‌های پردازش‌شده ارسال می‌کند. دیکشنری انتظار دارد دقیقاً کلید "TXXX" با رشته فراداده تعریف‌شده توسط کاربر به عنوان مقدار باشد. اگر پخش‌کننده شما فراداده خام ارائه می‌دهد، به جای آن متد StreamManager.processMetadata را فراخوانی کنید.
پارامترها
metadata : {
  [ key : string ] : string ;
}
فرهنگ لغت فراداده.

قبلیCuePointForStreamTime

previousCuePointForStreamTime ( streamTime : number ) : CuePoint
نقطه شروع قبلی را برای زمان پخش داده شده برمی‌گرداند. اگر هیچ نقطه شروع قبلی وجود نداشته باشد، null را برمی‌گرداند. از این متد برای پیاده‌سازی ویژگی‌هایی مانند snapback با فراخوانی متد زمانی که کاربر می‌خواهد کاربر را به یک وقفه تبلیغاتی بازگرداند، استفاده کنید.
پارامترها
streamTime : number زمان پخش جریانی که کاربر به دنبال آن است.
بازگشت‌ها
CuePoint نقطه شروع قبلی برای زمان پخش داده شده.

فراداده فرآیند

processMetadata ( type : string , data : string | Uint8Array , timestamp : number ) : void
فراداده‌های زمان‌بندی‌شده برای جریان‌ها را پردازش می‌کند. اگر پخش‌کننده ویدیوی شما فراداده‌های تجزیه‌نشده با مهرهای زمانی ارائه می‌دهد، از این روش استفاده کنید. در غیر این صورت، StreamManager.onTimedMetadata را فراخوانی کنید.
پارامترها
type : string برای فراداده تایپ کنید. برای HLS باید رشته 'ID3' یا برای DASH باید شناسه طرح پیام رویداد (ID URI) باشد.
data : string | Uint8Array داده‌های برچسب خام. برای ID3، باید کل داده‌های برچسب خام باشد. برای پیام‌های رویداد DASH، این رشته داده پیام است.
timestamp : number زمان پردازش داده‌ها بر حسب ثانیه. برای DASH، این پارامتر زمان شروع پیام رویداد است.

حذف رویدادشنیست

removeEventListener ( type : Type , listener : ( ( event : StreamEvent ) => void ) ) : void
یک شنونده (listener) را برای نوع رویداد StreamEvent داده شده حذف می‌کند. برای حذف موفقیت‌آمیز یک شنونده، پارامتر شنونده‌ای که به این متد ارسال می‌کنید باید با پارامتری که قبلاً به متد addEventListener ارسال شده بود، برابر باشد.
پارامترها
type : Type نوع رویدادی که شنونده برای آن حذف می‌شود.
listener : ( ( event : StreamEvent ) => void ) تابعی برای حذف به عنوان شنونده.

پارامترهای جایگزین AdTag

replaceAdTagParameters ( adTagParameters : {
  [ key : string ] : string ;
} ) : void
جایگزین تمام پارامترهای برچسب تبلیغ مورد استفاده برای درخواست‌های تبلیغ آتی برای پخش زنده می‌شود.
پارامترها
adTagParameters : {
  [ key : string ] : string ;
}
پارامترهای تگ تبلیغ جایگزین. باید دارای مقادیر رشته‌ای باشند.

درخواست جریان

requestStream ( streamRequest : StreamRequest ) : void
با استفاده از پارامترهای ارائه شده، درخواست بارگذاری یک جریان برای IMA DAI را می‌دهد.
پارامترها
streamRequest : StreamRequest شامل پارامترهایی برای بارگذاری فراداده‌های جریان است.

تنظیم مجدد

reset ( ) : void
مدیر جریان را مجدداً تنظیم می‌کند و هرگونه نظرسنجی مداوم را حذف می‌کند.

streamTimeForContentTime

streamTimeForContentTime ( contentTime : number ) : number
کل زمان پخش زنده با تبلیغات را برای یک زمان محتوای مشخص برمی‌گرداند. زمان محتوای مشخص شده برای پخش زنده را برمی‌گرداند.
پارامترها
contentTime : number زمان محتوا بدون هیچ تبلیغی در عرض چند ثانیه.
بازگشت‌ها
number کل زمان پخش زنده که با زمان محتوای داده شده پس از درج تبلیغات توسط DAI مطابقت دارد.