Class: Break

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

Constructor

Break

new Break(id, breakClipIds, position)

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

A list of break clip IDs included in this break.

duration

(number or undefined)

The duration of a break in seconds.

id

string

The unique breal ID.

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 the color of a progress bar marker corresponding to this break once this field changes from false to true, indicating that the user has viewed the break.

position

number

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