A dynamically-generated break as a result of a user seeking over a break.
whenSkippable
(number or undefined)
The time in seconds when this break clip becomes skippable. 5 means
that the end user can skip this break clip after five seconds. If this
field is not defined, it means that the current break clip is not
skippable.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eBreakStatus\u003c/code\u003e objects represent the status of a break in a media stream, including information about the current break clip and time elapsed.\u003c/p\u003e\n"],["\u003cp\u003eConstructor parameters include \u003ccode\u003ecurrentBreakTime\u003c/code\u003e and \u003ccode\u003ecurrentBreakClipTime\u003c/code\u003e for initializing break status.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include \u003ccode\u003ebreakClipId\u003c/code\u003e, \u003ccode\u003ebreakId\u003c/code\u003e, \u003ccode\u003ecurrentBreakClipTime\u003c/code\u003e, \u003ccode\u003ecurrentBreakTime\u003c/code\u003e, \u003ccode\u003eseekBreak\u003c/code\u003e, and \u003ccode\u003ewhenSkippable\u003c/code\u003e for detailed break information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ewhenSkippable\u003c/code\u003e property determines when a break clip can be skipped by the user, if at all.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eseekBreak\u003c/code\u003e property reflects a dynamically generated break when a user seeks over a break in the content.\u003c/p\u003e\n"]]],["`BreakStatus` details the state of a media break, indicating the time elapsed within the current break (`currentBreakTime`) and within the current break clip (`currentBreakClipTime`). It includes the IDs of the current break (`breakId`) and break clip (`breakClipId`). `whenSkippable` shows when a break clip can be skipped, while `seekBreak` represents a break dynamically created from a seek. This class is a constructor accepting `currentBreakTime` and `currentBreakClipTime`.\n"],null,["# Class: BreakStatus\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).BreakStatus\n====================================================================================================================================================\n\nclass static\n\nRepresents the status of a break.\n\nConstructor\n-----------\n\n### BreakStatus\n\nnew\nBreakStatus(currentBreakTime, currentBreakClipTime)\n\n| #### Parameter ||\n|----------------------|------------------------------------------------------------------------------------|\n| currentBreakTime | (number or undefined) Time in seconds elapsed after the current break starts. |\n| currentBreakClipTime | (number or undefined) Time in seconds elapsed after the current break clip starts. |\n\nProperties\n----------\n\n### breakClipId\n\n(string or undefined)\n\nThe ID of the current break clip.\n\n### breakId\n\n(string or undefined)\n\nThe ID of the current break.\n\n### currentBreakClipTime\n\n(number or undefined)\n\nThe time elapsed after the current break clip started, in seconds.\n\n### currentBreakTime\n\n(number or undefined)\n\nThe time elapsed after the current break started, in seconds.\n\n### seekBreak\n\n(non-null [cast.framework.messages.Break](/cast/docs/reference/web_receiver/cast.framework.messages.Break) or undefined)\n\nA dynamically-generated break as a result of a user seeking over a break.\n\n### whenSkippable\n\n(number or undefined)\n\nThe time in seconds when this break clip becomes skippable. `5` means\nthat the end user can skip this break clip after five seconds. If this\nfield is not defined, it means that the current break clip is not\nskippable."]]