क्लास: StreamManager

StreamManager

class   public

डाइनैमिक ऐड इंसर्शन स्ट्रीम को मैनेज करता है. यह डीआई के बैकएंड के साथ इंटरैक्शन मैनेज करता है. साथ ही, ट्रैकिंग पिंग को मैनेज करता है. इसके अलावा, पब्लिशर को स्ट्रीम और विज्ञापन इवेंट भी फ़ॉरवर्ड करता है. यह मैनेजर, BaseAdsManager से इनहेरिट नहीं करता, क्योंकि यह किसी खास विज्ञापन के लिए मैनेजर नहीं है, बल्कि पूरी स्ट्रीम के लिए मैनेजर है

निर्माता

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

कंस्ट्रक्टर.

पैरामीटर

videoElement

वह एचटीएमएल वीडियो एलिमेंट जहां वीडियो चलेगा.

वैल्यू शून्य नहीं होनी चाहिए.

adUiElement

वैकल्पिक

विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट को होल्ड करने के लिए इस्तेमाल किया जाने वाला एचटीएमएल एलिमेंट. इस एलिमेंट की लंबाई और चौड़ाई, वीडियो प्लेबैक की लंबाई और चौड़ाई के बराबर होनी चाहिए. साथ ही, यह सीधे तौर पर वीडियो पर ओवरले होना चाहिए. अगर यूआई नहीं दिया जाता है, तो कोई यूआई नहीं दिखाया जाएगा. साथ ही, स्किप किए जा सकने वाले विज्ञापनों जैसे ऐसे विज्ञापनों के लिए अनुरोध नहीं किया जाएगा जिनमें यूआई की ज़रूरत होती है.

uiSettings

वैकल्पिक

इस स्ट्रीम के लिए इस्तेमाल की जाने वाली यूज़र इंटरफ़ेस (यूआई) सेटिंग.

वैल्यू शून्य नहीं होनी चाहिए.
थ्रो

जब इनपुट पैरामीटर ज़रूरी शर्तें पूरी नहीं करते.

प्रॉपर्टी

clickElement

non-null HTMLElement

clickElement

non-null HTMLElement

streamMonitor

PodServingStreamMonitor नॉन-नल

तरीके

addEventListener

addEventListener(type, listener) void रिटर्न करता है

दिए गए इवेंट टाइप के लिए, एक लिसनर जोड़ता है.

पैरामीटर

टाइप

स्ट्रिंग

जिस इवेंट को सुनना है उसका टाइप.

लिसनर

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 ब्रॉडकास्ट करता है. तीसरे पक्ष के वीडियो स्टिचर से स्ट्रीम मेनिफ़ेस्ट हासिल करने के बाद, इसे मैन्युअल तरीके से ट्रिगर किया जाना चाहिए. इसका इस्तेमाल सिर्फ़ तीसरे पक्ष के वीडियो स्टिचर की मदद से, पॉड के तौर पर वीओडी दिखाने के लिए किया जाता है. किसी दूसरी स्ट्रीम के अनुरोध के लिए इसका इस्तेमाल नहीं किया जा सकता.

रिटर्न

void 

onTimedMetadata

onTimedMetadata(metadata) void पर वापस आता है

प्रोसेस किए गए मेटाडेटा की डिक्शनरी को पास करता है. डिक्शनरी में, वैल्यू के तौर पर उपयोगकर्ता की तय की गई मेटाडेटा स्ट्रिंग के साथ, मुख्य 'TXXX' होना चाहिए. अगर आपका प्लेयर रॉ मेटाडेटा उपलब्ध कराता है, तो इसके बजाय StreamManager.processMetadata को कॉल करें.

पैरामीटर

मेटाडेटा

(स्ट्रिंग प्रॉपर्टी वाला कोई ऑब्जेक्ट, चाहे वह शून्य हो या न हो)

मेटाडेटा की डिक्शनरी.
रिटर्न

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

स्ट्रीम के दिए गए समय के लिए, पिछला क्यूपॉइंट दिखाता है. अगर कोई ऐसा क्यूपॉइंट मौजूद नहीं है, तो यह वैल्यू शून्य दिखाती है. इसका इस्तेमाल, स्नैप बैक जैसी सुविधाओं को लागू करने के लिए किया जाता है. साथ ही, जब पब्लिशर को पता चलता है कि उपयोगकर्ता ने विज्ञापन के लिए ब्रेक पर वापस जाने के लिए, वीडियो को आगे या पीछे किया है, तब इसे कॉल किया जाता है.

पैरामीटर

streamTime

संख्या

स्ट्रीम का वह समय जिस पर पहुंचा गया था.
रिटर्न

(null or non-null CuePoint) स्ट्रीम के दिए गए समय के लिए पिछला क्यूपॉइंट.

processMetadata

processMetadata(type, data, timestamp) void वापस लाता है

लाइव स्ट्रीम के लिए, समय के हिसाब से मेटाडेटा प्रोसेस करता है. अगर आपका वीडियो प्लेयर, टाइमस्टैंप के साथ बिना पार्स किए गए मेटाडेटा उपलब्ध कराता है, तो इसका इस्तेमाल करें. अगर ऐसा नहीं है, तो StreamManager.onTimedMetadata को कॉल करें.

पैरामीटर

टाइप

स्ट्रिंग

मेटाडेटा का टाइप. यह एचएलएस के लिए 'ID3' या DASH के लिए इवेंट मैसेज स्कीम आईडी यूआरआई होना चाहिए.

डेटा

(स्ट्रिंग या नॉन-नल Uint8Array)

रॉ टैग डेटा. ID3 के लिए, पूरा रॉ टैग डेटा होना चाहिए. DASH इवेंट मैसेज के लिए, यह मैसेज डेटा स्ट्रिंग है.

timestamp

संख्या

डेटा को प्रोसेस करने में लगने वाला समय (सेकंड में). DASH के लिए, यह इवेंट मैसेज के शुरू होने का समय है.
रिटर्न

void 

removeEventListener

removeEventListener(type, listener) void रिटर्न करता है

दिए गए इवेंट टाइप के लिए लिसनर हटाता है. लिसनर फ़ंक्शन, addEventListener को पहले पास किए गए फ़ंक्शन के रेफ़रंस के हिसाब से बराबर होना चाहिए.

पैरामीटर

टाइप

स्ट्रिंग

वह इवेंट टाइप जिसके लिए लिसनर को हटाना है.

लिसनर

function(non-null StreamEvent)

लिसनर के तौर पर हटाने का फ़ंक्शन.
रिटर्न

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) void पर वापस आता है

लाइव स्ट्रीम के लिए आने वाले विज्ञापन अनुरोधों में इस्तेमाल किए गए सभी विज्ञापन टैग पैरामीटर को बदलता है.

पैरामीटर

adTagParameters

स्ट्रिंग प्रॉपर्टी वाला ऑब्जेक्ट

नए विज्ञापन टैग पैरामीटर. इसमें स्ट्रिंग वैल्यू होनी चाहिए.

वैल्यू शून्य नहीं होनी चाहिए.
रिटर्न

void 

requestStream

requestStream(streamRequest) void पर वापस आता है

दिए गए स्ट्रीम पैरामीटर का इस्तेमाल करके, स्ट्रीम लोड करने का अनुरोध करता है.

पैरामीटर

streamRequest

StreamRequest

में स्ट्रीम का मेटाडेटा लोड करने के लिए पैरामीटर होते हैं.

वैल्यू शून्य नहीं होनी चाहिए.
रिटर्न

void 

रीसेट करें

reset() void वापस लाता है

इससे स्ट्रीम मैनेजर रीसेट हो जाता है और लगातार होने वाली पोलिंग बंद हो जाती है.

रिटर्न

void 

setClickElement

setClickElement(clickElement) void पर वापस आता है

विज्ञापनों पर क्लिक मिलने की दर का एलिमेंट सेट करता है. विज्ञापन चलने के दौरान, इस एलिमेंट का इस्तेमाल क्लिक या टैप रिसीवर के तौर पर किया जाता है. इसकी वजह से, मौजूदा पेज से दूसरे पेज पर नेविगेट किया जा सकता है. इसे अब बंद कर दिया गया है. इसके बजाय, StreamManager में adUiElement को पास किया जाना चाहिए. अगर StreamManager कंस्ट्रक्टर को कोई adUiElement दिया जाता है, तो यह तरीका काम नहीं करता.

पैरामीटर

clickElement

(शून्य या नॉन-शून्य एलिमेंट)

विज्ञापन पर क्लिक मिलने के बाद खुलने वाले पेज का यूआरएल.
बहिष्कृत
इसके बजाय, StreamManager कन्स्ट्रक्टर को adUiElement दें.
रिटर्न

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) एक संख्या दिखाता है

किसी कॉन्टेंट के लिए, विज्ञापनों के साथ स्ट्रीम का कुल समय दिखाता है. लाइव स्ट्रीम के लिए, कॉन्टेंट के दिए गए समय की जानकारी दिखाता है.

पैरामीटर

contentTime

संख्या

बिना किसी विज्ञापन के कॉन्टेंट का कुल समय (सेकंड में).
रिटर्न

number वीडियो चलाने में लगने वाला समय, जो विज्ञापन डालने के बाद कॉन्टेंट के दिए गए समय से मेल खाता है.