Class: BreakStatus

  • BreakStatus objects represent the status of a break in a media stream, including information about the current break clip and time elapsed.

  • Constructor parameters include currentBreakTime and currentBreakClipTime for initializing break status.

  • Key properties include breakClipId, breakId, currentBreakClipTime, currentBreakTime, seekBreak, and whenSkippable for detailed break information.

  • whenSkippable property determines when a break clip can be skipped by the user, if at all.

  • The seekBreak property reflects a dynamically generated break when a user seeks over a break in the content.

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.