cast. framework. coupures. BreakManager
Classe permettant de gérer les coupures publicitaires.
Méthodes
getBreakById
getBreakById(id) renvoie cast.framework.messages.Break
Obtenir la coupure média actuelle par ID
Paramètre |
|
---|---|
id |
chaîne ID de coupure. |
- Retours
-
nullable cast.framework.messages.Break
getBreakClipById
getBreakClipById(id) renvoie cast.framework.messages.BreakClip
Obtenir l'extrait de coupure publicitaire actuel par ID.
Paramètre |
|
---|---|
id |
chaîne ID de l'extrait. |
- Retours
-
nullable cast.framework.messages.BreakClip
getBreakClipCurrentTimeSec
La fonction getBreakClipCurrentTimeSec() renvoie le numéro
Renvoie l'heure actuelle en secondes dans l'extrait de coupure en cours de lecture.
- Retours
-
nullable number
Durée actuelle, en secondes, de l'extrait de l'extrait actuel. Nul, si le lecteur ne lit pas d'extrait vidéo.
getBreakClipDurationSec
La méthode getBreakClipDurationSec() renvoie le numéro
Renvoie la durée en secondes d'un extrait de coupure publicitaire en cours de lecture.
- Retours
-
nullable number
Durée de la coupure actuelle. Nul, si le lecteur ne lit pas de clip de pause.
getBreakClips
getBreakClips() renvoie un tableau de valeurs cast.framework.messages.BreakClip non nulles.
Obtenir les extraits multimédias actuels
- Retours
-
non-null Array of non-null cast.framework.messages.BreakClip
getBreaks
getBreaks() renvoie un tableau de valeurs cast.framework.messages.Break non nulles
Obtenir les coupures multimédias actuelles
- Retours
-
non-null Array of non-null cast.framework.messages.Break
getPlayWatchedBreak
La méthode getPlayWatchedBreak() renvoie une valeur booléenne
Renvoie la valeur "true" si les coupures de visionnage doivent être lues.
- Retours
-
boolean
setBreakClipLoadInterceptor
setBreakClipLoadInterceptor(intercepteur)
Fournissez un intercepteur pour permettre au développeur d'insérer d'autres extraits de coupure ou de modifier l'extrait de coupure actuel avant le début d'une coupure.
Si l'intercepteur est nul, la valeur par défaut est rétablie. Par défaut, la logique d'extraction et d'analyse VAST est interceptée par défaut. Par conséquent, si l'intercepteur personnalisé est défini par le développeur, la logique VAST sera remplacée, et les développeurs devront implémenter leur propre logique de récupération et d'analyse VAST dans l'intercepteur fourni.
Paramètre |
|
---|---|
intercepteur |
function(non nulle cast.framework.messages.BreakClip, facultatif non nulle cast.framework.breaks.BreakClipLoadInterceptorContext) L'intercepteur de chargement des extraits par défaut renvoie le même extrait que celui de l'entrée. La valeur peut être nulle. |
setBreakSeekInterceptor
setBreakSeekInterceptor(seekInterceptor)
Fournissez un intercepteur pour que le développeur spécifie les coupures qu'il veut jouer après la recherche.
Paramètre |
|
---|---|
Intercepteur de recherche |
function(non nulle cast.framework.breaks.BreakSeekData) Intercepteur ou valeur "null" si le développeur souhaite rétablir la valeur par défaut. L'intercepteur de recherche de coupure par défaut renvoie la coupure la plus proche de la valeur "SeeTo". La valeur peut être nulle. |
setPlayWatchedBreak
setPlayWatchedBreak(playWatchedBreak)
Définissez un indicateur pour contrôler si la coupure de jonction client surveillée doit être lue.
Paramètre |
|
---|---|
playWatchedBreak |
booléen |
setVastTrackingInterceptor
setVastTrackingInterceptor(intercepteur)
Fournissez un intercepteur pour modifier l'URL de suivi VAST avant de l'envoyer au serveur. L'entrée de l'intercepteur est une chaîne de l'URL de suivi. L'intercepteur peut renvoyer une chaîne d'URL modifiée ou une promesse de chaîne d'URL modifiée. L'intercepteur peut également renvoyer la valeur "null" si vous souhaitez envoyer l'URL de suivi avec votre propre code plutôt qu'avec CAF.
Paramètre |
|
---|---|
intercepteur |
fonction(chaîne) Interception qui modifie l'URL avant de l'envoyer. La valeur peut être nulle. |