StreamManager
Gère les flux d'insertion dynamique d'annonces. Il gère les interactions avec le backend d'insertion dynamique d'annonce, les pings de suivi, ainsi que le transfert des événements de flux et d'annonce à l'éditeur. Ce gestionnaire n'hérite pas de BaseAdsManager, car il n'est pas administrateur pour une annonce spécifique, mais un pour l'ensemble du flux.
Constructeur
StreamManager
nouveau StreamManager(videoElement, adUiElement, uiSettings)
Paramètres |
|
|---|---|
|
videoElement |
Élément vidéo HTML où la lecture aura lieu. La valeur ne doit pas être nulle. |
|
adUiElement |
Facultatif Élément HTML à utiliser pour contenir les éléments d'interface utilisateur de l'annonce. Cet élément doit avoir la même hauteur et la même largeur que la lecture de la vidéo, et doit le superposer directement. Si cette option n'est pas spécifiée, aucune interface utilisateur ne s'affichera et aucune annonce nécessitant une interface utilisateur, comme des annonces désactivables, ne sera demandée. La valeur ne doit pas être nulle. |
|
uiSettings |
Facultatif Paramètres d'interface utilisateur à utiliser pour ce flux. La valeur ne doit pas être nulle. |
- Implémentations
- EventTarget
- Génère
-
Lorsque les paramètres d'entrée ne répondent pas aux exigences.
Méthodes
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) renvoie un nombre
Affiche la durée du contenu sans annonces pour une durée de diffusion donnée. Renvoie la durée de diffusion indiquée pour les diffusions en direct.
Paramètres |
|
|---|---|
|
streamTime |
number Durée du flux avec les annonces insérées (en secondes). |
- Renvoie
-
number: durée du contenu correspondant à la durée du flux, une fois les annonces supprimées.
concentration
sélectionner()
Place le curseur sur le bouton "Ignorer", le cas échéant. S'ils ne sont pas présents, les éléments interactifs sont sélectionnés, comme les icônes ou les créations interactives.
getAdSkippableState
getAdAdSenseState() renvoie une valeur booléenne
Renvoie la valeur "true" si l'annonce peut être ignorée. Lorsque cette valeur change, StreamManager déclenche un événement StreamEvent.SKIPPABLE_STATE_CHANGED.
- Renvoie
-
boolean"True" si l'annonce peut être ignorée, ou "false" dans le cas contraire.
loadStreamMetadata
loadStreamMetadata()
Demande au SDK de charger les métadonnées de l'annonce, puis diffuse StreamEvent.LOADED. Il doit se déclencher manuellement une fois que le fichier manifeste du flux a été récupéré à partir de l'outil d'assemblage vidéo tiers. Ce paramètre n'est utilisé que pour la VOD de diffusion de séries d'annonces avec un assembleur vidéo tiers. Il n'est pas opérationnel pour les autres demandes de flux.
onTimedMetadata
onTimedMetadata(metadata)
Transmet des données dans un dictionnaire de métadonnées traitées. Le dictionnaire attend la clé "TXXX" avec la chaîne de métadonnées définie par l'utilisateur comme valeur. Si votre lecteur fournit des métadonnées brutes, appelez plutôt StreamManager.processMetadata.
Paramètres |
|
|---|---|
|
métadonnées |
Objet Dictionnaire de métadonnées. La valeur ne doit pas être nulle. |
previousCuePointForStreamTime
précédentCuePointForStreamTime(streamTime) renvoie CuePoint
Renvoie le point de repère précédent pour l'heure du flux donnée. Renvoie la valeur "null" si aucun point de repère n'existe. Elle est utilisée pour implémenter des fonctionnalités telles que le retour arrière. Elle est appelée lorsque l'éditeur détecte que l'utilisateur a recherché un élément afin de le renvoyer vers une coupure publicitaire.
Paramètres |
|
|---|---|
|
streamTime |
number la durée de diffusion recherchée. |
- Renvoie
-
nullable CuePoint: point de repère précédent pour la durée du flux donnée.
processMetadata
processMetadata(type, data, timestamp)
Traitement des métadonnées planifiées pour les diffusions en direct À utiliser si votre lecteur vidéo fournit des métadonnées non analysées ainsi que des codes temporels. Sinon, appelez StreamManager.onTimedMetadata.
Paramètres |
|
|---|---|
|
type |
chaîne Saisissez du texte pour les métadonnées. Doit correspondre à "ID3" pour le protocole HLS ou à l'URI de l'ID du schéma de message d'événement pour le protocole DASH. |
|
données |
(Uint8Array ou chaîne non nul) Données brutes de la balise. Pour ID3, doit correspondre à l'intégralité des données brutes de la balise. Pour les messages d'événement DASH, il s'agit de la chaîne de données du message. |
|
timestamp |
number Durée en secondes pendant laquelle les données doivent être traitées. Pour DASH, il s'agit de l'heure de début du message d'événement. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
Remplace tous les paramètres de tag d'emplacement publicitaire utilisés pour les demandes d'annonces à venir pour une diffusion en direct.
Paramètres |
|
|---|---|
|
adTagParameters |
Objet avec propriétés de chaîne Paramètres du nouveau tag d'emplacement publicitaire. Doit contenir des valeurs de chaîne. La valeur ne doit pas être nulle. |
requestStream
requestStream(streamRequest)
Demande le chargement d'un flux à l'aide des paramètres de flux fournis.
Paramètres |
|
|---|---|
|
streamRequest |
contient des paramètres permettant de charger les métadonnées du flux. La valeur ne doit pas être nulle. |
reset
réinitialiser()
Réinitialise le gestionnaire de flux et supprime les sondages en continu.
setClickElement
setClickElement(clickElement)
Définit l'élément cliquable dans les annonces. Cet élément est utilisé comme récepteur de clic pendant la lecture d'une annonce et peut le faire sortir de la page actuelle. Cette méthode est désormais obsolète. Un adUiElement doit être transmis à StreamManager à la place. Si un adUiElement est fourni au constructeur StreamManager, cette méthode devient une no-op.
Paramètres |
|
|---|---|
|
clickElement |
Élément Élément utilisé lors du clic sur l'annonce. La valeur peut être nulle. |
- Obsolète
- Fournissez plutôt un adUiElement au constructeur StreamManager.
streamTimeForContentTime
streamTimeForContentTime(contentTime) renvoie un nombre
Renvoie la durée de diffusion avec les annonces correspondant à une durée de contenu donnée. Affiche la date et l'heure du contenu indiqué pour les diffusions en direct.
Paramètres |
|
|---|---|
|
contentTime |
number la durée du contenu sans publicité (en secondes). |
- Renvoie
-
number: durée du flux correspondant à la durée du contenu donnée une fois les annonces insérées.