Roku के लिए IMA डीएआई SDK टूल

1. 1. इमा
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

क्लास ima

तरीके

IMA SDK को कंट्रोल करने वाले ग्लोबल फ़ंक्शन.

disableLogging()

इससे SDK टूल में लॉग इकट्ठा करने की सुविधा बंद हो जाती है. लॉग करने की सुविधा डिफ़ॉल्ट रूप से चालू होगी.

getStreamManager()

स्ट्रीम मैनेजर उपलब्ध होने पर, उसे लौटाता है. अगर स्ट्रीम मैनेजर अभी तक उपलब्ध नहीं है, तो अमान्य वैल्यू दी जाती है. अगर स्ट्रीम मैनेजर बनाने में कोई गड़बड़ी हुई है, तो गड़बड़ी वाला ऑब्जेक्ट दिखता है.

लौटाता है object: स्ट्रीम मैनेजर या गड़बड़ी ऑब्जेक्ट.

initSdk(settings)

SDK टूल शुरू करता है.

पैरामीटर	टाइप	कंपनी का ब्यौरा
settings	object	IMA सेटिंग का ऑब्जेक्ट, जो ज़रूरी नहीं है.

requestStream(streamRequest)

एसिंक्रोनस स्ट्रीम अनुरोध शुरू करता है इस तरीके को कॉल करने के बाद, कंट्रोल तुरंत प्लेयर पर वापस चला जाता है.

लौटाता है object: कोई गड़बड़ी नहीं होने पर गड़बड़ी या अमान्य होता है

पैरामीटर	टाइप	कंपनी का ब्यौरा
streamRequest	object

वापस सबसे ऊपर जाएं

क्लास ima.AdBreakInfo

फ़ील्ड

तरीके

इसमें विज्ञापन के लिए ब्रेक की जानकारी होती है. SDK टूल, इवेंट कॉलबैक को पास करता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
adPosition		विज्ञापन के लिए ब्रेक में विज्ञापन का इंडेक्स. स्टैंडअलोन विज्ञापनों के लिए 1 होगा.
duration		ब्रेक की ज़्यादा से ज़्यादा अवधि (सेकंड में) या पता न होने पर -1.
podIndex		लाइव स्ट्रीम के लिए, हमेशा -1 दिखाता है. मांग पर वीडियो (वीओडी) के लिए, विज्ञापनों के पॉड का इंडेक्स दिखाता है. प्रीरोल पॉड के लिए, 0 दिखाता है. वीडियो के बीच में दिखने वाले विज्ञापनों के लिए, 1, 2, ..., n दिखाता है. पोस्टरोल पॉड के लिए, n+1...n+x लौटाता है. अगर यह विज्ञापन किसी पॉड का हिस्सा नहीं है या यह पॉड किसी प्लेलिस्ट का हिस्सा नहीं है, तो इसे डिफ़ॉल्ट तौर पर 0 माना जाता है.
timeOffset		सेकंड में कॉन्टेंट में पॉड की स्थिति. वीडियो शुरू होने से पहले दिखने वाले विज्ञापन की वैल्यू 0, पोस्ट-रोल के लिए -1, और वीडियो के बीच में दिखने वाले विज्ञापनों की वैल्यू के तौर पर पॉड का शेड्यूल किया गया समय दिखता है.
totalAds		इस विज्ञापन के लिए ब्रेक में शामिल विज्ञापनों की कुल संख्या. स्टैंडअलोन विज्ञापनों के लिए 1 होगा.

createAdBreakInfo()

लौटाए जाने वाले आइटम ima.AdBreakInfo:

वापस सबसे ऊपर जाएं

क्लास ima.AdEvent

फ़ील्ड

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

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
AD_PERIOD_ENDED		स्ट्रीम, विज्ञापन या स्लेट से कॉन्टेंट पर स्विच करने पर हर बार ट्रिगर होती है. यह तब भी लागू होगा, जब किसी विज्ञापन को दूसरी बार चलाया गया हो या फिर उसे किसी विज्ञापन में शामिल किया जाए.
AD_PERIOD_STARTED		स्ट्रीम को हर बार कॉन्टेंट से विज्ञापन या स्लेट पर स्विच करने पर ट्रिगर होता है. यह तब भी लागू होगा, जब किसी विज्ञापन को दूसरी बार चलाया गया हो या फिर उसे किसी विज्ञापन में शामिल किया जाए.
COMPLETE		पूरा विज्ञापन चलने के बाद सक्रिय होता है.
ERROR		गड़बड़ी होने पर सक्रिय होता है.
FIRST_QUARTILE		विज्ञापन का प्लेहेड, पहले क्वार्टाइल में पार होने पर ट्रिगर होता है.
ICON_FALLBACK_IMAGE_CLOSED		यह तब ट्रिगर होता है, जब उपयोगकर्ता आइकॉन फ़ॉलबैक इमेज का डायलॉग बंद करता है.
ICON_FALLBACK_IMAGE_SHOWN		आइकॉन फ़ॉलबैक इमेज दिखने पर ट्रिगर होता है.
MIDPOINT		विज्ञापन का प्लेहेड, वीडियो के बीच में आने पर ट्रिगर होता है.
PROGRESS		यह तब ट्रिगर होता है, जब किसी विज्ञापन की प्रोग्रेस के बारे में अपडेट होता है.
SKIPPABLE_STATE_CHANGED		स्किप किए जा सकने वाले किसी विज्ञापन की स्थिति बदलने पर ट्रिगर होता है.
SKIPPED		किसी विज्ञापन को स्किप करने पर ट्रिगर होता है.
START		किसी विज्ञापन के चलने पर सक्रिय होता है.
THIRD_QUARTILE		विज्ञापन का प्लेहेड, तीसरे क्वार्टाइल को पार करने पर ट्रिगर होता है.

वापस सबसे ऊपर जाएं

क्लास ima.AdInfo

फ़ील्ड

तरीके

इसमें किसी विज्ञापन के बारे में जानकारी होती है. SDK टूल, इवेंट कॉलबैक को पास करता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
adBreakInfo		इस विज्ञापन के पूरे ब्रेक से जुड़ी जानकारी.
adDescription		विज्ञापन की जानकारी.
adId		विज्ञापन का आईडी या अगर जानकारी नहीं है, तो खाली स्ट्रिंग.
adSystem		क्रिएटिव उपलब्ध कराने वाला विज्ञापन सिस्टम.
adTitle		विज्ञापन का टाइटल.
advertiserName		विज्ञापन देने वाले व्यक्ति या कंपनी का नाम, जिसे विज्ञापन देने वाले पक्ष ने तय किया है.
companions		वीएएसटी (वीडियो विज्ञापन देने के लिए टेंप्लेट) रिस्पॉन्स में बताए गए कंपैनियन विज्ञापन.
currentTime		किसी विज्ञापन के चलने का मौजूदा समय (सेकंड में) या अगर पता नहीं है, तो -1.
duration		सेकंड में इस विज्ञापन की अवधि या अज्ञात होने पर -1.
skipOffset		विज्ञापन को स्किप किए जा सकने वाले बनने में लगने वाला समय या अगर जानकारी नहीं है, तो विज्ञापन दिखने में लगने वाला समय -1.
universalAdIDRegistry		एक स्ट्रिंग, जिसका इस्तेमाल रजिस्ट्री वेबसाइट के यूआरएल की पहचान करने के लिए किया जाता है. इस वेबसाइट में चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी कैटलॉग होता है.
universalAdIDValue		विज्ञापन के लिए चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी.
wrappers		इस विज्ञापन के लिए रैपर जानकारी के साथ ima.WrapperInfo का कलेक्शन. ऑर्डर आउटर रैपर से लेकर इनर तक होगा.

createAdInfo()

लौटाए जाने वाले आइटम ima.AdInfo:

वापस सबसे ऊपर जाएं

क्लास ima.Companion

फ़ील्ड

तरीके

इसमें किसी विज्ञापन के सहयोगियों के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
apiFramework		इस विज्ञापन को चलाने के लिए एपीआई की ज़रूरत है या उपलब्ध न होने पर यह अमान्य है.
creativeType		इससे क्रिएटिव टाइप के बारे में पता चलता है. आम तौर पर, यह एक mimetype होता है.
height		पिक्सल में कंपैनियन की ऊंचाई. उपलब्ध न होने पर 0.
trackingEvents		ट्रैकिंग इवेंट का एक मैप, जहां इवेंट कुंजी होती है और वैल्यू उस इवेंट पर पिंग करने के लिए यूआरएल की सूची होती है.
url		इस कंपैनियन के स्टैटिक रिसॉर्स का यूआरएल.
width		पिक्सल में कंपैनियन की चौड़ाई. उपलब्ध न होने पर 0.

createCompanion()

लौटाए जाने वाले आइटम ima.Companion:

वापस सबसे ऊपर जाएं

क्लास ima.CuePoint

फ़ील्ड

तरीके

इसमें क्यू पॉइंट के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
end		क्यूपॉइंट के लिए खत्म होने का समय सेकंड में. यह विज्ञापन के लिए ब्रेक से जुड़ा होता है.
hasPlayed		क्यूपॉइंट को दिखाने वाला बूलियन पहले ही चल चुका है.
start		क्यूपॉइंट के लिए शुरू होने का समय, सेकंड में. यह विज्ञापन के लिए ब्रेक से जुड़ा होता है.

createCuePoint()

लौटाए जाने वाले आइटम ima.CuePoint:

वापस सबसे ऊपर जाएं

क्लास ima.Error

फ़ील्ड

तरीके

अगर कोई गड़बड़ी हुई, तो ऑब्जेक्ट गड़बड़ी हैंडलर को भेज दिया जाता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
id		गड़बड़ी का आईडी. गड़बड़ी कोड की सूची के लिए, errorEvent कॉन्सटेंट देखें.
info		गड़बड़ी के बारे में ज़्यादा जानकारी.
type		इस ऑब्जेक्ट का टाइप दिखाने के लिए, हमेशा 'गड़बड़ी' पर सेट करें.

createError()

लौटाए जाने वाले आइटम ima.Error:

वापस सबसे ऊपर जाएं

क्लास ima.ErrorEvent

फ़ील्ड

वे सभी गड़बड़ियां जिन्हें SDK टूल वापस भेज सकता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
BAD_STREAM_REQUEST		स्ट्रीम के अनुरोध में जानकारी अपने-आप नहीं भरी गई थी.
COULD_NOT_LOAD_STREAM		स्ट्रीम लोड नहीं की जा सकी.
ERROR		कोई गड़बड़ी हुई.
INVALID_RESPONSE		सर्वर से मिला रिस्पॉन्स मान्य नहीं था.
STREAM_API_KEY_NOT_VALID		सर्वर ने एपीआई पासकोड स्वीकार नहीं किया.

वापस सबसे ऊपर जाएं

क्लास ima.Player

तरीके

adBreakEnded(adBreakInfo)

ज़रूरी नहीं. विज्ञापन के लिए ब्रेक खत्म होने पर कॉल किया गया.

पैरामीटर	टाइप	कंपनी का ब्यौरा
adBreakInfo	ima.AdBreakInfo	इसमें विज्ञापन के लिए ब्रेक के बारे में जानकारी होती है.

adBreakStarted(adBreakInfo)

ज़रूरी नहीं. यह तब कॉल किया जाता है, जब विज्ञापन के लिए ब्रेक की सुविधा शुरू हो जाती है.

पैरामीटर	टाइप	कंपनी का ब्यौरा
adBreakInfo	ima.AdBreakInfo	इसमें विज्ञापन के लिए ब्रेक के बारे में जानकारी होती है.

allVideoComplete()

ज़रूरी नहीं. सारा वीडियो पूरा होने पर कॉल किया जाता है.

createPlayer()

एक खाली IMA Player ऑब्जेक्ट बनाता है. विज्ञापन दिखाने के लिए, आपको loadUrl फ़ंक्शन लागू करना होगा. अन्य फ़ंक्शन ज़रूरी नहीं हैं.

लौटाए जाने वाले आइटम ima.Player:

loadUrl(streamInfo)

यह तब कॉल किया जाता है, जब प्लेयर यूआरएल चलाना शुरू करता है. स्ट्रीम लोड करने के लिए आपको यह तरीका अपनाना होगा.

पैरामीटर	टाइप	कंपनी का ब्यौरा
streamInfo	ima.StreamInfo	उसमें कॉन्टेंट चलाने के लिए ज़रूरी जानकारी होती है.

वापस सबसे ऊपर जाएं

क्लास ima.StreamFormat

फ़ील्ड

इससे स्ट्रीम का फ़ॉर्मैट तय होता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
DASH
HLS

वापस सबसे ऊपर जाएं

क्लास ima.StreamInfo

फ़ील्ड

तरीके

SDK से प्लेयर को स्ट्रीम के बारे में दी गई जानकारी.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
format		वीडियो का फ़ॉर्मैट: hls या डैश. इसकी जानकारी ima.StreamFormat में दी गई है.
manifest		स्ट्रीम के लिए यूआरएल.
streamId		स्ट्रीम के लिए यूनीक आईडी.
streamType		वीडियो का टाइप: लाइव या मांग पर उपलब्ध. इसकी जानकारी ima.StreamType में दी गई है.
subtitles		सबटाइटल, अगर उपलब्ध हो. अगर ऐसा नहीं है, तो यह अमान्य है.

createStreamInfo()

लौटाए जाने वाले आइटम ima.StreamInfo:

वापस सबसे ऊपर जाएं

क्लास ima.StreamManager

तरीके

स्ट्रीम प्लेबैक को मैनेज करने के लिए ऑब्जेक्ट.

addEventListener(event, callback)

बताए गए इवेंट के लिए लिसनर जोड़ता है. इस्तेमाल किए जा सकने वाले इवेंट के लिए, AdEvent कॉन्सटेंट देखें.

पैरामीटर	टाइप	कंपनी का ब्यौरा
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

लौटाए जाने वाले आइटम ima.StreamManager:

पैरामीटर	टाइप	कंपनी का ब्यौरा
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

काम नहीं करता है. इसके बजाय, डेटा को कंपैनियन विज्ञापन से सीधे RAF को पास करें. अब यह कोई ऑपरेशन नहीं है.

getContentTime(streamTime)

वीओडी स्ट्रीम के लिए मिलीसेकंड में समय मिलता है. इससे कॉन्टेंट में बिना विज्ञापन के दिखने वाले समय का पता चलता है. देखें: https://developers.google.com/ad-manager/डाइनैमिक-ad-insertion/sdk/roku/faq -1 में मौजूदा स्ट्रीम टाइम पास के लिए कॉन्टेंट का समय जानने के लिए.

लौटाता है Integer: दिए गए स्ट्रीम के समय के हिसाब से कॉन्टेंट का समय.

पैरामीटर	टाइप	कंपनी का ब्यौरा
streamTime	Integer	स्ट्रीम में मौजूद समय.

getCuePoints()

विज्ञापन के लिए सभी ब्रेक से जुड़े सभी क्यू पॉइंट दिखाता है. यह सिर्फ़ मांग पर वीडियो विज्ञापन के लिए मान्य है, जिसमें विज्ञापन के लिए सभी ब्रेक की जानकारी पहले से मौजूद हो. सभी समय, स्ट्रीम के समय को सेकंड में दिखाते हैं.

रिटर्न Object: ऐसा कलेक्शन जिसमें सभी क्यू पॉइंट हैं.

getPreviousCuePoint(time)

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

लौटाता है ima.CuePoint: ऐसा ऑब्जेक्ट जिसमें शुरू, खत्म, और isPlay किया गया हो. क्यू पॉइंट उपलब्ध न होने पर, वैल्यू अमान्य हो जाती है.

पैरामीटर	टाइप	कंपनी का ब्यौरा
time	Float	देखने का समय, -1 वर्तमान समय का संकेत है.

getStreamTime(contentTime)

मिलीसेकंड में वीओडी (वीडियो ऑन डिमांड) के लिए, कॉन्टेंट के समय से स्ट्रीम के लिए समय लेता है. देखें: https://developers.google.com/ad-manager/डाइनैमिक-ad-insertion/sdk/roku/faq

लौटाता Integer: दिए गए कॉन्टेंट समय के हिसाब से स्ट्रीम में लगने वाला समय.

पैरामीटर	टाइप	कंपनी का ब्यौरा
contentTime	Integer	कॉन्टेंट दिखने का समय.

loadThirdPartyStream(streamManifest, streamSubtitle)

विज्ञापन मेटाडेटा लोड करता है और दिए गए streamManifestUrl और streamSubtitle डेटा के साथ loadUrl फ़ंक्शन को कॉल करता है. यह फ़ंक्शन सिर्फ़ तब काम करता है, जब स्ट्रीम का अनुरोध ima.StreamType.POD_VOD हो.

पैरामीटर	टाइप	कंपनी का ब्यौरा
streamManifest	string	स्ट्रीम मेनिफ़ेस्ट यूआरएल, जिसमें विज्ञापन जोड़े गए हैं.
streamSubtitle	ifArray>|Invalid	सबटाइटल स्ट्रीम से जुड़े हुए हैं या अगर कोई नहीं है, तो Invalid.

onMessage(msg)

वीडियो ऑब्जेक्ट से आने वाले सभी मैसेज मैनेज करता है. roMessagePort पर मिलने वाले हर मैसेज के लिए कॉल किया जाना चाहिए.

पैरामीटर	टाइप	कंपनी का ब्यौरा
msg	object	roVideo पोर्ट से मिला मैसेज.

replaceAdTagParameters(adTagParameters)

यह उन सभी विज्ञापन टैग पैरामीटर को बदलता है जिनका इस्तेमाल, लाइव स्ट्रीम के लिए आने वाले विज्ञापन अनुरोधों के लिए किया जाता है. ध्यान दें कि इस कॉल में वीओडी (वीडियो ऑन डिमांड) स्ट्रीम नहीं की जा सकती.

पैरामीटर	टाइप	कंपनी का ब्यौरा
adTagParameters	string	नए विज्ञापन टैग के पैरामीटर.

start()

स्ट्रीम का प्लेबैक शुरू करता है.

वापस सबसे ऊपर जाएं

क्लास ima.StreamRequest

फ़ील्ड

तरीके

इसका इस्तेमाल स्ट्रीम अनुरोध की प्रॉपर्टी तय करने के लिए किया जाता है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
adTagParameters		ज़रूरी नहीं. स्ट्रीम के अनुरोध पर, विज्ञापन टैग पैरामीटर के सीमित सेट को बदला जा सकता है. अपनी स्ट्रीम में टारगेटिंग पैरामीटर उपलब्ध कराने से ज़्यादा जानकारी मिलती है. स्ट्रीम के अलग-अलग वैरिएंट को प्राथमिकता देने के लिए, dai-ot और dai-ov पैरामीटर का भी इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, स्ट्रीम के वैरिएंट के पैरामीटर बदलना देखें.
adUiNode		सीन ग्राफ़ नोड, जहां विज्ञापन यूज़र इंटरफ़ेस (यूआई) दिखता है. IMA, विज्ञापनों के दौरान इस एलिमेंट पर यह विज्ञापन क्यों और अभी नहीं बटन जैसे एलिमेंट लगाता है. एलिमेंट को पूरे वीडियो एलिमेंट को ओवरले करना चाहिए.
apiKey		ज़रूरी नहीं. इन कुंजियों का इस्तेमाल स्ट्रीम के अनुरोधों की पुष्टि करने के लिए किया जा सकता है. DAI पुष्टि करने वाली कुंजियां DFP यूज़र इंटरफ़ेस (यूआई) में सेट अप होनी चाहिए.
assetKey		लाइव स्ट्रीम के लिए ज़रूरी है. इसका इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसी स्ट्रीम चलाई जाए. लाइव स्ट्रीम अनुरोध एसेट कुंजी एक आइडेंटिफ़ायर है, जो DFP यूज़र इंटरफ़ेस (यूआई) में मिल सकता है.
authToken		स्ट्रीम अनुरोध की अनुमति देने वाला टोकन. इसका इस्तेमाल एपीआई पासकोड की जगह पर किया जाता है, ताकि कॉन्टेंट को सख्ती से अनुमति दी जा सके. पब्लिशर इस टोकन के आधार पर, हर कॉन्टेंट स्ट्रीम की अनुमति को कंट्रोल कर सकता है.
contentSourceId		मांग पर स्ट्रीम करने के लिए ज़रूरी है. cmsid, DFP यूज़र इंटरफ़ेस (यूआई) में DFP वीडियो कॉन्टेंट के सोर्स से आता है.
customAssetKey		कस्टम ऐसेट कुंजी का इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसी स्ट्रीम चलाई जानी चाहिए. पॉड सर्विंग स्ट्रीम अनुरोधों के लिए कस्टम एसेट कुंजियां ज़रूरी हैं.
format		स्ट्रीम का फ़ॉर्मैट. डिफ़ॉल्ट तौर पर, यह ima.StreamFormat.HLS पर सेट होती है.
networkCode		स्ट्रीम का अनुरोध करने वाले पब्लिशर का नेटवर्क कोड. पॉड सर्विंग स्ट्रीम अनुरोधों के लिए नेटवर्क कोड ज़रूरी हैं.
player		प्लेयर इंटरफ़ेस को लागू करना.
ppid		समर्थन नहीं होना या रुकना. adTagParameters का इस्तेमाल करें. ज़रूरी नहीं. DFP ऑडियंस प्रकाशक की ओर से दिया गया पहचानकर्ता.
streamActivityMonitorId		स्ट्रीम गतिविधि मॉनिटर की मदद से स्ट्रीम को डीबग करने के लिए इस्तेमाल किया जाने वाला आईडी. इसका इस्तेमाल पब्लिशरों को स्ट्रीम गतिविधि मॉनिटर टूल में स्ट्रीम लॉग ढूंढने की सुविधा देने के लिए किया जाता है.
videoId		मांग पर स्ट्रीम करने के लिए ज़रूरी है. वीडियो कॉन्टेंट के सोर्स का आइडेंटिफ़ायर.
videoObject		क्लाइंट ऐप्लिकेशन पर वीडियो चलाने के लिए ज़िम्मेदार वीडियो ऑब्जेक्ट (जैसे कि Video roSGNode). इस ऑब्जेक्ट को लाइव HLS ID3 इवेंट के सही समय पर इस्तेमाल करने के लिए, अलग-अलग डेटा के लिए पोल किया जाएगा.
videoStitcherSessionOptions		सेशन के विकल्पों का इस्तेमाल, VideoStitcher StreamRequests के लिए, वीडियो स्टिकर के खास पैरामीटर सेट करने के लिए किया जाता है.

createLiveStreamRequest(assetKey, apiKey)

लाइव StreamRequest की ज़रूरी प्रॉपर्टी शुरू करता है. इस एपीआई का इस्तेमाल करने पर, StreamType की किसी खास प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता ima.StreamRequest: ज़रूरी लाइव प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
assetKey	string
apiKey	string	यह पैरामीटर, दिखाई गई StreamRequest की apiKey प्रॉपर्टी के लिए असाइन किया जाएगा. यह पैरामीटर डिफ़ॉल्ट रूप से खाली स्ट्रिंग पर सेट होता है.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

पॉड लाइव ima.StreamRequest की ज़रूरी प्रॉपर्टी शुरू करता है. इस एपीआई का इस्तेमाल करने से, किसी भी ima.StreamType से जुड़ी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता StreamRequest: ज़रूरी PodLive प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
customAssetKey	string
networkCode	string
apiKey	string	यह पैरामीटर, दिखाई गई ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी के लिए असाइन किया जाएगा. यह पैरामीटर डिफ़ॉल्ट रूप से खाली स्ट्रिंग पर सेट होता है.

createPodVodStreamRequest(networkCode)

जब तीसरे पक्ष के वीडियो स्टिचर के साथ डीएआई पॉड का इस्तेमाल किया जा रहा हो, तब वीओडी स्ट्रीम को रजिस्टर करने के लिए, ima.StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. यह फ़ंक्शन, अनुरोध के टाइप को ima.StreamType.POD_VOD पर सेट करता है और जो डेटा मौजूद नहीं है उसके लिए सभी ज़रूरी प्रॉपर्टी की पुष्टि करता है. पुष्टि न होने पर, डीबग कंसोल में गड़बड़ी लॉग होगी.

StreamRequest नतीजे दिखाता है: ima.StreamRequest ऑब्जेक्ट. अगर सभी ज़रूरी प्रॉपर्टी चुन ली गई हैं, तो अनुरोध के टाइप को ima.StreamType.POD_VOD पर सेट किया जाता है.

पैरामीटर	टाइप	कंपनी का ब्यौरा
networkCode	string	Google Ad Manager नेटवर्क कोड

createStreamRequest()

ima.StreamRequest दिखाता है: एक खाली ima.StreamRequest ऑब्जेक्ट है.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

वीडियो स्टिचर लाइव की ज़रूरी प्रॉपर्टी शुरू करता है StreamRequest. इस एपीआई का इस्तेमाल करने पर, किसी भी अन्य StreamType खास प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता ima.StreamRequest: ज़रूरी VideoStitcherLive प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

वीडियो स्टिचर वीओडी की ज़रूरी प्रॉपर्टी शुरू करता है StreamRequest. इस एपीआई का इस्तेमाल करने पर, किसी भी अन्य StreamType खास प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता ima.StreamRequest: ज़रूरी VideoStitcherVod प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

क्लाउड वीडियो स्टिचर से बनाए गए vodConfigId का इस्तेमाल करके StreamRequest, वीडियो स्टिचर वीओडी की ज़रूरी प्रॉपर्टी शुरू करता है. इस एपीआई का इस्तेमाल करने पर, StreamType की अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता ima.StreamRequest: ज़रूरी VideoStitcherVod प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

वीओडी (वीडियो ऑन डिमांड) ima.StreamRequest की ज़रूरी प्रॉपर्टी शुरू करता है. इस एपीआई का इस्तेमाल करने पर, ima.StreamType की अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉग की जाती है और एपीआई एक जेनरिक StreamRequest दिखाता है, जिसमें किसी प्रॉपर्टी को अनदेखा नहीं किया जाता.

लौटाता ima.StreamRequest: ज़रूरी वीओडी प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	कंपनी का ब्यौरा
contentSourceId	string
videoId	string
apiKey	string	यह पैरामीटर, दिखाई गई ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी के लिए असाइन किया जाएगा. यह पैरामीटर डिफ़ॉल्ट रूप से खाली स्ट्रिंग पर सेट होता है.

वापस सबसे ऊपर जाएं

क्लास ima.StreamType

फ़ील्ड

इससे पता चलता है कि प्लेयर से किस तरह की स्ट्रीम चलाने के लिए कहा गया. प्रीरोल और वीओडी (वीडियो ऑन डिमांड) स्ट्रीम की शुरुआत से चलाए जाने चाहिए.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
LIVE		वीडियो लाइव है.
VOD		वीडियो मांग पर उपलब्ध है.

वापस सबसे ऊपर जाएं

क्लास ima.WrapperInfo

फ़ील्ड

तरीके

इसमें किसी रैपर के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	कंपनी का ब्यौरा
adId		विज्ञापन का आईडी या अगर जानकारी नहीं है, तो खाली स्ट्रिंग.
adSystem		विज्ञापन सिस्टम का बताया गया नाम या अगर जानकारी नहीं है, तो खाली स्ट्रिंग.
creativeAdId		क्रिएटिव पर विज्ञापन आईडी या अगर पता न हो, तो खाली स्ट्रिंग का.
creativeId		क्रिएटिव का आईडी या अगर जानकारी नहीं है, तो खाली स्ट्रिंग.
dealId		डील आईडी या अगर जानकारी नहीं है, तो खाली स्ट्रिंग.

createWrapperInfo()

लौटाए जाने वाले आइटम ima.WrapperInfo:

वापस सबसे ऊपर जाएं