Klasse: BreakManager

cast.framework.breaks.BreakManager

class   static

Kurs zum Verwalten von Pausen.

Methoden

addBreak

addBreak(breakData, breakClips, broadCastMediaStatus) gibt einen booleschen Wert zurück.

Fügt dynamische Pausen- und Pausenclips hinzu. Die Pausenclips werden der Unterbrechung zugeordnet (break.breakClipIds und cancel.duration werden entsprechend den Clips aktualisiert).

Parameter

breakData

cast.framework.messages.Break

Der Wert darf nicht null sein.

breakClips

Array von Nicht-Null cast.framework.messages.BreakClip

Der Wert darf nicht null sein.

broadCastMediaStatus

Optional

boolean

Legt fest, ob CAF prüfen soll, ob sich der aktuelle Status der Werbeunterbrechung geändert hat. Dies kann vor Beginn der Wiedergabe nicht wünschenswert sein, da der Empfänger möglicherweise noch weitere Pausen hinzufügen muss (z.B. während des vollständigen Ladevorgangs).
Rückgaben

boolean „true“, wenn die Werbeunterbrechung hinzugefügt wurde.

getBreakById

getBreakById(id) gibt cast.framework.messages.Break zurück.

Ruft die aktuelle Medienpause nach ID ab.

Parameter

id

String

ID der Unterbrechung.
Rückgaben

nullable cast.framework.messages.Break 

getBreakClipById

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

Ruft den aktuellen Mediapause-Clip nach ID ab.

Parameter

id

String

Clip-ID.
Rückgaben

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() gibt eine Zahl zurück

Gibt die aktuelle Zeit in Sekunden des aktuell wiedergegebenen Pausenclips zurück.

Rückgaben

nullable number Aktuelle Zeit in Sekunden innerhalb des aktuellen Pausenclips. Null, wenn der Player keinen Pausenclip wiedergibt.

getBreakClipDurationSec

getBreakClipDurationSec() gibt eine Zahl zurück

Gibt die Dauer des aktuell wiedergegebenen Pausenclips in Sekunden zurück.

Rückgaben

nullable number Dauer des aktuellen Pausenclips. Null, wenn der Player keinen Pausenclip wiedergibt.

getBreakClips

getBreakClips() gibt ein Array von Nicht-Null-Wert cast.framework.messages.BreakClip zurück.

Ruft die aktuellen Medienpausen-Clips ab.

Rückgaben

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

getBreaks

getBreaks() gibt ein Array von Nicht-Null-Werten cast.framework.messages.Break zurück.

Ruft die aktuellen Medienpausen ab.

Rückgaben

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

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) gibt cast.framework.breaks.CreativeInformation zurück.

Ruft die mit dem Breakclip verknüpften Creative-Informationen nach ID ab.

Parameter

breakClipId

String

Clip-ID.
Rückgaben

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() gibt einen booleschen Wert zurück.

Gibt „true“ zurück, wenn angesehene Pausen abgespielt werden sollen.

Rückgaben

boolean 

removeBreakById

removeBreakById(breakId) gibt einen booleschen Wert zurück

Entfernt eine Pause und die zugehörigen Pausenclips.

Parameter

breakId

String

Werbeunterbrechungs-ID
Rückgaben

boolean „true“, wenn die Werbeunterbrechung erfolgreich entfernt wurde.

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

Bietet einen Interceptor, mit dem der Entwickler weitere Pausenclips einfügen oder den aktuellen Unterbrechungsclip ändern kann, bevor eine Pause gestartet wird.

Wenn der Interceptor auf null gesetzt ist, wird der Interceptor auf den Standardwert zurückgesetzt. Standardmäßig die VAST-Abruf- und -Parsing-Logik im standardmäßigen Interceptor. Wenn also ein benutzerdefinierter Interceptor vom Entwickler festgelegt wird, wird die VAST-Logik überschrieben und Entwickler sollten ihre eigene VAST-Abruf- und Parsing-Logik im angegebenen Interceptor implementieren.

Parameter

Interceptor

function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext)

Der standardmäßige Interceptor für das Laden eines Pausenclips gibt denselben Unterbrechungsclip als Eingabe zurück.

Der Wert kann null sein.

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

Bietet einen Interceptor, mit dem Entwickler angeben können, welche Pausen nach einem Suchvorgang gespielt werden sollen.

Parameter

seekInterceptor

function(non-null cast.framework.breaks.BreakSeekData)

Interceptor oder null, wenn der Entwickler ihn auf den Standardwert zurücksetzen möchte. Der Standard-Interceptor für die Werbeunterbrechung gibt die nächste Unterbrechung vom Wert „seekTo“ zurück.

Der Wert kann null sein.

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

Legt ein Flag fest, um zu steuern, ob die beobachtete Stitching-Pause des Clients wiedergegeben werden soll.

Parameter

playWatchedBreak

boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

Stellt einen Interceptor bereit, mit dem die VAST-Tracking-URL geändert werden kann, bevor sie an den Server gesendet wird. Die Eingabe des Interceptors ist eine Zeichenfolge der Tracking-URL. Der Interceptor kann entweder einen modifizierten URL-String oder ein Promise mit einem geänderten URL-String zurückgeben. Der Interceptor kann auch null zurückgeben, wenn Sie die Tracking-URL mit Ihrem eigenen Code anstelle von CAF senden möchten.

Parameter

Interceptor

Funktion(String)

Interceptor, der die URL vor dem Senden ändert.

Der Wert kann null sein.