react-native-theoplayer/src/api/ads/AdsAPI.ts

A THEOplayer video component for react-native.

import type { AdDescription } from "../source/ads/Ads";
import type { AdBreak } from "./AdBreak";
import type { Ad } from "./Ad";
import type { GoogleDAI } from "./GoogleDai";
import { Omid } from './Omid';

/**
 * The API for advertisements.
 *
 * @category Ads
 * @public
 */
export interface AdsAPI {
  /**
   * Whether a linear ad is currently playing.
   */
  playing(): Promise<boolean>;

  /**
   * Skip the current linear ad.
   *
   * @remarks
   * <br/> - This will have no effect when the current linear ad is (not yet) skippable.
   */
  skip(): void;

  /**
   * The currently playing ad break.
   */
  currentAdBreak(): Promise<AdBreak>;

  /**
   * List of currently playing ads.
   */
  currentAds(): Promise<Ad[]>;

  /**
   * List of ad breaks which still need to be played.
   */
  scheduledAdBreaks(): Promise<AdBreak[]>;

  /**
   * Add an ad break request.
   *
   * @remarks
   * <br/> - Prefer scheduling ad breaks up front through SourceConfiguration.ads.
   */
  schedule(ad: AdDescription): void;

  /**
   * The Google DAI API.
   *
   * @remarks
   * <br/> - Only available when the feature or extension `'google-dai'` is enabled.
   */
  readonly dai?: GoogleDAI;

  /**
   * The Omid API, which can be used to add as well as remove friendly video controls overlay obstructions.
   *
   * @since React Native THEOplayer SDK v8.7.0.
   */
  readonly omid?: Omid;
}