BreakClip

new BreakClip(id)

clickThroughUrl

(string or undefined)

The URL of the page that the sender displays when the end user clicks the link on the sender UI during playback of this clip on the receiver.

contentId

(string or undefined)

The ID of the content currently playing on the receiver. Typically, this is the URL of the break media.

contentType

(string or undefined)

The content MIME type.

contentUrl

(string or undefined)

The optional break media URL, which allows the use of contentId in place of the real ID. If contentUrl is provided, it is used as the media URL, otherwise the contentId is used as the media URL.

customData

(non-null Object or undefined)

The application-specific break clip data.

duration

(number or undefined)

The break clip duration, in seconds.

hlsSegmentFormat

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

The format of the HLS media segment. Only required for HLS content playback using MPL.

hlsVideoSegmentFormat

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

The format of the HLS Video media segment. Only required for HLS content playback using MPL.

id

string

The unique break clip ID.

posterUrl

(string or undefined)

The URL of the content that the sender displays while the receiver is playing this clip.

title

(string or undefined)

The title of the break clip. Sender might display this on its screen, if provided.

vastAdsRequest

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

The VAST ad request configuration. This is used when neither contentId nor contentUrl are provided. To avoid overflow, this field is not included in MediaStatus messages.

whenSkippable

(number or undefined)

The time in seconds when this break clip becomes skippable. For example, a value of 5 means that the user can skip this break clip after five seconds. If this field has a negative value or is undefined, this means that the current break clip is not skippable.