Klasse: BreakManager

cast.framework.Umbruch.BreakManager

class   statisch

Klasse zum Verwalten von Pausen.

Methoden

addBreak (Hinzufügen)

addBreak(breakData, breakClips, breiterCastMediaStatus) gibt booleschen Wert zurück

Fügt dynamische Pausen- und Pausenclips hinzu. Die Pausenclips werden der Pause zugeordnet (break.breakClipIds undbreak.duration werden entsprechend aktualisiert).

Parameter

Daten teilen

cast.framework.messages.Break (Pause)

Der Wert darf nicht null sein.

Pausenclips

Array von cast.framework.messages.BreakClip, das nicht null ist

Der Wert darf nicht null sein.

BreiterCast-Medienstatus

Optional

boolean

Gibt an, ob CAF prüfen soll, ob sich der aktuelle Unterbrechungsstatus geändert hat. Dies ist möglicherweise nicht wünschenswert, bevor die Wiedergabe beginnt, da der Empfänger möglicherweise noch weitere Pausen hinzufügen muss (z.B. während des Ladevorgangs).
Rückgaben

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

GetBreakById (GetBreakById)

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

Ruft die aktuelle Medienpause nach ID ab

Parameter

id

String

ID der Pause
Rückgaben

nullable cast.framework.messages.Break 

GetBreakClipById

getBreakClipById(id) gibt cast.framework.messages.BreakClip zurück.

Ruft den aktuellen Clip für die Werbeunterbrechung nach ID ab

Parameter

id

String

Clip-ID
Rückgaben

nullable cast.framework.messages.BreakClip 

GetBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() gibt

Gibt die aktuelle Zeit in Sekunden im aktuell wiedergegebenen Clip zurück.

Rückgaben

nullable number Aktuelle Zeit in Sekunden im aktuellen Break-Clip. Null, wenn der Player keinen Break-Clip abspielt.

GetBreakClipDauer (Sek.)

getBreakClipDurationSec() gibt num zurück

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

Rückgaben

nullable number Dauer des aktuellen Pausenclips. Null, wenn der Player keinen Break-Clip abspielt.

Clips abrufen

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

Ruft aktuelle Clips für eine Werbeunterbrechung ab.

Rückgaben

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

Pausen

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

Ruft die aktuellen Medienunterbrechungen ab

Rückgaben

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

CreativeCreativeByClipId

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

Ruft die Creative-Informationen ab, die mit der Pausenclip-ID verknüpft sind.

Parameter

Pausenclip-ID

String

Clip-ID
Rückgaben

nullable cast.framework.breaks.CreativeInformation 

GetPlayWatchedBreak

getPlayWatchedBreak() gibt booleschen Wert zurück

Gibt „true“ zurück, wenn angesehene Werbeunterbrechungen wiedergegeben werden sollen.

Rückgaben

boolean 

removeBreakById entfernen

removeBreakById(breakId) gibt einen booleschen Wert zurück.

Entfernt eine Pause und die zugehörigen Pausenclips.

Parameter

Pausen-ID

String

ID der Pause
Rückgaben

boolean: „true“, wenn die Unterbrechung entfernt wurde.

SetBreakClipLoadInterceptor

setBreakClipLoadInterceptor(Abfanggerät)

Bietet ein Abfangen, damit der Entwickler mehr Pausenclips einfügen oder aktuelle Break-Clips ändern kann, bevor eine Pause gestartet wird.

Wenn der Abfangen null ist, wird der Abfanger auf den Standardwert zurückgesetzt. Standardmäßig ist die VAST-Abruf- und -Parsing-Logik im Standard-Abfanger. Wenn der Entwickler also ein angepasstes Abfangen festgelegt hat, wird die VAST-Logik überschrieben und Entwickler sollten ihre eigene VAST-Abruf- und Parsing-Logik im bereitgestellten abfangen.

Parameter

Abfangen

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

Der standardmäßige Break-Clip-Loader-Abfanger gibt denselben Break-Clip wie die Eingabe zurück.

Der Wert kann null sein.

setBreakSeek (Interceptor)

setBreakSeekInterceptor(seekInterceptor)

Mit diesem Tool können Entwickler abfangen, welche Pausen nach der Suche abgespielt werden sollen.

Parameter

Suchinterceptor

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

Interceptor oder null, wenn der Entwickler es auf die Standardeinstellung zurücksetzen möchte. Der standardmäßige Startbefehl für die Werbeunterbrechung gibt den nächstgelegenen Umbruch vom Wert für "seeTo" zurück.

Der Wert kann null sein.

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

Legt ein Flag fest, um zu steuern, ob die beobachtete Client-Stitching-Pause abgespielt werden soll.

Parameter

PlayWatchedBreak

boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(Abfanggerät)

Über diese Option wird ein Abfangtool bereitgestellt, mit dem die VAST-Tracking-URL geändert werden kann, bevor sie an den Server gesendet wird. Die Eingabe des Abfangens ist ein String der Tracking-URL. Der Abfangen kann entweder einen geänderten URL-String oder ein Promise eines geänderten URL-Strings zurückgeben. Der Abfangen kann auch Null zurückgeben, wenn Sie die Tracking-URL von Ihrem eigenen Code und nicht über CAF senden möchten.

Parameter

Abfangen

Funktion(String)

Ein Abfanggerät, das die URL vor dem Senden ändert.

Der Wert kann null sein.