Class: BreaksEvent

Stay organized with collections Save and categorize content based on your preferences.

Constructor

BreaksEvent

new BreaksEvent(type, currentMediaTime, index, total, whenSkippable, endedReason, breakClipId, breakId)

Parameter

type

cast.framework.events.EventType

Value must not be null.

currentMediaTime

Optional

number

index

Optional

number

Index of current break clip among all break clips that break includes.

total

Optional

number

Total number of break clip that break includes.

whenSkippable

Optional

number

When current break get skippable.

endedReason

Optional

cast.framework.events.EndedReason

The reason the break clip ended.

Value must not be null.

breakClipId

Optional

string

The break clip's id. Refer to cast.framework.messages.BreakClip.id

breakId

Optional

string

The break's id. Refer to cast.framework.messages.Break.id

Properties

breakClipId

constant

(string or undefined)

The break clip's ID. Refer to cast.framework.messages.BreakClip.id

breakId

constant

(string or undefined)

The break's id. Refer to cast.framework.messages.Break.id

currentMediaTime

constant

(number or undefined)

The time in the currently-playing media when the break event occurred. For the client-side stitched ads, this represents the media time of a break clip when the event occurred.

endedReason

constant

(non-null cast.framework.events.EndedReason or undefined)

The reason the break clip ended.

index

constant

(number or undefined)

Index of break clip, which starts from 1.

total

constant

(number or undefined)

Total number of break clips.

whenSkippable

constant

(number or undefined)

How long the current break clip must play before the viewer is permitted to skip (in seconds).