Classe StreamManager

Gère les flux d'insertion dynamique d'annonces. Cette classe gère les interactions avec les serveurs DAI, gère les pings de suivi et émet des événements de flux et d'annonces.
Constructeurs
constructor
Méthodes
addEventListener
Ajoute un écouteur pour le type d'événement donné.
contentTimeForStreamTime
Renvoie la durée du contenu sans annonces pour une durée de flux donnée.
focus
Sélectionne le bouton "Ignorer", s'il est présent.
getAdSkippableState
Renvoie une valeur true si l'utilisateur peut ignorer l'annonce en cours.
loadStreamMetadata
Demande au SDK DAI de charger les métadonnées des annonces et émet un événement de flux LOADED.
onTimedMetadata
Transmet un dictionnaire de métadonnées traitées.
previousCuePointForStreamTime
Renvoie le point de repère précédent pour le code temporel du flux donné.
processMetadata
Traite les métadonnées temporelles pour les flux.
removeEventListener
Supprime un écouteur pour le type d'événement StreamEvent donné.
replaceAdTagParameters
Remplace tous les paramètres de tag d'emplacement publicitaire utilisés dans les demandes d'annonces à valider pour un flux en direct.
requestStream
Demande le chargement d'un flux pour IMA DAI à l'aide des paramètres de flux fournis.
reset
Réinitialise le gestionnaire de flux et supprime toute interrogation continue.
streamTimeForContentTime
Renvoie la durée totale du flux avec les annonces pour une durée de contenu donnée.

Constructeurs

constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
Paramètres
videoElement: HTMLVideoElement Élément vidéo HTML dans lequel la lecture a lieu.
Optional adUiElement: HTMLElement Élément dans lequel l'UI de l'annonce s'affiche.
Optional uiSettings: UiSettings Paramètres d'interface utilisateur à utiliser pour ce flux.
Renvoie
StreamManager

Méthodes

addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Ajoute un écouteur pour le type d'événement donné.
Paramètres
type: Type | Type[] Type d'événement d'annonce ou tableau de types d'événements.
listener: ((event: StreamEvent) => void) Fonction de rappel pour l'écouteur d'annonces.

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
Renvoie la durée du contenu sans annonces pour une durée de flux donnée. Renvoie le temps de diffusion donné pour les diffusions en direct.
Paramètres
streamTime: number le temps de visionnage en secondes, combinant le contenu et les annonces.
Renvoie
number Durée du contenu pour le code temporel du flux donné, sans les annonces.

focus

focus(): void
Sélectionne le bouton "Ignorer", s'il est présent. Si elle n'est pas présente, le focus est remis sur l'élément interactif.

getAdSkippableState

getAdSkippableState(): boolean
Renvoie une valeur true si l'utilisateur peut ignorer l'annonce en cours. Lorsque cette valeur change, la classe StreamManager émet un événement de flux SKIPPABLE_STATE_CHANGED.
Renvoie
boolean true si l'utilisateur peut ignorer l'annonce en cours, false dans le cas contraire.

loadStreamMetadata

loadStreamMetadata(): void
Demande au SDK DAI de charger les métadonnées des annonces et émet un événement de flux LOADED. Appelez manuellement cette méthode lorsque vous récupérez le fichier manifeste du flux à partir de votre assembleur vidéo tiers. Cette méthode ne concerne que la diffusion de flux VOD dans des pods avec un assembleur vidéo tiers.

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
Transmet un dictionnaire de métadonnées traitées. Le dictionnaire attend la clé exacte "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 la méthode StreamManager.processMetadata.
Paramètres
metadata: {
  [key: string]: string;
} 		Dictionnaire de métadonnées.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
Renvoie le point de repère précédent pour le code temporel du flux donné. Si aucun repère précédent n'existe, renvoie null. Utilisez cette méthode pour implémenter des fonctionnalités telles que le retour en arrière en l'appelant lorsque l'utilisateur souhaite revenir à une coupure publicitaire.
Paramètres
streamTime: number le moment du flux auquel l'utilisateur souhaite accéder.
Renvoie
CuePoint le point de repère précédent pour le code temporel donné.

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Traite les métadonnées temporelles pour les flux. Utilisez cette méthode si votre lecteur vidéo fournit des métadonnées non analysées avec des codes temporels. Sinon, appelez StreamManager.onTimedMetadata.
Paramètres
type: string Type de métadonnées. Doit être la chaîne 'ID3' pour HLS ou l'URI de l'ID de schéma du message d'événement pour DASH.
data: string | Uint8Array Données brutes du tag. Pour ID3, il doit s'agir de l'intégralité 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: number Heure (en secondes) à laquelle les données doivent être traitées. Pour DASH, ce paramètre correspond à l'heure de début du message d'événement.

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Supprime un écouteur pour le type d'événement StreamEvent donné. Pour supprimer un écouteur, le paramètre d'écouteur que vous transmettez à cette méthode doit être égal par référence à celui précédemment transmis à la méthode addEventListener.
Paramètres
type: Type Type d'événement pour lequel supprimer l'écouteur.
listener: ((event: StreamEvent) => void) Fonction à supprimer en tant qu'écouteur.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
Remplace l'ensemble des paramètres de tag d'emplacement publicitaire utilisés dans les demandes d'annonces à valider pour un flux en direct.
Paramètres
adTagParameters: {
  [key: string]: string;
} 		Paramètres de tag d'emplacement publicitaire de remplacement. Les valeurs doivent être des chaînes.

requestStream

requestStream(streamRequest: StreamRequest): void
Demande le chargement d'un flux pour IMA DAI à l'aide des paramètres de flux fournis.
Paramètres
streamRequest: StreamRequest contient les paramètres permettant de charger les métadonnées du flux.

reset

reset(): void
Réinitialise le gestionnaire de flux et supprime toute interrogation continue.

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
Renvoie la durée totale du flux avec les annonces pour une durée de contenu donnée. Renvoie l'heure de contenu donnée pour les diffusions en direct.
Paramètres
contentTime: number Durée du contenu sans publicité, en secondes.
Renvoie
number Temps de diffusion total correspondant au temps de contenu donné après l'insertion d'annonces par l'insertion dynamique d'annonces.