Constructor

BreakClip

new BreakClip(id)

Represents a break clip (e.g. a clip of an ad during an ad break).

Parameter

id

string

Unique ID of break clip.

Properties

clickThroughUrl

(string or undefined)

URL of the page that the sender will display, when the end user clicks the link on the sender UI, while the receiver is playing this clip.

contentId

(string or undefined)

The URL or content ID of the break media playing on the receiver.

contentType

(string or undefined)

The content MIME type.

contentUrl

(string or undefined)

Optional break media URL, to allow using contentId for the real ID. If contentUrl is provided, it will be used as the media URL, otherwise the contentId will be used as the media URL.

customData

(non-null Object or undefined)

Application-specific break clip data.

duration

(number or undefined)

Duration of a break clip in seconds.

hlsSegmentFormat

(non-null chrome.cast.media.HlsSegmentFormat or undefined)

The format of the HLS media segment.

id

string

Unique ID of break clip.

posterUrl

(string or undefined)

URL of content that the sender will display while the receiver is playing this clip.

title

(string or undefined)

Title of a break clip. Sender might display this on its screen, if provided.

vastAdsRequest

(non-null chrome.cast.media.VastAdsRequest or undefined)

VAST ad request configuration. Used if contentId or contentUrl is not provided.

whenSkippable

(number or undefined)

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