StreamManager
Gère les flux d'insertion dynamique d'annonces. Il gère les interactions avec le backend DAI et les pings de suivi, ainsi que la transmission des flux et des événements d'annonces à l'éditeur. Ce gestionnaire n'hérite pas de BaseAdsManager, car il ne s'agit pas d'un gestionnaire pour une annonce spécifique, mais pour l'ensemble du flux.
Constructeur
StreamManager
new StreamManager(videoElement, adUiElement, uiSettings)
Constructeur.
Paramètre |
|
|---|---|
|
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 lecture vidéo et doit se superposer directement à celle-ci. Si vous ne fournissez pas d'UI, aucune UI ne s'affichera, et aucune annonce nécessitant une UI, comme les annonces désactivables, ne sera demandée. |
|
uiSettings |
Facultatif Paramètres d'interface utilisateur à utiliser pour cette diffusion. La valeur ne doit pas être nulle. |
- Génère
-
lorsque les paramètres d'entrée ne respectent pas les exigences.
Propriétés
clickElement
HTMLElement non nul
clickElement
HTMLElement non nul
streamMonitor
PodServingStreamMonitor non nul
Méthodes
addEventListener
addEventListener(type, listener) renvoie void
Ajoute un écouteur pour le type d'événement donné.
Paramètre |
|
|---|---|
|
type |
chaîne Type d'événement à écouter. |
|
écouteur |
function(non-null StreamEvent) Fonction appelée chaque fois qu'un événement de ce type se produit. |
- Renvoie
-
void
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) renvoie un nombre
Indique la durée du contenu sans annonces pour un temps de diffusion donné. Renvoie l'heure de diffusion donnée pour les diffusions en direct.
Paramètre |
|
|---|---|
|
streamTime |
Total la durée de la diffusion avec les annonces insérées (en secondes). |
- Renvoie
-
number: durée du contenu correspondant à l'heure de diffusion donnée une fois les annonces supprimées.
concentration
focus() renvoie un résultat vide
Déplace le focus sur le bouton "Ignorer", le cas échéant. Si elle n'est pas présente, l'accent est mis sur les éléments interactifs, y compris les icônes ou les créations interactives.
- Renvoie
-
void
getAdSkippableState
getAdSkippableState() renvoie une valeur booléenne
Renvoie la valeur "true" si l'annonce peut actuellement être ignorée. Lorsque cette valeur change, StreamManager génère un événement StreamEvent.SKIPPABLE_STATE_CHANGED.
- Renvoie
-
booleanValeur "true" si l'annonce peut actuellement être ignorée, sinon valeur "false".
loadStreamMetadata
loadStreamMetadata() renvoie une valeur vide
Demande au SDK de charger les métadonnées de l'annonce, puis diffuse StreamEvent.LOADED. Cette opération doit être déclenchée manuellement une fois que le fichier manifeste de flux a été récupéré auprès d'un outil de montage vidéo tiers. Cette option n'est utilisée que pour la diffusion VOD en série avec un outil de montage vidéo tiers et n'a aucune incidence sur les autres requêtes de flux.
- Renvoie
-
void
onTimedMetadata
onTimedMetadata(metadata) renvoie void
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ètre |
|
|---|---|
|
métadonnées |
(objet nul ou non nul avec des propriétés de chaîne) Dictionnaire des métadonnées. |
- Renvoie
-
void
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime) returns (null or CuePoint)
Renvoie le point de repère précédent pour l'heure de flux donnée. Renvoie la valeur nulle si aucun point de repère de ce type n'existe. Cette méthode permet d'implémenter des fonctionnalités telles que le retour en arrière et est appelée lorsque l'éditeur détecte que l'utilisateur a effectué une recherche afin de le renvoyer à une coupure publicitaire.
Paramètre |
|
|---|---|
|
streamTime |
Total L'heure du flux à laquelle la recherche a été effectuée. |
- Renvoie
-
(null or non-null CuePoint): point de repère précédent pour l'heure de diffusion donnée.
processMetadata
processMetadata(type, data, timestamp) renvoie void
Traite les métadonnées temporelles pour les diffusions en direct. À utiliser si votre lecteur vidéo fournit des métadonnées non analysées avec des codes temporels. Sinon, appelez StreamManager.onTimedMetadata.
Paramètre |
|
|---|---|
|
type |
chaîne Type de métadonnées. Doit être "ID3" pour HLS ou l'URI de l'ID de schéma de message d'événement pour DASH. |
|
données |
(chaîne ou Uint8Array non nul) Données de balise brutes. Pour ID3, il doit s'agir de 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 |
Total Heure (en secondes) à laquelle les données doivent être traitées. Pour DASH, il s'agit de l'heure de début du message d'événement. |
- Renvoie
-
void
removeEventListener
removeEventListener(type, listener) renvoie void
Supprime un écouteur pour le type d'événement donné. La fonction d'écouteur doit être égale par référence à celle précédemment transmise à addEventListener.
Paramètre |
|
|---|---|
|
type |
chaîne Type d'événement pour lequel supprimer l'écouteur. |
|
écouteur |
function(non-null StreamEvent) Fonction à supprimer en tant qu'écouteur. |
- Renvoie
-
void
replaceAdTagParameters
replaceAdTagParameters(adTagParameters) renvoie void
Remplace tous les paramètres de tag d'emplacement publicitaire utilisés dans les demandes d'annonces à valider pour un flux en direct.
Paramètre |
|
|---|---|
|
adTagParameters |
Objet avec des propriétés de chaîne Nouveaux paramètres de la balise publicitaire. Doit comporter des valeurs de chaîne. La valeur ne doit pas être nulle. |
- Renvoie
-
void
requestStream
requestStream(streamRequest) renvoie void
Demande le chargement d'un flux à l'aide des paramètres de flux fournis.
Paramètre |
|
|---|---|
|
streamRequest |
contient des paramètres permettant de charger les métadonnées du flux. La valeur ne doit pas être nulle. |
- Renvoie
-
void
réinitialiser
reset() renvoie void
Réinitialise le gestionnaire de flux et supprime tout sondage continu.
- Renvoie
-
void
setClickElement
setClickElement(clickElement) renvoie void
Définit l'élément de clic sur les annonces. Cet élément est utilisé comme récepteur de clic ou d'appui pendant la lecture d'une annonce et peut entraîner la navigation vers une autre page. Cette méthode est désormais obsolète. Un élément adUiElement doit être transmis au StreamManager à la place. Si un adUiElement est fourni au constructeur StreamManager, cette méthode devient une opération sans effet.
Paramètre |
|
|---|---|
|
clickElement |
(élément nul ou non nul) Élément utilisé comme clic sur l'annonce. |
- Obsolète
- Fournissez plutôt un adUiElement au constructeur StreamManager.
- Renvoie
-
void
streamTimeForContentTime
streamTimeForContentTime(contentTime) renvoie un nombre
Indique l'heure de diffusion avec les annonces pour un temps de contenu donné. Renvoie l'heure du contenu donné pour les diffusions en direct.
Paramètre |
|
|---|---|
|
contentTime |
Total la durée du contenu sans aucune annonce (en secondes). |
- Renvoie
-
numberLe temps de diffusion qui correspond au temps de contenu donné une fois les annonces insérées.