Constructor

BreakClip

new BreakClip(id)

Parameter

id

string

Unique id of break clip.

Properties

clickThroughUrl

(string or undefined)

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

contentId

(string or undefined)

Typically the url 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 real id. If contentUrl is provided, it will be used as 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 break clip in sec.

hlsSegmentFormat

(non-null cast.framework.messages.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 sender will display while receiver is playing this clip.

title

(string or undefined)

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

whenSkippable

The time in sec 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, it means that current break clip is not skippable.