Class: BreakStatus

  • BreakStatus represents the status of a break, including time elapsed for the current break and break clip.

  • The constructor for BreakStatus takes the current break time and current break clip time as parameters.

  • BreakStatus has properties such as breakClipId, breakId, currentBreakClipTime, currentBreakTime, seekBreak, and whenSkippable.

  • The whenSkippable property indicates the time in seconds after which a break clip can be skipped.

cast.framework.messages.BreakStatus

class   static

Represents the status of a break.

Constructor

BreakStatus

new BreakStatus(currentBreakTime, currentBreakClipTime)

Parameter

currentBreakTime

(number or undefined)

Time in seconds elapsed after the current break starts.

currentBreakClipTime

(number or undefined)

Time in seconds elapsed after the current break clip starts.

Properties

breakClipId

(string or undefined)

The ID of the current break clip.

breakId

(string or undefined)

The ID of the current break.

currentBreakClipTime

(number or undefined)

The time elapsed after the current break clip started, in seconds.

currentBreakTime

(number or undefined)

The time elapsed after the current break started, in seconds.

seekBreak

(non-null cast.framework.messages.Break or undefined)

A dynamically-generated break as a result of a user seeking over a break.

whenSkippable

(number or undefined)

The time in seconds when this break clip becomes skippable. 5 means that the end user can skip this break clip after five seconds. If this field is not defined, it means that the current break clip is not skippable.