@theoplayer/extended 7.10.0 → 7.12.0

package/THEOplayer.common.d.ts

@@ -661,6 +661,10 @@ interface AdInit extends Omit<Partial<Ad>, 'integration' | 'adBreak'> {
      * The time offset at which content will be paused to play the ad, in seconds.
      */
     timeOffset?: number;
+    /**
+     * Additional integration-specific data associated with this ad.
+     */
+    customData?: unknown;
 }
 /**
  * An initializer for a custom {@link AdBreak}.
@@ -680,6 +684,10 @@ interface AdBreakInit {
      * The duration of the ad break, in seconds.
      */
     maxDuration?: number | undefined;
+    /**
+     * Additional integration-specific data associated with this ad break.
+     */
+    customData?: unknown;
 }
 /**
  * Factory to create an {@link ServerSideAdIntegrationHandler}.
@@ -810,6 +818,17 @@ interface Ad {
      * <br/> - Only supported for `'csai'`, `'theo'` (deprecated) and `'google-ima'`.
      */
     universalAdIds: UniversalAdId[];
+    /**
+     * Additional integration-specific data associated with this ad.
+     */
+    customData: unknown;
+    /**
+     * Whether the ad is a slate or not.
+     *
+     * @remarks
+     * </br> - Only used for THEOads ads.
+     */
+    isSlate: boolean;
 }
 /**
  * The type of the ad, represented by a value from the following list:
@@ -1166,6 +1185,10 @@ interface AdBreak {
      * <br/> - This feature is not available in the Google IMA integration and will default to -1.
      */
     maxRemainingDuration: number | undefined;
+    /**
+     * Additional integration-specific data associated with this ad.
+     */
+    customData: unknown;
 }
 /**
  * Represents a companion ad which is displayed near the video player.
@@ -12476,16 +12499,28 @@ interface TheoAdDescription extends AdDescription {
      * <br/> - Values added must be strings.
      */
     adTagParameters?: Record<string, string>;
+    /**
+     * Whether to use the Id3 based operating mode.
+     *
+     * @defaultValue `false`
+     *
+     * @remarks
+     * <br/> - Only applicable for specific use-cases.
+     * <br/> - Contact THEO Technologies for more information.
+     */
+    useId3?: boolean;
 }
 /**
  * Describes how and when the layout of a THEOads ad break should be overridden:
  *  - `'single'`: Override to play all ad breaks using the "single" layout mode.
+ *  - `'l-shape'`: Override to play all ad breaks using the "l-shape" layout mode.
+ *  - `'double'`: Override to play all ad breaks using the "double" layout mode.
  *  - `'single-if-mobile'`: When on a mobile device, override to play all ad breaks using the "single" layout mode.
  *
  * @category Ads
  * @internal
  */
-type TheoAdsLayoutOverride = 'single' | 'single-if-mobile';
+type TheoAdsLayoutOverride = 'single' | 'l-shape' | 'double' | 'single-if-mobile';
 
 /**
  * @category HESP