Represents a break clip (e.g. a clip of an ad during an ad break).
Constructor
BreakClip
new
BreakClip(id)
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.
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.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003echrome.cast.media.BreakClip\u003c/code\u003e represents an ad or break within media content, like an advertisement during a show.\u003c/p\u003e\n"],["\u003cp\u003eIt has properties like \u003ccode\u003econtentId\u003c/code\u003e, \u003ccode\u003econtentUrl\u003c/code\u003e, \u003ccode\u003eduration\u003c/code\u003e, and \u003ccode\u003ewhenSkippable\u003c/code\u003e to define the break's media and behavior.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eBreakClip\u003c/code\u003e can have a click-through URL (\u003ccode\u003eclickThroughUrl\u003c/code\u003e) and a poster to display (\u003ccode\u003eposterUrl\u003c/code\u003e) during playback.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use custom data (\u003ccode\u003ecustomData\u003c/code\u003e) for application-specific needs and define when the break is skippable (\u003ccode\u003ewhenSkippable\u003c/code\u003e).\u003c/p\u003e\n"]]],["The `BreakClip` class represents a media clip within an ad break. Key properties include: `id` (unique identifier), `contentId`/`contentUrl` (media source), `contentType` (MIME type), `duration` (clip length), and `title`. `clickThroughUrl` and `posterUrl` define display elements for the sender's UI. `customData` allows application-specific data. `vastAdsRequest` is used for VAST ads, and `whenSkippable` defines the clip's skippability time. `hlsSegmentFormat` specifies the HLS media segment format.\n"],null,["# Class: BreakClip\n\nchrome.[cast](/cast/docs/reference/web_sender/chrome.cast).[media](/cast/docs/reference/web_sender/chrome.cast.media).BreakClip\n===============================================================================================================================\n\nclass static\n\nRepresents a break clip (e.g. a clip of an ad during an ad break).\n\nConstructor\n-----------\n\n### BreakClip\n\nnew\nBreakClip(id)\n\n| #### Parameter ||\n|----|---------------------------------|\n| id | string Unique ID of break clip. |\n\nProperties\n----------\n\n### clickThroughUrl\n\n(string or undefined)\n\nURL of the page that the sender will display, when the end user clicks\nthe link on the sender UI, while the receiver is playing this clip.\n\n### contentId\n\n(string or undefined)\n\nThe URL or content ID of the break media playing on the receiver.\n\n### contentType\n\n(string or undefined)\n\nThe content MIME type.\n\n### contentUrl\n\n(string or undefined)\n\nOptional break media URL, to allow using contentId for the real ID.\nIf contentUrl is provided, it will be used as the media URL, otherwise\nthe contentId will be used as the media URL.\n\n### customData\n\n(non-null Object or undefined)\n\nApplication-specific break clip data.\n\n### duration\n\n(number or undefined)\n\nDuration of a break clip in seconds.\n\n### hlsSegmentFormat\n\n(non-null [chrome.cast.media.HlsSegmentFormat](/cast/docs/reference/web_sender/chrome.cast.media#.HlsSegmentFormat) or undefined)\n\nThe format of the HLS media segment.\n\n### id\n\nstring\n\nUnique ID of break clip.\n\n### posterUrl\n\n(string or undefined)\n\nURL of content that the sender will display while the receiver is playing\nthis clip.\n\n### title\n\n(string or undefined)\n\nTitle of a break clip. Sender might display this on its screen, if\nprovided.\n\n### vastAdsRequest\n\n(non-null [chrome.cast.media.VastAdsRequest](/cast/docs/reference/web_sender/chrome.cast.media.VastAdsRequest) or undefined)\n\nVAST ad request configuration.\nUsed if contentId or contentUrl is not provided.\n\n### whenSkippable\n\n(number or undefined)\n\nThe time in seconds when this break clip becomes skippable. 5 means that\nend user can skip this break clip after 5 seconds. If this field is not\ndefined or is a negative value, it means that current break clip is not\nskippable."]]