Classe: BreakManager

cast.framework.interruptions.BreakManager

class   statique

Cours pour gérer les pauses.

Méthodes

addBreak

addBreak(breakData, breakClips, broadCastMediaStatus) renvoie une valeur booléenne.

Permet d'ajouter des coupures publicitaires dynamiques. Les extraits "break.breakClipIds" et "break.duration" sont associés à la coupure publicitaire. Ils sont mis à jour en fonction des extraits.

Paramètres
breakData	cast.framework.messages.Break La valeur ne doit pas être nulle.
breakClips	Tableau de valeurs cast.framework.messages.BreakClip non nuls La valeur ne doit pas être nulle.
broadCastMediaStatus	Facultatif boolean Indique si CAF doit vérifier si l'état de coupure actuel a changé. Cette action n'est pas forcément souhaitable avant le début de la lecture, car le récepteur peut avoir besoin d'ajouter d'autres coupures (par exemple, pendant le chargement terminé).

Renvoie

boolean "True" si la coupure a bien été ajoutée.

getBreakById

getBreakById(id) renvoie cast.framework.messages.Break.

Récupère la coupure multimédia actuelle par ID.

Paramètres
id	chaîne ID de coupure.

Renvoie

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) returns cast.framework.messages.BreakClip

Récupère l'extrait de coupure multimédia actuel par ID.

Paramètres
id	chaîne ID de l'extrait

Renvoie

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() renvoie un nombre.

Renvoie l'heure actuelle, en secondes, dans l'extrait de coupure en cours de lecture.

Renvoie

nullable number Durée actuelle en secondes dans l'extrait de coupure actuel. Valeur nulle, si le lecteur ne lit pas l'extrait de coupure publicitaire.

getBreakClipDurationSec

getBreakClipDurationSec() renvoie un nombre.

Renvoie la durée en secondes de l'extrait de coupure en cours de lecture.

Renvoie

nullable number Durée de l'extrait actuel de coupure publicitaire. Valeur nulle, si le lecteur ne lit pas l'extrait de coupure publicitaire.

getBreakClips

getBreakClips() renvoie un tableau de valeurs non nulles cast.framework.messages.BreakClip.

Récupère les extraits de coupures multimédias en cours.

Renvoie

non-null Array of non-null cast.framework.messages.BreakClip 

getBreaks

getBreaks() renvoie un tableau de valeurs non nulles cast.framework.messages.Break.

Récupère les coupures multimédias en cours.

Renvoie

non-null Array of non-null cast.framework.messages.Break 

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) affiche cast.framework.breaks.CreativeInformation.

Récupère les informations de création associées à un extrait d'extrait par ID.

Paramètres
breakClipId	chaîne ID de l'extrait

Renvoie

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() renvoie une valeur booléenne

Renvoie la valeur "true" si les coupures regardées doivent être lues.

Renvoie

boolean 

removeBreakById

removeBreakById(breakId) renvoie une valeur booléenne

Supprime une coupure publicitaire et les extraits associés.

Paramètres
breakId	chaîne ID de coupure

Renvoie

boolean "True" si la coupure a bien été supprimée.

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

Fournit un intercepteur permettant au développeur d'insérer d'autres coupures ou de modifier l'extrait en cours avant le début d'une coupure.

Si l'intercepteur est nul, il réinitialisera l'intercepteur à la valeur par défaut. Par défaut, la logique d'extraction et d'analyse VAST est utilisée dans l'intercepteur par défaut. Ainsi, si un intercepteur personnalisé est défini par le développeur, la logique VAST sera ignorée, et les développeurs devront y implémenter leur propre logique d'extraction et d'analyse VAST.

Paramètres
intercepteur	function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) L'intercepteur de chargement de bornement par défaut renvoie le même clip de coupure que l'entrée. La valeur peut être nulle.

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

Fournit un intercepteur permettant au développeur de spécifier les coupures qu'il souhaite jouer après une recherche.

Paramètres
seekInterceptor	function(non-null cast.framework.breaks.BreakSeekData) Interceptor ou valeur nulle si le développeur souhaite rétablir la valeur par défaut. L'intercepteur de recherche de coupure par défaut renvoie le saut le plus proche de la valeur findTo. La valeur peut être nulle.

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

Définit un indicateur pour contrôler si la coupure d'assemblage du client surveillé doit être lue.

Paramètres
playWatchedBreak	boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

Fournit un intercepteur permettant de modifier l'URL de suivi VAST avant qu'elle ne soit envoyée 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 d'URL modifiée. L'intercepteur peut également renvoyer la valeur "null" si vous souhaitez envoyer l'URL de suivi via votre propre code plutôt que par CAF.

Paramètres
intercepteur	fonction(chaîne) Interception qui modifie l'URL avant son envoi. La valeur peut être nulle.