@theoplayer/extended 8.1.1 → 8.2.0

package/THEOplayer.common.d.ts

@@ -712,6 +712,27 @@ interface AdsManagerLoadedEvent extends Event<'adsmanagerloaded'> {
     readonly adsManager: any;
 }
 
+/**
+ * The THEOads API.
+ *
+ * @remarks
+ * <br/> - Available since v8.2.0.
+ *
+ * @category Ads
+ * @public
+ */
+interface TheoAds {
+    /**
+     * Replaces all the ad tag parameters used for upcoming ad requests for a live stream.
+     *
+     * @param adTagParameters - The new ad tag parameters.
+     *
+     * @remark
+     * <br/> - If set, this value overrides any parameters set on the {@link TheoAdDescription.adTagParameters}.
+     */
+    replaceAdTagParameters(adTagParameters?: Record<string, string>): void;
+}
+
 /**
  * Represents a VAST creative. It is either a linear or non-linear ad.
  *
@@ -923,6 +944,16 @@ interface AdsConfiguration {
      * The Google IMA configuration.
      */
     googleIma?: GoogleImaConfiguration;
+    /**
+     * Whether to enable THEOads support.
+     *
+     * @remarks
+     * <br/> - Available since 8.2.0.
+     * <br/> - This must be set to `true` in order to schedule a {@link TheoAdDescription}.
+     *
+     * @defaultValue `false`
+     */
+    theoads?: boolean;
 }
 /**
  * Describes the configuration of Google IMA.
@@ -1453,6 +1484,13 @@ interface Ads extends EventDispatcher<AdsEventMap> {
      * <br/> - Only available with the feature `'google-dai'`.
      */
     readonly dai?: GoogleDAI;
+    /**
+     * The THEOads API.
+     *
+     * @remarks
+     * <br/> - Only available with the feature `'theoads'`.
+     */
+    readonly theoads?: TheoAds;
     /**
      * Add an ad break request.
      *
@@ -12141,6 +12179,7 @@ interface TTMLCue extends TextTrackCue {
  *
  * @remarks
  * <br/> - For THEOads, one configured ad break request enables server guided ad playback for the entire stream.
+ * <br/> - The player must have {@link AdsConfiguration.theoads} enabled in its {@link PlayerConfiguration}.
  *
  * @category Ads
  */