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

तरीके

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

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

getStreamManager()

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

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

initSdk(settings)

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

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

requestStream(streamRequest)

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

यह object: गड़बड़ी का मैसेज दिखाता है या कोई गड़बड़ी न होने पर अमान्य जानकारी दिखाता है

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

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

क्लास ima.AdBreakInfo

फ़ील्ड

adPosition, duration, podIndex, timeOffset, totalAds

तरीके

createAdBreakInfo

इसमें विज्ञापन के लिए ब्रेक के बारे में जानकारी होती है. 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, गड़बड़ी, FIRST_QUARTILE, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED,THIRD_QUARTILE

विज्ञापन मैनेजर की ओर से सक्रिय किए गए इवेंट.

प्रॉपर्टी

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

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

क्लास ima.AdInfo

फ़ील्ड

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, Companions, currentTime, duration, universalAdIDRegistry universalAdIDRegistry universalAdIDValue

तरीके

createAdInfo

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

प्रॉपर्टी

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

createAdInfo()

लौटाता है ima.AdInfo:

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

क्लास ima.Companion

फ़ील्ड

apiFramework, creativeType, height, trackingEvents, url, चौड़ाई

तरीके

createCompanion

इसमें विज्ञापन के साथ-साथ चलने वाले लोगों की जानकारी होती है.

प्रॉपर्टी

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

createCompanion()

लौटाता है ima.Companion:

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

क्लास ima.CuePoint

फ़ील्ड

end, hasPlayed, start

तरीके

createCuePoint

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

प्रॉपर्टी

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

createCuePoint()

लौटाता है ima.CuePoint:

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

क्लास ima.Error

फ़ील्ड

id, जानकारी, टाइप

तरीके

createError

कोई गड़बड़ी होने पर ऑब्जेक्ट, गड़बड़ी हैंडलर को पास किया जाता है.

प्रॉपर्टी

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

createError()

लौटाता है ima.Error:

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

क्लास ima.ErrorEvent

फ़ील्ड

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

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

प्रॉपर्टी

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

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

क्लास ima.Player

तरीके

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

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

इससे स्ट्रीम के फ़ॉर्मैट के बारे में पता चलता है.

प्रॉपर्टी

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

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

क्लास ima.StreamInfo

फ़ील्ड

format, मेनिफ़ेस्ट, streamId, streamType, सबटाइटल

तरीके

createStreamInfo

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

प्रॉपर्टी

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

createStreamInfo()

लौटाता है ima.StreamInfo:

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

क्लास ima.StreamManager

तरीके

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters

स्ट्रीम प्लेबैक मैनेज करने से जुड़ा ऑब्जेक्ट.

addEventListener(event, callback)

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

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

createStreamManager(streamRequest, streamInitResponse)

लौटाता है ima.StreamManager:

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

enableInteractiveAds()

काम नहीं करता. इसके बजाय, कंपैनियन विज्ञापन से सीधे आरएएफ़ में डेटा पास करें. यह अब नहीं है.

getContentTime(streamTime)

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

दिखाता Integer: किसी स्ट्रीम के चलने के समय से जुड़ा कॉन्टेंट का समय.

पैरामीटर	टाइप	ब्यौरा
streamTime	Integer	स्ट्रीम में समय.

getCuePoints()

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

Object दिखाता है: सभी क्यू पॉइंट वाला कलेक्शन.

getPreviousCuePoint(time)

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

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

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

getStreamTime(contentTime)

इससे पता चलता है कि वीओडी (वीडियो ऑन डिमांड) के लिए, कॉन्टेंट के समय से लाइव स्ट्रीम के लिए कितना समय लिया गया है. यह समय, मिलीसेकंड में होता है. देखें: https://developers.google.com/ad-manager/Dynamic-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, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, फ़ॉर्मैट, networkCode networkCode{/14,video26}2stream2}ppidstreamActivityMonitorIdvideoIdvideoObject

तरीके

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVodStreamRequest

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

प्रॉपर्टी

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

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: ima.StreamRequest ऑब्जेक्ट, ज़रूरी PodLive प्रॉपर्टी के साथ.

पैरामीटर	टाइप	ब्यौरा
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: ima.StreamRequest ऑब्जेक्ट को ज़रूरी VideoStitcherLive प्रॉपर्टी के साथ दिखाता है.

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

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

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

दिखाता ima.StreamRequest: ima.StreamRequest ऑब्जेक्ट, ज़रूरी VideoStitcherVod प्रॉपर्टी के साथ.

पैरामीटर	टाइप	ब्यौरा
adTagUrl	string
networkCode	string
contentSourceUrl	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

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

प्रॉपर्टी

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

createWrapperInfo()

लौटाता है ima.WrapperInfo:

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