यह कुकी, डाइनैमिक ऐड इंसर्शन स्ट्रीम को मैनेज करती है. यह क्लास, DAI सर्वर के साथ इंटरैक्शन मैनेज करती है. साथ ही, ट्रैकिंग पिंग को मैनेज करती है और स्ट्रीम और विज्ञापन इवेंट को ट्रिगर करती है.
| निर्माता | |
|---|---|
constructor
|
|
| तरीके | |
|---|---|
add
|
यह दिए गए इवेंट टाइप के लिए लिसनर जोड़ता है. |
content
|
यह फ़ंक्शन, स्ट्रीम के दिए गए समय के लिए, बिना विज्ञापनों के कॉन्टेंट का समय दिखाता है. |
focus
|
अगर स्किप करने का बटन मौजूद है, तो उस पर फ़ोकस करता है. |
get
|
अगर उपयोगकर्ता मौजूदा विज्ञापन को स्किप कर सकता है, तो यह फ़ंक्शन
true वैल्यू दिखाता है. |
load
|
यह DAI SDK से विज्ञापन का मेटाडेटा लोड करने का अनुरोध करता है और
LOADED स्ट्रीम इवेंट दिखाता है.
|
on
|
प्रोसेस किए गए मेटाडेटा के डिक्शनरी में पास होता है. |
previous
|
यह फ़ंक्शन, स्ट्रीम के दिए गए समय के लिए पिछले क्यूपॉइंट को दिखाता है. |
process
|
यह कुकी, स्ट्रीम के लिए टाइम किया गया मेटाडेटा प्रोसेस करती है. |
remove
|
यह दिए गए StreamEvent इवेंट टाइप के लिए लिसनर को हटाता है.
|
replace
|
यह लाइव स्ट्रीम के लिए, विज्ञापन के आने वाले अनुरोधों के लिए इस्तेमाल किए गए सभी विज्ञापन टैग पैरामीटर को बदल देता है.
|
request
|
यह कुकी, IMA डीएआई के लिए स्ट्रीम का अनुरोध करती है, ताकि दिए गए स्ट्रीम पैरामीटर का इस्तेमाल करके उसे लोड किया जा सके.
|
reset
|
यह स्ट्रीम मैनेजर को रीसेट करता है और लगातार पोलिंग करने की सुविधा को हटाता है. |
stream
|
यह फ़ंक्शन, कॉन्टेंट की दी गई अवधि के लिए, विज्ञापनों के साथ स्ट्रीम करने का कुल समय दिखाता है. |
निर्माता
कंस्ट्रक्टर
new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
| पैरामीटर | |
|---|---|
videoElement: HTMLVideoElement
|
एचटीएमएल वीडियो एलिमेंट, जहां वीडियो चलाया जाता है. |
|
वह एलिमेंट जहां विज्ञापन का यूज़र इंटरफ़ेस (यूआई) रेंडर होता है. |
|
इस स्ट्रीम के लिए इस्तेमाल की जाने वाली यूज़र इंटरफ़ेस (यूआई) सेटिंग. |
| रिटर्न | |
|---|---|
StreamManager
|
|
तरीके
addEventListener
addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
यह दिए गए इवेंट टाइप के लिए लिसनर जोड़ता है.
| पैरामीटर | |
|---|---|
type:
Type | Type[]
|
विज्ञापन इवेंट का टाइप या इवेंट टाइप की एक कैटगरी. |
listener: ((event: StreamEvent) => void)
|
विज्ञापन लिसनर के लिए कॉलबैक फ़ंक्शन. |
contentTimeForStreamTime
contentTimeForStreamTime(streamTime: number): number
यह फ़ंक्शन, स्ट्रीम के दिए गए समय के लिए, बिना विज्ञापनों के कॉन्टेंट का समय दिखाता है. यह फ़ंक्शन, लाइव स्ट्रीम के लिए स्ट्रीम शुरू होने का समय दिखाता है.
| पैरामीटर | |
|---|---|
streamTime: number
|
कॉन्टेंट और विज्ञापनों को मिलाकर, स्ट्रीम का समय सेकंड में. |
| रिटर्न | |
|---|---|
number
|
विज्ञापन शामिल किए बिना, स्ट्रीम के दिए गए समय के लिए कॉन्टेंट का समय. |
focus
focus(): void
अगर स्किप करने का बटन मौजूद है, तो उस पर फ़ोकस करता है. अगर यह मौजूद नहीं है, तो फ़ोकस को इंटरैक्टिव एलिमेंट पर वापस ले जाया जाता है.
getAdSkippableState
getAdSkippableState(): boolean
अगर उपयोगकर्ता मौजूदा विज्ञापन को स्किप कर सकता है, तो यह फ़ंक्शन
true वैल्यू दिखाता है. इस वैल्यू में बदलाव होने पर, StreamManager क्लास एक SKIPPABLE_STATE_CHANGED स्ट्रीम इवेंट भेजता है.
| रिटर्न | |
|---|---|
boolean
|
true अगर उपयोगकर्ता मौजूदा विज्ञापन को स्किप कर सकता है,
false ऐसा न होने पर.
|
loadStreamMetadata
loadStreamMetadata(): void
यह DAI SDK से विज्ञापन का मेटाडेटा लोड करने का अनुरोध करता है और
LOADED स्ट्रीम इवेंट दिखाता है.
तीसरे पक्ष के वीडियो स्टिचर से स्ट्रीम मेनिफ़ेस्ट वापस पाने पर, इस तरीके को मैन्युअल तरीके से कॉल करें. यह तरीका सिर्फ़ पॉड सर्व करने वाली वीओडी स्ट्रीम के लिए है. इसके लिए, तीसरे पक्ष के वीडियो स्टिचिंग सॉफ़्टवेयर का इस्तेमाल किया जाता है.
onTimedMetadata
onTimedMetadata(metadata: {
[key: string]: string;
}): void
प्रोसेस किए गए मेटाडेटा के शब्दकोश में पास होता है. डिक्शनरी में, उपयोगकर्ता की तय की गई मेटाडेटा स्ट्रिंग को वैल्यू के तौर पर इस्तेमाल करने के लिए, सटीक कुंजी
"TXXX" की ज़रूरत होती है. अगर आपका प्लेयर, रॉ मेटाडेटा उपलब्ध कराता है, तो StreamManager.processMetadata तरीके को कॉल करें.
| पैरामीटर | |
|---|---|
metadata: {
|
मेटाडेटा का शब्दकोश. |
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime: number): CuePoint
यह फ़ंक्शन, स्ट्रीम के दिए गए समय के लिए पिछले क्यूपॉइंट को दिखाता है. अगर कोई पिछला क्यूपॉइंट मौजूद नहीं है, तो
null दिखाता है. इस तरीके का इस्तेमाल, स्नैपबैक जैसी सुविधाओं को लागू करने के लिए करें. इसके लिए, जब उपयोगकर्ता को विज्ञापन ब्रेक पर वापस जाना हो, तब इस तरीके को कॉल करें.
| पैरामीटर | |
|---|---|
streamTime: number
|
स्ट्रीम का वह समय जिस पर उपयोगकर्ता को जाना है. |
| रिटर्न | |
|---|---|
CuePoint
|
स्ट्रीम के दिए गए समय के लिए पिछला क्यूपॉइंट. |
processMetadata
processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
यह कुकी, स्ट्रीम के लिए टाइम किया गया मेटाडेटा प्रोसेस करती है. अगर आपका वीडियो प्लेयर, टाइमस्टैंप के साथ
पार्स नहीं किया गया मेटाडेटा उपलब्ध कराता है, तो इस तरीके का इस्तेमाल करें. अगर ऐसा नहीं है, तो StreamManager.onTimedMetadata को कॉल करें.
| पैरामीटर | |
|---|---|
type: string
|
मेटाडेटा का टाइप. यह एचएलएस के लिए 'ID3' स्ट्रिंग या डैश के लिए इवेंट
मैसेज स्कीम आईडी यूआरआई होना चाहिए.
|
data: string | Uint8Array
|
टैग का रॉ डेटा. ID3 के लिए, पूरे रॉ टैग का डेटा होना चाहिए. DASH इवेंट मैसेज के लिए, यह मैसेज डेटा स्ट्रिंग है. |
timestamp: number
|
डेटा को प्रोसेस करने का समय, सेकंड में. DASH के लिए, यह पैरामीटर इवेंट मैसेज के शुरू होने का समय है. |
removeEventListener
removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
यह दिए गए StreamEvent इवेंट टाइप के लिए लिसनर को हटाता है. किसी लिसनर को हटाने के लिए, इस तरीके को पास किया गया लिसनर पैरामीटर, रेफ़रंस के हिसाब से उस पैरामीटर के बराबर होना चाहिए जिसे पहले
addEventListener तरीके को पास किया गया था.
| पैरामीटर | |
|---|---|
type:
Type
|
जिस इवेंट के लिए लिसनर को हटाना है उसका टाइप. |
listener: ((event: StreamEvent) => void)
|
लिसनर के तौर पर हटाने के लिए फ़ंक्शन. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters: {
[key:
string]: string;
}): void
यह लाइव स्ट्रीम के लिए, विज्ञापन के आने वाले अनुरोधों के लिए इस्तेमाल किए गए सभी विज्ञापन टैग पैरामीटर को बदल देता है.
| पैरामीटर | |
|---|---|
adTagParameters: {
|
बदले गए विज्ञापन टैग पैरामीटर. इसमें स्ट्रिंग वैल्यू होनी चाहिए. |
requestStream
requestStream(streamRequest: StreamRequest): void
यह कुकी, IMA डीएआई के लिए स्ट्रीम का अनुरोध करती है, ताकि दिए गए स्ट्रीम पैरामीटर का इस्तेमाल करके उसे लोड किया जा सके.
| पैरामीटर | |
|---|---|
streamRequest:
StreamRequest
|
इसमें स्ट्रीम मेटाडेटा लोड करने के लिए पैरामीटर होते हैं. |
रीसेट करें
reset(): void
यह स्ट्रीम मैनेजर को रीसेट करता है और लगातार पोलिंग करने की सुविधा को हटाता है.
streamTimeForContentTime
streamTimeForContentTime(contentTime: number): number
यह फ़ंक्शन, कॉन्टेंट की दी गई अवधि के लिए, विज्ञापनों के साथ स्ट्रीम करने का कुल समय दिखाता है. लाइव स्ट्रीम के लिए, दिए गए कॉन्टेंट का समय दिखाता है.
| पैरामीटर | |
|---|---|
contentTime: number
|
सेकंड में, बिना किसी विज्ञापन के कॉन्टेंट देखने की अवधि. |
| रिटर्न | |
|---|---|
number
|
डीएआई की मदद से विज्ञापन डालने के बाद, कॉन्टेंट के दिए गए समय के हिसाब से स्ट्रीम का कुल समय. |