Cette page a été traduite par l'API Cloud Translation.

SDK IMA DAI pour Roku

Class ima

Méthodes

disableLogging, getStreamManager, initSdk, requestStream

Fonctions globales qui contrôlent le SDK IMA.

`disableLogging()`

Désactive la journalisation du SDK. La journalisation est activée par défaut.

`getStreamManager()`

Renvoie un gestionnaire de flux s'il est disponible. Si le gestionnaire de flux n'est pas encore disponible, la valeur "Invalid" est renvoyée. En cas d'erreur lors de la création du gestionnaire de flux, un objet d'erreur est renvoyé.

Renvoie object:le gestionnaire de flux ou l'objet d'erreur.

`initSdk(settings)`

Initialise le SDK.

Paramètre	Type	Description
`settings`	`object`	Objet de paramètres IMA facultatif.

`requestStream(streamRequest)`

Démarre une requête de flux asynchrone. Le contrôle est immédiatement renvoyé au lecteur après l'appel de cette méthode.

Renvoie object:une erreur ou une valeur non valide en l'absence d'erreur

Paramètre	Type	Description
`streamRequest`	`object`

Nom	Type	Description
`adPosition`		Indice de l'annonce dans la coupure publicitaire. L'index est `1` pour les annonces autonomes.
`duration`		Durée maximale de la coupure en secondes, ou `-1` si inconnue.
`podIndex`		Pour les diffusions en direct, renvoie l'ID de la coupure en tant qu'indice de pod, ou `0` pour un pré-roll. Les postrolls ne sont pas disponibles dans les diffusions en direct. La valeur par défaut est `-2`. Pour la vidéo à la demande (VOD), renvoie l'indice de la série d'annonces. Pour une série d'annonces pré-roll, renvoie `0`. Pour les annonces mid-roll, renvoie `1`, `2`, ..., n. Pour une série d'annonces post-roll, renvoie n+1...n+x. La valeur par défaut est `0` si cette annonce ne fait pas partie d'une série d'annonces ou si cette série d'annonces ne fait pas partie d'une playlist.
`timeOffset`		Position de la série d'annonces dans le contenu, en secondes. Les annonces pré-roll renvoient `0`, les annonces post-roll renvoient `-1` et les annonces mid-roll renvoient l'heure planifiée du pod.
`totalAds`		Nombre total d'annonces contenues dans cette coupure publicitaire. La valeur est `1` pour les annonces autonomes.

Nom	Type	Description
`AD_PERIOD_ENDED`		Déclenché chaque fois que le flux passe de la publicité ou de l'écran de programmation au contenu. Cette action est déclenchée même lorsqu'une annonce est diffusée une deuxième fois ou lors d'une recherche dans une annonce.
`AD_PERIOD_STARTED`		Déclenché chaque fois que le flux passe du contenu à la publicité ou à un écran. Cette action est déclenchée même lorsqu'une annonce est diffusée une deuxième fois ou lors d'une recherche dans une annonce.
`COMPLETE`		Déclenché à la fin de l'annonce
`ERROR`		Déclenché lorsqu'une erreur se produit.
`FIRST_QUARTILE`		Déclenché lorsque le point de lecture de l'annonce franchit le premier quartile.
`ICON_FALLBACK_IMAGE_CLOSED`		Déclenché lorsque l'utilisateur ferme la boîte de dialogue d'image de remplacement de l'icône.
`ICON_FALLBACK_IMAGE_SHOWN`		Déclenché lorsque l'image de remplacement de l'icône s'affiche.
`MIDPOINT`		Déclenché lorsque la tête de lecture de l'annonce passe au milieu
`PROGRESS`		Déclenché lorsqu'une annonce est mise à jour
`SKIPPABLE_STATE_CHANGED`		Déclenché lorsqu'un état d'annonce désactivable change.
`SKIPPED`		Déclenché lorsqu'une annonce est ignorée
`START`		Déclenché lorsqu'une annonce commence à être lue
`THIRD_QUARTILE`		Déclenché lorsque le point de lecture de l'annonce dépasse le troisième quartile.

Nom	Type	Description
`adBreakInfo`		Informations sur l'ensemble de la coupure publicitaire dans laquelle se trouve cette annonce.
`adDescription`		Description de l'annonce.
`adId`		ID de l'annonce ou chaîne vide si inconnu.
`adSystem`		Système publicitaire fournissant la création.
`adTitle`		Titre de l'annonce.
`advertiserName`		Nom de l'annonceur tel que défini par la partie chargée de la diffusion.
`companions`		Annonces associées spécifiées dans la réponse VAST.
`creativeAdId`		Code ISCI (Industry Standard Commercial Identifier) d'une annonce. Il s'agit de l'ID de l'annonce de la création sélectionnée dans la réponse VAST.
`creativeId`		ID de la création sélectionnée pour l'annonce.
`currentTime`		Heure actuelle dans une annonce (en secondes) ou -1 si inconnue.
`dealId`		Renvoie le premier ID d'accord présent dans la chaîne de wrapper pour l'annonce actuelle, en commençant par le haut.
`duration`		Durée de cette annonce unique en secondes ou -1 si inconnue.
`skipOffset`		Temps nécessaire pour que l'annonce devienne désactivable, ou -1 si inconnu.
`universalAdIDRegistry`		Chaîne utilisée pour identifier l'URL du site Web du registre où l'identifiant publicitaire universel de la création sélectionnée est catalogué.
`universalAdIDValue`		Identifiant d'annonce universel de la création sélectionnée pour l'annonce.
`wrappers`		Tableau d'ima.WrapperInfo contenant des informations sur le wrapper de cette annonce. L'ordre sera du wrapper externe au wrapper interne.

Nom	Type	Description
`apiFramework`		API requise pour exécuter cette annonce, ou "Invalid" (Non valide) si elle n'est pas disponible.
`creativeType`		Représente le type de création, généralement un type MIME.
`height`		Hauteur de l'accessoire en pixels. 0 si elle n'est pas disponible.
`trackingEvents`		Carte des événements de suivi, où la clé correspond à l'événement et la valeur à une liste d'URL à pinger lors de cet événement.
`url`		URL de la ressource statique de ce compagnon.
`width`		Largeur de l'accessoire en pixels. 0 si elle n'est pas disponible.

Nom	Type	Description
`end`		Heure de fin d'un repère, en secondes. Cela correspond à une coupure publicitaire.
`hasPlayed`		Valeur booléenne indiquant que le point de repère a déjà été lu.
`start`		Heure de début d'un repère, en secondes. Cela correspond à une coupure publicitaire.

Nom	Type	Description
`id`		ID de l'erreur. Consultez la constante ErrorEvent pour obtenir la liste des codes d'erreur.
`info`		Informations supplémentaires sur l'erreur.
`type`		Toujours défini sur "error" pour indiquer le type de cet objet.

Nom	Type	Description
`BAD_STREAM_REQUEST`		La requête de flux n'a pas été renseignée correctement.
`COULD_NOT_LOAD_STREAM`		Impossible de charger le flux.
`ERROR`		Une erreur inconnue.
`INVALID_RESPONSE`		La réponse du serveur n'était pas valide.
`STREAM_API_KEY_NOT_VALID`		La clé API fournie n'a pas été acceptée par le serveur.

Nom	Type	Description
`format`		Format de la vidéo: hls ou dash. Défini dans ima.StreamFormat.
`manifest`		URL du flux.
`streamId`		ID unique de la diffusion.
`streamType`		Type de vidéo: en direct ou à la demande Défini dans ima.StreamType.
`subtitles`		Sous-titres, le cas échéant Non valide si ce n'est pas le cas.

Paramètre	Type	Description
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Paramètre	Type	Description
`streamManifest`	`string`	URL du fichier manifeste du flux avec les annonces intégrées.
`streamSubtitle`	`ifArray>\|Invalid`	Sous-titres associés au flux, ou `Invalid` si aucun.

Nom	Type	Description
`adTagParameters`		Facultatif. Vous pouvez remplacer un ensemble limité de paramètres de balise publicitaire dans votre requête de flux. Pour en savoir plus, consultez Indiquer des paramètres de ciblage dans votre flux. Vous pouvez également utiliser les paramètres dai-ot et dai-ov pour la préférence de variante de flux. Pour en savoir plus, consultez la section Remplacer les paramètres de variantes de flux.
`adUiNode`		Nœud de graphes de scène où l'UI de l'annonce s'affiche. IMA place des éléments tels que les boutons Pourquoi cette annonce ? et Ignorer sur cet élément pendant les annonces. L'élément doit recouvrir l'intégralité de l'élément vidéo.
`apiKey`		Facultatif. Ces clés peuvent être utilisées pour authentifier les requêtes de flux. Les clés d'authentification pour l'insertion dynamique d'annonce doivent être configurées dans l'interface utilisateur de DFP.
`assetKey`		Obligatoire pour les diffusions en direct. Il permet de déterminer le flux à lire. La clé d'élément de la requête de diffusion en direct est un identifiant disponible dans l'interface utilisateur de DFP.
`authToken`		Jeton d'autorisation de la requête de flux. Utilisé à la place de la clé API pour une autorisation de contenu plus stricte. L'éditeur peut contrôler les autorisations de flux de contenu individuelles en fonction de ce jeton.
`contentSourceId`		Obligatoire pour les diffusions à la demande. Le cmsid provient de la source de contenu vidéo DFP dans l'interface utilisateur de DFP.
`customAssetKey`		La clé d'élément personnalisée permet de déterminer quel flux doit être lu. Les clés d'éléments personnalisées sont requises pour les requêtes de flux de diffusion de pod.
`format`		Format du flux. La valeur par défaut est `ima.StreamFormat.HLS`.
`networkCode`		Code de réseau de l'éditeur à l'origine de la requête de flux. Les codes réseau sont obligatoires pour les requêtes de diffusion de flux de pod effectuées avec createPodLiveStreamRequest ou createPodVodStreamRequest. Ces codes sont également requis pour les requêtes de flux de collage Cloud effectuées avec createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVideoStitcherVodStreamRequestWithVodConfig. Ces codes sont facultatifs et recommandés pour les requêtes de flux de service complet effectuées avec createLiveStreamRequest ou createVodStreamRequest. L'ajout du code réseau applique les paramètres sélectionnés dans l'interface utilisateur d'Ad Manager, comme l'activation des annonces limitées programmatiques. Pour le traitement de pod et l'assemblage Cloud, l'ajout du code réseau permet de localiser et de lire le flux. Pour trouver le code de réseau, consultez cet article.
`player`		Implémentation de l'interface du lecteur.
`ppid`		Obsolète. Utilisez adTagParameters. Facultatif. Identifiant fourni par l'éditeur pour une audience DFP.
`streamActivityMonitorId`		ID à utiliser pour déboguer le flux avec l'outil de contrôle de l'activité des flux. Cela permet aux éditeurs de trouver facilement un journal de flux dans l'outil de surveillance de l'activité des flux.
`videoId`		Obligatoire pour les diffusions à la demande. Identifiant de la source de contenu vidéo.
`videoObject`		Objet vidéo (tel que le roSGNode vidéo) responsable de la lecture vidéo dans l'application cliente. Cet objet sera interrogé pour diverses données à utiliser pour chronométrer correctement les événements ID3 HLS en direct.
`videoStitcherSessionOptions`		Les options de session permettent de définir des paramètres spécifiques au montage vidéo pour les streamRequests VideoStitcher.

Paramètre	Type	Description
`assetKey`	`string`
`apiKey`	`string`	Paramètre attribué à la propriété `ima.StreamRequest.apiKey` de l'`ima.StreamRequest` renvoyé. Si aucune clé API n'existe, transmettez une chaîne vide.
`networkCode`	`string`	Code réseau de l'éditeur à l'origine de la requête de flux. L'ajout du code réseau est facultatif, mais recommandé.

Paramètre	Type	Description
`contentSourceId`	`string`
`videoId`	`string`
`apiKey`	`string`	Paramètre attribué à la propriété `ima.StreamRequest.apiKey` de l'`ima.StreamRequest` renvoyé. Si aucune clé API n'existe, transmettez une chaîne vide.
`networkCode`	`string`	Code réseau de l'éditeur à l'origine de la requête de flux. L'ajout du code réseau est facultatif, mais recommandé.

Paramètre	Type	Description
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Paramètre	Type	Description
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Nom	Type	Description
`LIVE`		La vidéo est en ligne.
`VOD`		La vidéo est disponible à la demande.

SDK IMA DAI pour Roku

Class ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Classe ima.AdBreakInfo

Propriétés

createAdBreakInfo()

Classe ima.AdEvent

Propriétés

Classe ima.AdInfo

Propriétés

createAdInfo()

Classe ima.Companion

Propriétés

createCompanion()

Classe ima.CuePoint

Propriétés

createCuePoint()

Classe ima.Error

Propriétés

createError()

Classe ima.ErrorEvent

Propriétés

Classe ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

Classe ima.StreamFormat

Propriétés

Classe ima.StreamInfo

Propriétés

createStreamInfo()

Classe ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Classe ima.StreamRequest

Propriétés

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Classe ima.StreamType

Propriétés

Classe ima.WrapperInfo

Propriétés

createWrapperInfo()

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

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

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

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`