IMA DAI SDK für Roku

1. 1. ima
   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

Klasse ima

Methoden

disableLogging, getStreamManager, initSdk, requestStream

Globale Funktionen, die das IMA SDK steuern

disableLogging()

Deaktiviert das SDK-Logging. Logging ist standardmäßig aktiviert.

getStreamManager()

Gibt einen Stream-Manager zurück, sofern verfügbar Wenn der Stream-Manager noch nicht verfügbar ist, wird „Ungültig“ zurückgegeben. Wenn beim Erstellen des Stream-Managers ein Fehler aufgetreten ist, wird ein Fehlerobjekt zurückgegeben.

Gibt object zurück:Stream-Manager oder Fehlerobjekt.

initSdk(settings)

Initialisiert das SDK.

Parameter	Typ	Beschreibung
settings	object	Optionales IMA-Einstellungsobjekt.

requestStream(streamRequest)

Startet eine asynchrone Streamanfrage. Nach dem Aufruf dieser Methode wird die Steuerung sofort an den Player zurückgegeben.

Gibt object zurück:ein Fehler oder ungültig, wenn kein Fehler

Parameter	Typ	Beschreibung
streamRequest	object

Nach oben

Klasse ima.AdBreakInfo

Fields

adPosition, duration, podIndex, timeOffset, totalAds

Methoden

createAdBreakInfo

Enthält Informationen zu einer Werbeunterbrechung. Wird vom SDK an Ereignis-Callbacks übergeben.

Attribute

Name	Typ	Beschreibung
adPosition		Der Index der Anzeige in der Werbeunterbrechung. Wird für eigenständige Anzeigen „1“ sein.
duration		Die maximale Dauer der Unterbrechung in Sekunden oder -1, falls unbekannt.
podIndex		Für Livestreams wird immer -1 zurückgegeben. Bei Video-on-Demand (VOD) wird der Index des Anzeigen-Pods zurückgegeben. Für einen Pre-Roll-Pod wird 0 zurückgegeben. Für Mid-Rolls wird 1, 2, ..., n zurückgegeben. Für einen Post-Roll-Pod wird n+1...n+x zurückgegeben. Die Standardeinstellung ist 0, wenn diese Anzeige nicht Teil eines Pods oder nicht Teil einer Playlist ist.
timeOffset		Die Position des Pods im Content in Sekunden. Pre-Roll gibt 0 zurück, Post-Roll -1 und Mid-Rolls geben die geplante Zeit des Pods zurück.
totalAds		Die Gesamtzahl der Anzeigen in dieser Werbeunterbrechung. Wird für eigenständige Anzeigen „1“ sein.

createAdBreakInfo()

Gibt ima.AdBreakInfo zurück:

Nach oben

Klasse ima.AdEvent

Fields

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, FEHLER, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PIDABLE1}PUNKT, SKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Ereignisse, die vom Anzeigenmanager ausgelöst wurden

Attribute

Name	Typ	Beschreibung
AD_PERIOD_ENDED		Wird jedes Mal ausgelöst, wenn der Stream von Werbung oder Slate zu Content wechselt Dieses Ereignis wird auch dann ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben oder zu einer Anzeige gewechselt wird.
AD_PERIOD_STARTED		Wird jedes Mal ausgelöst, wenn der Stream von Inhalten zu Werbung oder Slate wechselt Dieses Ereignis wird auch dann ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben oder zu einer Anzeige gewechselt wird.
COMPLETE		Wird ausgelöst, wenn die Anzeige vollständig wiedergegeben wurde
ERROR		Wird ausgelöst, wenn ein Fehler auftritt.
FIRST_QUARTILE		Wird ausgelöst, wenn der Abspielkopf der Anzeige das erste Quartil überschreitet
ICON_FALLBACK_IMAGE_CLOSED		Wird ausgelöst, wenn der Nutzer das Dialogfeld für das Symbol-Fallback-Bild schließt.
ICON_FALLBACK_IMAGE_SHOWN		Wird ausgelöst, wenn das Symbol-Fallback-Bild angezeigt wird
MIDPOINT		Wird ausgelöst, wenn der Abspielkopf der Anzeige den Mittelpunkt überschreitet
PROGRESS		Wird ausgelöst, wenn der Fortschritt einer Anzeige aktualisiert wird
SKIPPABLE_STATE_CHANGED		Wird ausgelöst, wenn sich der Status der überspringbaren Anzeige ändert
SKIPPED		Wird ausgelöst, wenn eine Anzeige übersprungen wird
START		Wird ausgelöst, wenn die Wiedergabe einer Anzeige beginnt
THIRD_QUARTILE		Wird ausgelöst, wenn der Abspielkopf der Anzeige das dritte Quartil überschreitet

Nach oben

Klasse ima.AdInfo

Fields

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, Companions, currentTime, duration, skipOffset, Offset2}Offset, universalAdIDRegistryuniversalAdIDValue

Methoden

createAdInfo

Enthält Informationen zu einer Anzeige. Wird vom SDK an Ereignis-Callbacks übergeben.

Attribute

Name	Typ	Beschreibung
adBreakInfo		Informationen zur gesamten Pause, in der sich diese Anzeige befindet.
adDescription		Die Beschreibung der Anzeige.
adId		Die ID der Anzeige oder ein leerer String, falls dieser unbekannt ist.
adSystem		Das Anzeigensystem, das das Creative liefert.
adTitle		Der Titel der Anzeige.
advertiserName		Der Name des Werbetreibenden, wie er vom Anbieter der Anzeigenbereitstellung definiert wurde.
companions		Die in der VAST-Antwort angegebenen Companion-Anzeigen.
currentTime		Die aktuelle Zeit innerhalb einer Anzeige in Sekunden oder -1, falls unbekannt.
duration		Die Dauer dieser einzelnen Anzeige in Sekunden oder -1, falls unbekannt.
skipOffset		Die Zeit, die benötigt wird, bis die Anzeige überspringbar ist oder -1, falls er nicht bekannt ist.
universalAdIDRegistry		Ein String, mit dem die URL der Registry-Website identifiziert wird, auf der die universelle Anzeigen-ID des ausgewählten Creatives katalogisiert ist.
universalAdIDValue		Die universelle Anzeigen-ID des ausgewählten Creatives für die Anzeige.
wrappers		Ein Array von ima.WrapperInfo mit Wrapper-Informationen für diese Anzeige. Die Reihenfolge geht vom äußeren zum inneren Wrapper.

createAdInfo()

Gibt ima.AdInfo zurück:

Nach oben

Klasse ima.Companion

Fields

apiFramework, creativeType, height, trackingEvents, url, width

Methoden

createCompanion

Enthält Informationen zu Companions einer Anzeige.

Attribute

Name	Typ	Beschreibung
apiFramework		Die API, die zum Ausführen dieser Anzeige erforderlich ist, oder „Ungültig“, wenn sie nicht verfügbar ist.
creativeType		Stellt den Creative-Typ in der Regel einen MIME-Typ dar.
height		Die Höhe des Companion in Pixeln. 0, wenn nicht verfügbar.
trackingEvents		Eine Zuordnung von Tracking-Ereignissen, wobei der Schlüssel das Ereignis und der Wert eine Liste von URLs ist, die bei diesem Ereignis angepingt werden sollen.
url		Die URL für die statische Ressource dieses Companion.
width		Die Breite des Companion in Pixeln. 0, wenn nicht verfügbar.

createCompanion()

Gibt ima.Companion zurück:

Nach oben

Klasse ima.CuePoint

Fields

end, hasPlayed, start

Methoden

createCuePoint

Enthält Informationen zu einem Cue-Punkt.

Attribute

Name	Typ	Beschreibung
end		Die Endzeit für einen Cue-Punkt in Sekunden. Das entspricht einer Werbeunterbrechung.
hasPlayed		Ein boolescher Wert, der angibt, dass der Cue-Punkt bereits abgespielt wurde.
start		Die Startzeit für einen Cue-Punkt in Sekunden. Das entspricht einer Werbeunterbrechung.

createCuePoint()

Gibt ima.CuePoint zurück:

Nach oben

Klasse ima.Error

Fields

id, info, type

Methoden

createError

Objekt, das an den Fehler-Handler übergeben wird, wenn ein Fehler vorliegt.

Attribute

Name	Typ	Beschreibung
id		Die ID des Fehlers. Eine Liste der Fehlercodes finden Sie in der ErrorEvent-Konstante.
info		Zusätzliche Informationen zum Fehler.
type		Immer auf „error“ setzen, um den Typ dieses Objekts anzugeben.

createError()

Gibt ima.Error zurück:

Nach oben

Klasse ima.ErrorEvent

Fields

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Alle Fehler, die vom SDK möglicherweise zurückgegeben werden.

Attribute

Name	Typ	Beschreibung
BAD_STREAM_REQUEST		Die Streamanfrage wurde nicht korrekt ausgefüllt.
COULD_NOT_LOAD_STREAM		Der Stream konnte nicht geladen werden.
ERROR		Unbekannter Fehler.
INVALID_RESPONSE		Die Serverantwort war ungültig.
STREAM_API_KEY_NOT_VALID		Der angegebene API-Schlüssel wurde vom Server nicht akzeptiert.

Nach oben

Klasse ima.Player

Methoden

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Optional. Wird nach dem Ende einer Werbeunterbrechung aufgerufen

Parameter	Typ	Beschreibung
adBreakInfo	ima.AdBreakInfo	Enthält Informationen zur Werbeunterbrechung.

adBreakStarted(adBreakInfo)

Optional. Wird aufgerufen, wenn eine Werbeunterbrechung gestartet wurde

Parameter	Typ	Beschreibung
adBreakInfo	ima.AdBreakInfo	Enthält Informationen zur Werbeunterbrechung.

allVideoComplete()

Optional. Wird aufgerufen, wenn alle Videos abgespielt wurden.

createPlayer()

Erstellt ein leeres IMA-Player-Objekt. Zum Abspielen von Anzeigen muss die Funktion loadUrl implementiert werden. Andere Funktionen sind optional.

Gibt ima.Player zurück:

loadUrl(streamInfo)

Wird aufgerufen, wenn der Player mit der Wiedergabe einer URL beginnen soll. Sie müssen diese Methode implementieren, um den Stream zu laden.

Parameter	Typ	Beschreibung
streamInfo	ima.StreamInfo	Enthält Informationen, die zum Abspielen von Inhalten erforderlich sind.

Nach oben

Klasse ima.StreamFormat

Fields

DASH, HLS

Definiert das Format des Streams.

Attribute

Name	Typ	Beschreibung
DASH
HLS

Nach oben

Klasse ima.StreamInfo

Fields

format, manifest, streamId, streamType, subtitles

Methoden

createStreamInfo

Informationen zum Stream, die vom SDK an den Player übergeben werden

Attribute

Name	Typ	Beschreibung
format		Das Format des Videos: hls oder Bindestrich. Definiert in ima.StreamFormat.
manifest		URL für den Stream.
streamId		Eine eindeutige ID für den Stream.
streamType		Die Art des Videos: live oder on demand Definiert in ima.StreamType.
subtitles		Untertitel, falls verfügbar. Andernfalls ist dieses Feld ungültig.

createStreamInfo()

Gibt ima.StreamInfo zurück:

Nach oben

Klasse ima.StreamManager

Methoden

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

Objekt zum Verwalten der Streamwiedergabe.

addEventListener(event, callback)

Fügt einen Listener für das angegebene Ereignis hinzu. Die unterstützten Ereignisse finden Sie in der AdEvents-Konstante.

Parameter	Typ	Beschreibung
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Gibt ima.StreamManager zurück:

Parameter	Typ	Beschreibung
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Nicht unterstützt. Stattdessen werden die Daten von der Companion-Anzeige direkt an die RAF übergeben. Dies ist jetzt ein Leerlauf.

getContentTime(streamTime)

Ruft eine Zeit in Millisekunden für einen VOD-Stream ab, die die Zeit im Content ohne Anzeigen darstellt. Weitere Informationen finden Sie unter: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Zum Abrufen der Content-Zeit für die aktuelle Stream-Zeit in -1

Gibt Integer zurück:Die Contentzeit, die der angegebenen Streamzeit entspricht.

Parameter	Typ	Beschreibung
streamTime	Integer	Die Zeit im Stream.

getCuePoints()

Gibt alle Cue-Punkte zurück, die allen Werbeunterbrechungen entsprechen. Dies gilt nur für Video-on-Demand-Content, bei dem alle Werbeunterbrechungen im Voraus bekannt sind. Alle Zeiten geben die Streamzeit in Sekunden an.

Gibt Object zurück:Ein Array mit allen Cue-Punkten.

getPreviousCuePoint(time)

Gibt den Cue-Punkt vor dieser Zeit zurück. Der Cue-Punkt gibt eine Werbeunterbrechung an. Alle Zeiten geben die Streamzeit in Sekunden an.

Gibt ima.CuePoint zurück:ein Objekt mit „start“, „end“ und „hasPlayed“. Gibt „Ungültig“ zurück, wenn kein Cue-Punkt verfügbar ist.

Parameter	Typ	Beschreibung
time	Float	Die Zeit, nach der gesucht werden soll. -1 gibt die aktuelle Zeit an.

getStreamTime(contentTime)

Ruft die Zeit für den Stream aus einer Contentzeit für VOD in Millisekunden ab. Siehe https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Gibt Integer zurück: Die Streamzeit, die der angegebenen Contentzeit entspricht.

Parameter	Typ	Beschreibung
contentTime	Integer	Der Zeitpunkt des Inhalts.

loadThirdPartyStream(streamManifest, streamSubtitle)

Lädt die Anzeigenmetadaten und ruft die Funktion loadUrl mit den bereitgestellten streamManifestUrl- und streamSubtitle-Daten auf. Diese Funktion funktioniert nur, wenn der Streamanfragetyp ima.StreamType.POD_VOD ist.

Parameter	Typ	Beschreibung
streamManifest	string	Die Stream-Manifest-URL mit zusammengefügten Anzeigen.
streamSubtitle	ifArray>|Invalid	Die Untertitel werden mit dem Stream verknüpft oder Invalid, wenn keine Untertitel vorhanden sind.

onMessage(msg)

Verarbeitet alle Nachrichten, die vom Videoobjekt gesendet werden. Muss für jede über den roMessagePort empfangene Nachricht aufgerufen werden.

Parameter	Typ	Beschreibung
msg	object	Die Nachricht vom roVideo-Port.

replaceAdTagParameters(adTagParameters)

Ersetzt alle Anzeigen-Tag-Parameter, die für die bevorstehenden Anzeigenanfragen für einen Livestream verwendet werden sollen. Beachten Sie, dass dieser Aufruf bei VOD-Streams kein Vorgang ist.

Parameter	Typ	Beschreibung
adTagParameters	string	Die neuen Anzeigen-Tag-Parameter.

start()

Startet die Wiedergabe des Streams.

Nach oben

Klasse ima.StreamRequest

Fields

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player,ppSessionOptions, player,ppsSession, playeridMonitor Id2}ppidstreamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Methoden

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

Wird zum Angeben von Eigenschaften der Streamanfrage verwendet.

Attribute

Name	Typ	Beschreibung
adTagParameters		Optional. In Ihrer Streamanfrage können Sie eine begrenzte Anzahl von Anzeigen-Tag-Parametern überschreiben. Wenn Sie einem Stream Targeting-Parameter hinzufügen, erhalten Sie weitere Informationen. Sie können auch die Parameter dai-ot und dai-ov für die Einstellung der Streamvarianten verwenden. Weitere Informationen finden Sie unter Parameter der Streamvarianten überschreiben.
adUiNode		Ein Knotendiagramm für das Szenendiagramm, in dem die Benutzeroberfläche der Anzeige angezeigt wird. IMA platziert Elemente wie die Schaltflächen Warum sehe ich diese Werbung? und Überspringen in diesem Element, während die Anzeigen eingeblendet werden. Das Element muss das gesamte Videoelement überlagern.
apiKey		Optional. Mit diesen Schlüsseln können Streamanfragen authentifiziert werden. Authentifizierungsschlüssel für die dynamische Anzeigenbereitstellung müssen auf der DFP-Benutzeroberfläche eingerichtet werden.
assetKey		Erforderlich für Livestreams. Damit wird bestimmt, welcher Stream wiedergegeben werden soll. Der Assetschlüssel der Livestreamanfrage ist eine Kennung, die Sie auf der DFP-Benutzeroberfläche finden.
authToken		Das Autorisierungstoken der Streamanfrage. Wird anstelle des API-Schlüssels für eine strengere Inhaltsautorisierung verwendet. Der Verlag oder Webpublisher kann die Autorisierungen für einzelne Contentstreams anhand dieses Tokens steuern.
contentSourceId		Erforderlich für On-Demand-Streams. Die cmsid stammt aus der DFP-Video-Contentquelle in der DFP-Benutzeroberfläche.
customAssetKey		Anhand des benutzerdefinierten Assetschlüssels wird bestimmt, welcher Stream wiedergegeben werden soll. Für Streamanfragen für die Pod-Auslieferung sind benutzerdefinierte Asset-Schlüssel erforderlich.
format		Das Format des Streams. Die Standardeinstellung ist ima.StreamFormat.HLS.
networkCode		Das ist der Netzwerkcode für den Publisher, der die Streamanfrage stellt. Netzwerkcodes sind für Streamanfragen für die Pod-Auslieferung erforderlich.
player		Eine Implementierung der Player-Oberfläche.
ppid		Veraltet. Verwenden Sie adTagParameters. Optional. Eine vom Publisher bereitgestellte Kennung für DFP Audience.
streamActivityMonitorId		Die ID, die zum Debuggen des Streams mit der Überprüfung der Streamingaktivitäten verwendet werden soll. Damit können Publisher auf einfache Weise ein Stream-Log in der Überwachung der Streamingaktivitäten finden.
videoId		Erforderlich für On-Demand-Streams. Die ID der Quelle des Videocontents.
videoObject		Das Videoobjekt (z. B. Video-roSGNode), das für die Videowiedergabe in der Client-App zuständig ist. Dieses Objekt wird nach verschiedenen Daten abgefragt, die zum richtigen Timing von Live-HLS-ID3-Ereignissen verwendet werden.
videoStitcherSessionOptions		Die Sitzungsoptionen werden verwendet, um video-sticher-spezifische Parameter für VideoStitcher streamRequests festzulegen.

createLiveStreamRequest(assetKey, apiKey)

Initialisiert die erforderlichen Eigenschaften einer Live-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt ima.StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen Live-Properties zurück.

Parameter	Typ	Beschreibung
assetKey	string
apiKey	string	Optionaler Parameter, der dem Attribut apiKey des zurückgegebenen StreamRequest zugewiesen wird. Der Standardwert ist ein leerer String.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Initialisiert die erforderlichen Attribute einer Pod-Live-ima.StreamRequest. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen PodLive-Attributen zurück.

Parameter	Typ	Beschreibung
customAssetKey	string
networkCode	string
apiKey	string	Optionaler Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen wird. Der Standardwert ist ein leerer String.

createPodVodStreamRequest(networkCode)

Initialisiert die erforderlichen Attribute eines ima.StreamRequest, um einen VOD-Stream zu registrieren, wenn die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung mit dem Video Stitcher eines Drittanbieters verwendet wird. Diese Funktion legt den Anfragetyp auf ima.StreamType.POD_VOD fest und validiert alle erforderlichen Attribute auf fehlende Daten. Fehlgeschlagene Validierungen melden einen Fehler in der Debug-Konsole.

Gibt StreamRequest zurück:ein ima.StreamRequest-Objekt. Wenn alle erforderlichen Attribute angegeben sind, wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt.

Parameter	Typ	Beschreibung
networkCode	string	den Google Ad Manager-Netzwerkcode

createStreamRequest()

Gibt ima.StreamRequest zurück:Ein leeres ima.StreamRequest-Objekt.

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

Initialisiert die erforderlichen Eigenschaften eines Live-StreamRequest von Video Stitcher. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt ima.StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherLive-Eigenschaften zurück.

Parameter	Typ	Beschreibung
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

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

Initialisiert die erforderlichen Attribute eines Video Stitcher-VOD-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt ima.StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherVod-Eigenschaften zurück.

Parameter	Typ	Beschreibung
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

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

Initialisiert die erforderlichen Attribute eines Video Stitcher-VOD-StreamRequest mit einer aus Cloud Video Stitcher erstellten vodConfigId. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt ima.StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherVod-Eigenschaften zurück.

Parameter	Typ	Beschreibung
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialisiert die erforderlichen Attribute eines VOD-ima.StreamRequest. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, tritt ein Fehler-Logging auf und die API gibt eine generische StreamRequest zurück, in der keine Attribute ignoriert werden.

Gibt ima.StreamRequest: ima.StreamRequest-Objekt mit den erforderlichen VOD-Attributen zurück.

Parameter	Typ	Beschreibung
contentSourceId	string
videoId	string
apiKey	string	Optionaler Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen wird. Der Standardwert ist ein leerer String.

Nach oben

Klasse ima.StreamType

Fields

LIVE, VOD

Definiert die Art des Streams, den der Player wiedergeben soll. Pre-Rolls und VOD sollten am Anfang des Streams wiedergegeben werden.

Attribute

Name	Typ	Beschreibung
LIVE		Das Video ist online.
VOD		Das Video ist on demand verfügbar.

Nach oben

Klasse ima.WrapperInfo

Fields

adId, adSystem, creativeAdId, creativeId, dealId

Methoden

createWrapperInfo

Enthält Informationen zu einem Wrapper.

Attribute

Name	Typ	Beschreibung
adId		Die ID der Anzeige oder ein leerer String, falls dieser unbekannt ist.
adSystem		Der deklarierte Name des Anzeigensystems oder ein leerer String, falls dieser unbekannt ist.
creativeAdId		Die Anzeigen-ID des Creatives oder ein leerer String, falls dieser unbekannt ist.
creativeId		Die ID des Creatives oder ein leerer String, falls dieser unbekannt ist.
dealId		Die Deal-ID oder ein leerer String, falls dieser unbekannt ist

createWrapperInfo()

Gibt ima.WrapperInfo zurück:

Nach oben