🤖 Merge PR DefinitelyTyped#73516 [Chromecast-CAF-Receiver] Adding dynamic ad break types by @JStaplesREDspace

Author: JStaplesREDspace

types/chromecast-caf-receiver/cast.framework.breaks.d.ts

@@ -43,6 +43,18 @@ export class BreakClipLoadInterceptorContext {
  * @see https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.breaks.BreakManager
  */
 export interface BreakManager {
+    /**
+     * Adds dynamic break and break clips. The break clips will be associated with the break
+     * ({@link Break.breakClipIds} and {@link Break.duration} will be updated according to the clips).
+     * @param breakData The {@link Break} object to be added.
+     * @param breakClips Array of non-null {@link BreakClip} objects.
+     * @param broadCastMediaStatus Whether CAF should check if the current break status has changed.
+     *     This may not be desirable before playback begins, as the receiver may still need to add
+     *     more breaks (e.g., during load complete).
+     * @returns `true` if break was added successfully.
+     */
+    addBreak(breakData: Break, breakClips: BreakClip[], broadCastMediaStatus?: boolean): boolean;
+
     /**
      * Get current media break by id.
      */
@@ -74,6 +86,12 @@ export interface BreakManager {
     /** Returns true if watched breaks should be played. */
     getPlayWatchedBreak(): boolean;
 
+    /**
+     * Removes a break and associated break clips.
+     * @returns `true` if break was removed successfully.
+     */
+    removeBreakById(breakId: string): boolean;
+
     /**
      * Provide an interceptor to allow developer to insert more break clips or
      * modify current break clip before a break is started.

types/chromecast-caf-receiver/cast.framework.messages.d.ts

@@ -2556,6 +2556,12 @@ export class Break {
      * Duration of break in sec.
      */
     duration?: number | undefined;
+    /**
+     * Indicates whether the break is expanded on the timeline. The duration of expanded
+     *  breaks is included in the total playback duration. A value of `true` indicates
+     *  that the break is expanded. When omitted, the value is assumed to be `false`.
+     */
+    expanded?: boolean;
     /**
      * Unique id of break.
      */

types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts

@@ -60,13 +60,15 @@ const items = qBase.fetchItems(1, 3, 4);
 const breakSeekData = new cast.framework.breaks.BreakSeekData(0, 100, []);
 const breakClipLoadContext = new cast.framework.breaks.BreakClipLoadInterceptorContext(adBreak);
 const breakManager: BreakManager = {
+    addBreak: () => true,
     getBreakById: () => adBreak,
     getBreakClipCurrentTimeSec: () => null,
     getBreakClipDurationSec: () => null,
     getBreakClipById: () => breakClip,
     getBreakClips: () => [breakClip],
     getBreaks: () => [adBreak],
     getPlayWatchedBreak: () => true,
+    removeBreakById: () => true,
     setBreakClipLoadInterceptor: () => {},
     setBreakSeekInterceptor: () => {},
     setPlayWatchedBreak: () => {},