Class: BreakStatus

  • BreakStatus class represents the current status of a media break during a Cast session.

  • It provides information about the break and break clip IDs, elapsed time, and when the break is skippable.

  • currentBreakClipTime and currentBreakTime values are updated sporadically and often outdated, thus getEstimatedBreakClipTime and getEstimatedBreakTime are recommended for accurate playback position.

Constructor

BreakStatus

new BreakStatus()

Properties

breakClipId

(string or undefined)

ID of the current break clip.

breakId

(string or undefined)

ID of the current break.

currentBreakClipTime

(number or undefined)

Time in seconds elapsed after the current break clip starts. This member is only updated sporadically, so its value is often out of date. Use the getEstimatedBreakClipTime method to get an estimate of the real playback position based on the last information reported by the receiver.

currentBreakTime

(number or undefined)

Time in seconds elapsed after the current break starts. This member is only updated sporadically, so its value is often out of date. Use the getEstimatedBreakTime method to get an estimate of the real playback position based on the last information reported by the receiver.

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 5 seconds. If this field is not defined, it means that the current break clip is not skippable.