Represents a break clip (for example, a clip of an ad during an ad break)
Constructor
BreakClip
new
BreakClip(id)
Parameter
id
string
The unique break clip ID.
Properties
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eBreakClip\u003c/code\u003e represents an individual ad or segment within an ad break during content playback on a Cast receiver.\u003c/p\u003e\n"],["\u003cp\u003eIt provides properties for managing metadata like URLs, duration, content type, and custom data associated with the ad.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBreakClip\u003c/code\u003e supports various ad formats including standard media, VAST ads, and HLS, allowing flexibility in ad delivery.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can specify when the break clip is skippable by the user, enhancing user experience during ad breaks.\u003c/p\u003e\n"]]],["The `BreakClip` class represents a media clip, like an ad, within a break. Key properties include: `id` (unique identifier), `contentId`/`contentUrl` (media source), `contentType` (MIME type), `duration` (clip length), `posterUrl` (display image), and `title` (display text). `clickThroughUrl` specifies a URL for sender UI interaction. `vastAdsRequest` handles ad requests if direct content isn't provided. `whenSkippable` defines the skip time. HLS segment format settings are available for HLS content.\n"],null,["# Class: BreakClip\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).BreakClip\n==================================================================================================================================================\n\nclass static\n\nRepresents a break clip (for example, 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 The unique break clip ID. |\n\nProperties\n----------\n\n### clickThroughUrl\n\n(string or undefined)\n\nThe URL of the page that the sender displays when the end user clicks\nthe link on the sender UI during playback of this clip on the receiver.\n\n### contentId\n\n(string or undefined)\n\nThe ID of the content currently playing on the receiver. Typically, this\nis the URL of the break media.\n\n### contentType\n\n(string or undefined)\n\nThe content MIME type.\n\n### contentUrl\n\n(string or undefined)\n\nThe optional break media URL, which allows the use of `contentId` in\nplace of the real ID. If `contentUrl` is provided, it is used as the\nmedia URL, otherwise the `contentId` is used as the media URL.\n\n### customData\n\n(non-null Object or undefined)\n\nThe application-specific break clip data.\n\n### duration\n\n(number or undefined)\n\nThe break clip duration, in seconds.\n\n### hlsSegmentFormat\n\n(non-null [cast.framework.messages.HlsSegmentFormat](/cast/docs/reference/web_receiver/cast.framework.messages#.HlsSegmentFormat) or undefined)\n\nThe format of the HLS media segment. Only required for HLS content\nplayback using MPL.\n\n### hlsVideoSegmentFormat\n\n(non-null [cast.framework.messages.HlsVideoSegmentFormat](/cast/docs/reference/web_receiver/cast.framework.messages#.HlsVideoSegmentFormat) or undefined)\n\nThe format of the HLS Video media segment. Only required for HLS content\nplayback using MPL.\n\n### id\n\nstring\n\nThe unique break clip ID.\n\n### posterUrl\n\n(string or undefined)\n\nThe URL of the content that the sender displays while the receiver is\nplaying this clip.\n\n### title\n\n(string or undefined)\n\nThe title of the break clip. Sender might display this on its screen, if\nprovided.\n\n### vastAdsRequest\n\n(non-null [cast.framework.messages.VastAdsRequest](/cast/docs/reference/web_receiver/cast.framework.messages.VastAdsRequest) or undefined)\n\nThe VAST ad request configuration.\nThis is used when neither `contentId` nor `contentUrl` are provided.\nTo avoid overflow, this field is not included in `MediaStatus` messages.\n\n### whenSkippable\n\n(number or undefined)\n\nThe time in seconds when this break clip becomes skippable. For example,\na value of `5` means that the user can skip this break clip after five\nseconds. If this field has a negative value or is `undefined`, this means\nthat the current break clip is not skippable."]]