StreamManager
Gère les flux d'insertion d'annonces dynamiques. Il gère les interactions avec le backend d'insertion dynamique d'annonce, les pings de suivi, ainsi que le transfert des flux et des événements d'annonce à l'éditeur. Ce gestionnaire n'hérite pas du BaseAdsManager, car il ne s'agit pas du gestionnaire d'une annonce spécifique, mais du gestionnaire de l'ensemble du flux.
Constructeur
StreamManager
nouveau StreamManager(videoElement, adUiElement, uiSettings)
Paramètres |
|
|---|---|
|
videoElement |
Élément vidéo HTML dans lequel 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 vidéo lue, et doit le superposer directement. Si cette option n'est pas fournie, aucune UI n'est affichée, et aucune annonce nécessitant une UI (par exemple, les annonces désactivables) ne sera demandée. La valeur ne doit pas être nulle. |
|
uiSettings |
Facultatif Paramètres d'UI à utiliser pour ce flux. La valeur ne doit pas être nulle. |
- 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 le temps de contenu sans annonce pour une durée de diffusion donnée. Renvoie la durée de diffusion donnée pour les diffusions en direct.
Paramètres |
|
|---|---|
|
streamTime |
Nombre Durée de diffusion avec les annonces insérées (en secondes). |
- Renvoie
-
number: durée du contenu correspondant à la durée de diffusion donnée une fois les annonces supprimées.
concentration
focus()
Place le curseur sur le bouton "Ignorer", le cas échéant. Si aucun élément n'est présent, le curseur est placé sur les éléments interactifs, y compris les icônes ou les créations interactives.
getAdSkippableState
La méthode getAdDésactivable() 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: valeur "true" si l'annonce peut être ignorée, valeur "false" dans le cas contraire.
loadStreamMetadata
loadStreamMetadata()
Demande au SDK de charger les métadonnées de l'annonce, puis diffuse StreamEvent.LOADED. Ce déclenchement doit être déclenché manuellement une fois que le fichier manifeste du flux a été récupéré auprès d'un assembleur vidéo tiers. Cette méthode n'est utilisée que pour la VOD de diffusion de séries d'annonces avec un assembleur vidéo tiers. Elle n'est pas exécutable pour les autres requêtes de flux.
onTimedMetadata
onTimedMetadata(metadata)
Transmet 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 |
Objets Dictionnaire de métadonnées. La valeur ne doit pas être nulle. |
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime) renvoie CuePoint
Renvoie le point de repère précédent correspondant à la durée du flux donnée. Renvoie la valeur "null" si aucun point de repère n'existe. Elle permet d'implémenter des fonctionnalités telles que le retour rapide. Elle est appelée lorsque l'éditeur détecte que l'utilisateur a recherché des informations afin de le renvoyer vers une coupure publicitaire.
Paramètres |
|
|---|---|
|
streamTime |
Nombre l'heure de flux recherchée. |
- Renvoie
-
nullable CuePointest le point de repère précédent pour la durée de flux donnée.
processMetadata
processMetadata(type, data, timestamp)
Traite les métadonnées associées à des codes temporels 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 Type pour les métadonnées. Doit être "ID3" pour HLS ou l'URI d'ID du schéma de message d'événement pour DASH. |
|
data |
(Uint8Array ou chaîne non nul) Données brutes sur la balise. Pour ID3, il doit s'agir de l'ensemble des données brutes du tag. Pour les messages d'événement DASH, il s'agit de la chaîne de données du message. |
|
timestamp |
Nombre Temps de traitement des données, en secondes. 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 un flux en direct.
Paramètres |
|
|---|---|
|
adTagParameters |
Objet avec propriétés de chaîne Nouveaux paramètres du 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 les paramètres permettant de charger les métadonnées du flux. La valeur ne doit pas être nulle. |
réinitialiser
réinitialiser()
Réinitialise le gestionnaire de flux et supprime toute interrogation continue.
setClickElement
setClickElement(clickElement)
Définit l'élément de redirection des annonces. Cet élément est utilisé comme récepteur de clic ou d'appui pendant la lecture d'une annonce et peut entraîner une navigation en dehors de la page actuelle. Cette valeur 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 opération no-op.
Paramètres |
|
|---|---|
|
clickElement |
Élément Élément utilisé pour le 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.
Affiche la durée de diffusion avec les annonces pour une durée de contenu donnée. Renvoie la durée de contenu donnée pour les diffusions en direct.
Paramètres |
|
|---|---|
|
contentTime |
Nombre la durée sans annonces (en secondes) du contenu ; |
- Renvoie
-
number: durée de diffusion correspondant à l'heure de diffusion du contenu donnée une fois les annonces insérées.