Constructor

Break

new Break(id, breakClipIds, position)

Represents a break (e.g. ad break) included in the main video.

Parameter

id

string

Unique ID of a break.

breakClipIds

Array of string

List of break clip IDs included in this break.

Value must not be null.

position

number

Position of this break inside the main video.

Properties

breakClipIds

non-null Array of string

List of break clip IDs included in this break.

duration

(number or undefined)

Duration of break in seconds.

id

string

Unique ID of a break.

isEmbedded

(boolean or undefined)

Indicates whether the break is embedded in the main stream.

isWatched

boolean

Whether a break was watched. This is marked as true when the break begins to play. A sender can change color of a progress bar marker corresponding to this break once this field changes from false to true denoting that the end-user already watched this break.

position

number

Location of the break inside the main video. -1 represents the end of the main video in seconds.