react-native-theoplayer 1.6.1 → 1.7.1

package/src/api/source/SourceDescription.ts

@@ -10,6 +10,7 @@ import type { DashPlaybackConfiguration } from './dash/DashPlaybackConfiguration
 import type { DRMConfiguration } from './drm/DRMConfiguration';
 import type { HlsPlaybackConfiguration } from './hls/HlsPlaybackConfiguration';
 import type { AdDescription } from './ads/Ads';
+import type { ServerSideAdInsertionConfiguration } from "./ads/ssai/ServerSideAdInsertionConfiguration";
 
 export type Source = TypedSource;
 
@@ -289,4 +290,12 @@ export interface TypedSource extends BaseSource {
    * <br/> - Available since v2.15.0.
    */
   contentProtection?: DRMConfiguration;
+
+  /**
+   * The Server-side Ad Insertion parameters for the media resource.
+   *
+   * @remarks
+   * <br/> - Available since v2.12.0.
+   */
+  ssai?: ServerSideAdInsertionConfiguration;
 }

package/src/api/source/ads/FreeWheelAdDescription.ts

@@ -0,0 +1,97 @@
+import type { AdDescription } from "./Ads";
+
+/**
+ * The possible ad unit types, represented by a value from the following list:
+ * <br/> - `'preroll'`: The linear ad will play before the content started.
+ * <br/> - `'midroll'`: The linear ad will play at a time offset during the content.
+ * <br/> - `'postroll'`: The linear ad will play after the content ended.
+ * <br/> - `'overlay'`: The non-linear ad.
+ *
+ * @public
+ */
+export type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
+
+/**
+ * Represents a FreeWheel cue.
+ *
+ * @public
+ */
+export interface FreeWheelCue {
+  /**
+   * The ad unit type.
+   */
+  adUnit: FreeWheelAdUnitType;
+
+  /**
+   * Offset after which the ad break will start, in seconds.
+   */
+  timeOffset: number;
+}
+
+/**
+ * Describes a FreeWheel ad break request.
+ *
+ * @remarks
+ * <br/> - Available since v2.42.0.
+ *
+ * @public
+ */
+export interface FreeWheelAdDescription extends AdDescription {
+  /**
+   * The integration of this ad break.
+   */
+  integration: 'freewheel';
+
+  /**
+   * The FreeWheel ad server URL.
+   */
+  adServerUrl: string;
+
+  /**
+   * The duration of the asset, in seconds.
+   *
+   * @remarks
+   * <br/> - Optional for live assets.
+   */
+  assetDuration?: number;
+
+  /**
+   * The identifier of the asset.
+   *
+   * @remarks
+   * <br/> - Generated by FreeWheel CMS when an asset is uploaded.
+   */
+  assetId?: string;
+
+  /**
+   * The network identifier which is associated with a FreeWheel customer.
+   */
+  networkId: number;
+
+  /**
+   * The server side configuration profile.
+   *
+   * @remarks
+   * <br/> - Used to indicate desired player capabilities.
+   */
+  profile: string;
+
+  /**
+   * The identifier of the video player's location.
+   */
+  siteSectionId?: string;
+
+  /**
+   * List of cue points.
+   *
+   * @remarks
+   * <br/> - Not available in all FreeWheel modes.
+   */
+  cuePoints?: FreeWheelCue[];
+
+  /**
+   * A record of query string parameters added to the FreeWheel ad break request.
+   * Each entry contains the parameter name with associated value.
+   */
+  customData?: Record<string, string>;
+}

package/src/api/source/ads/IMAAdDescription.ts

@@ -0,0 +1,26 @@
+import type { AdDescription, AdSource } from "./Ads";
+
+/**
+ * Describes a Google IMA ad break request.
+ *
+ * @public
+ */
+export interface IMAAdDescription extends AdDescription {
+  /**
+   * The integration of this ad break.
+   */
+  integration: 'google-ima';
+
+  /**
+   * The source of the ad
+   *
+   * @remarks
+   * <br/> - VAST, VMAP and VPAID are supported.
+   */
+  sources: string | AdSource;
+
+  /**
+   * Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).
+   */
+  omidAccessModeRules?: { [key: number]: string };
+}

package/src/api/source/ads/SpotXAdDescription.ts

@@ -0,0 +1,126 @@
+import type { AdDescription } from "./Ads";
+
+/**
+ * Represents a geographical location.
+ *
+ * @public
+ */
+export interface Geo {
+  /**
+   * The latitude of this location.
+   */
+  readonly lat: number;
+
+  /**
+   * The longitude of this location.
+   */
+  readonly lon: number;
+}
+
+/**
+ * A record of SpotX query string parameters.
+ * Each entry contains the parameter name with associated value.
+ *
+ * @public
+ */
+export interface SpotxData {
+  [key: string]: string | number | boolean | string[] | Geo;
+}
+
+/**
+ * A record of SpotX query string parameters which can be a nested structure.
+ * Each entry contains the parameter name with associated value.
+ *
+ * @public
+ */
+export interface SpotxQueryParameter {
+  [key: string]: string | number | boolean | string[] | Geo | SpotxData | SpotxData[];
+}
+
+/**
+ * Describes a SpotX ad break request.
+ *
+ * @remarks
+ * <br/> - Available since v2.13.0.
+ *
+ * @example
+ * ```
+ * {
+ *     integration: 'spotx',
+ *     id: 123456,
+ *     cacheBuster: true,
+ *     app: {
+ *         bundle: 'com.exampleapps.example',
+ *         name: 'My CTV App'
+ *     },
+ *     device: {
+ *         ifa: '38400000-8cf0-11bd-b23e-10b96e40000d',
+ *         ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/56.0.2924.75 Mobile/14E5239e Safari/602.1',
+ *         geo: {
+ *             lat: -24.378528,
+ *             lon: -128.325119
+ *         },
+ *         dnt: 1,
+ *         lmt: 1,
+ *     },
+ *     custom: {
+ *         category: ['category1', 'category2'],
+ *         somekey: 'somevalue'
+ *     }
+ *     user: {
+ *         yob: 1984,
+ *         gender: 'm'
+ *     }
+ * }
+ * ```
+ *
+ * @public
+ */
+export interface SpotXAdDescription extends AdDescription {
+  /**
+   * The identifier of the ad break requested from SpotX.
+   */
+  id: number | string;
+
+  /**
+   * The maximum duration of the ad, in seconds.
+   *
+   * @defaultValue No maximum duration.
+   */
+  maximumAdDuration?: number | string;
+
+  /**
+   * The URL of the content page.
+   */
+  contentPageUrl?: string;
+
+  /**
+   * The IP address of the viewer.
+   */
+  ipAddress?: string;
+
+  /**
+   * Whether the ad break request should contain a cache buster.
+   *
+   * @remarks
+   * <br/> - A cache buster adds a query parameter 'cb' with a random value to circumvent browser caching mechanisms.
+   */
+  cacheBuster?: boolean;
+
+  /**
+   * A source URL which contains the location of ad resources to be scheduled.
+   *
+   * @remarks
+   * <br/> - This will override the generated URL.
+   */
+  sources?: string;
+
+  /**
+   * A record of query string parameters added to the SpotX ad break request.
+   * Each entry contains the parameter name with associated value.
+   *
+   * @remarks
+   * <br/> - Available since v2.38.0.
+   */
+  queryParameters?: SpotxQueryParameter;
+}

package/src/api/source/ads/THEOplayerAdDescription.ts

@@ -0,0 +1,34 @@
+import type { AdDescription, AdSource } from "./Ads";
+
+/**
+ * Describes an ad break request.
+ *
+ * @public
+ */
+export interface THEOplayerAdDescription extends AdDescription {
+  /**
+   * The source of the ad
+   *
+   * @remarks
+   * <br/> - Only supports VAST and VMAP.
+   */
+  sources: string | AdSource;
+
+  /**
+   * Offset after which the ad break can be skipped.
+   *
+   * @remarks
+   * <br/> - A timestamp which is not in the playback window will result in the ad break not being started.
+   * <br/> - VMAP resources will ignore this value as they contain an internal offset.
+   *
+   * Possible formats:
+   * <br/> - A number for the offset in seconds.
+   * <br/> - `'start'` for a preroll.
+   * <br/> - `'end'` for a postroll.
+   * <br/> - `'HH:MM:SS.mmm'` for a timestamp in the playback window.
+   * <br/> - A percentage string (XX%) for a proportion of the content duration.
+   *
+   * @defaultValue `'start'`
+   */
+  skipOffset?: string | number;
+}

package/src/api/source/ads/barrel.ts

@@ -0,0 +1,6 @@
+export * from './Ads';
+export * from './FreeWheelAdDescription';
+export * from './IMAAdDescription';
+export * from './SpotXAdDescription';
+export * from './THEOplayerAdDescription';
+export * from './ssai/barrel';

package/src/api/source/ads/ssai/GoogleDAIConfiguration.ts

@@ -0,0 +1,145 @@
+import type { TypedSource } from '../../SourceDescription';
+import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
+
+/**
+ * The identifier of the Google DAI integration.
+ *
+ * @public
+ */
+export type GoogleDAISSAIIntegrationID = 'google-dai';
+
+/**
+ * The type of the stream requested from Google DAI, represented by a value from the following list:
+ * <br/> - `'live'`: The requested stream is a live stream.
+ * <br/> - `'vod'`: The requested stream is a video-on-demand stream.
+ *
+ * @public
+ */
+export type DAIAvailabilityType = 'vod' | 'live';
+
+/**
+ * Represents a configuration for server-side ad insertion with the Google DAI pre-integration.
+ *
+ * @remarks
+ * <br/> - Available since v2.30.0.
+ *
+ * @public
+ */
+export interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
+    /**
+     * The type of the requested stream.
+     */
+    readonly availabilityType?: DAIAvailabilityType;
+
+    /**
+     * The identifier for the SSAI pre-integration.
+     */
+    integration: GoogleDAISSAIIntegrationID;
+
+    /**
+     * The authorization token for the stream request.
+     *
+     * @remarks
+     * <br/> - If present, this token is used instead of the API key for stricter content authorization.
+     * <br/> - The publisher can control individual content streams authorizations based on this token.
+     */
+    authToken?: string;
+
+    /**
+     * The API key for the stream request.
+     *
+     * @remarks
+     * <br/> - This key is used to verify applications that are attempting to access the content.
+     * <br/> - This key is configured through the Google Ad Manager UI.
+     */
+    apiKey: string;
+
+    /**
+     * The ad tag parameters added to stream request.
+     *
+     * @remarks
+     * <br/> - Each entry contains the parameter name with associated value.
+     *
+     * Valid parameters:
+     * <br/> - {@link https://support.google.com/admanager/answer/7320899 | Supply targeting parameters to your stream}
+     * <br/> - {@link https://support.google.com/admanager/answer/7320898 | Override stream variant parameters}
+     */
+    adTagParameters?: Record<string, string>;
+
+    /**
+     * The identifier for a stream activity monitor session.
+     */
+    streamActivityMonitorID?: string;
+}
+
+/**
+ * Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a Live media stream.
+ *
+ * @remarks
+ * <br/> - Available since v2.30.0.
+ *
+ * @public
+ */
+export interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
+    /**
+     * The type of the requested stream.
+     */
+    readonly availabilityType: 'live';
+
+    /**
+     * The identifier for the video content source for live streams.
+     *
+     * @remarks
+     * <br/> - This property is required for live streams.
+     * <br/> - The asset key can be found in the Google Ad Manager UI.
+     */
+    assetKey: string;
+}
+
+/**
+ * Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a VOD media stream.
+ *
+ * @remarks
+ * <br/> - Available since v2.30.0.
+ *
+ * @public
+ */
+export interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
+    /**
+     * The type of the requested stream.
+     */
+    readonly availabilityType: 'vod';
+
+    /**
+     * The identifier for the publisher content for on-demand streams.
+     *
+     * @remarks
+     * <br/> - The publisher content comes from a CMS.
+     * <br/> - This property is required for on-demand streams.
+     */
+    contentSourceID: string;
+
+    /**
+     * The identifier for the video content source for on-demand streams.
+     *
+     * @remarks
+     * <br/> - This property is required for on-demand streams.
+     */
+    videoID: string;
+}
+
+/**
+ * Represents a media resource with a Google DAI server-side ad insertion request.
+ *
+ * @public
+ */
+export interface GoogleDAITypedSource extends TypedSource {
+    /**
+     * The content type (MIME type) of the media resource, represented by a value from the following list:
+     * <br/> - `'application/dash+xml'`: The media resource is an MPEG-DASH stream.
+     * <br/> - `'application/x-mpegURL'` or `'application/vnd.apple.mpegurl'`: The media resource is an HLS stream.
+     */
+    type: string;
+
+    ssai: GoogleDAIVodConfiguration | GoogleDAILiveConfiguration;
+}

package/src/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.ts

@@ -0,0 +1,30 @@
+import type { TypedSource } from '../../SourceDescription';
+import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
+
+/**
+ * The identifier of the Imagine integration.
+ *
+ * @public
+ */
+export type ImagineSSAIIntegrationID = 'imagine';
+
+/**
+ * Describes the SSAI configuration of the Imagine integration.
+ *
+ * @public
+ */
+export interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
+    /**
+     * {@inheritDoc ServerSideAdInsertionConfiguration.integration}
+     */
+    integration: ImagineSSAIIntegrationID;
+}
+
+/**
+ * Describes a source of the Imagine integration.
+ *
+ * @public
+ */
+export interface ImagineTypedSource extends TypedSource {
+    ssai: ImagineServerSideAdInsertionConfiguration;
+}

package/src/api/source/ads/ssai/ServerSideAdInsertionConfiguration.ts

@@ -0,0 +1,28 @@
+import type { YospaceSSAIIntegrationID } from './YospaceServerSideAdInsertionConfiguration';
+import type { GoogleDAISSAIIntegrationID } from './GoogleDAIConfiguration';
+import type { ImagineSSAIIntegrationID } from './ImagineServerSideAdInsertionConfiguration';
+
+/**
+ * The identifier of a server-side ad insertion pre-integration, represented by a value from the following list:
+ * <br/> - `'yospace'`: The configuration with this identifier is a {@link YospaceServerSideAdInsertionConfiguration}
+ * <br/> - `'google-dai'`: The configuration with this identifier is a {@link GoogleDAIConfiguration}
+ * <br/> - `'imagine'`: The configuration with this identifier is a {@link ImagineServerSideAdInsertionConfiguration}
+ *
+ * @public
+ */
+export type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID | ImagineSSAIIntegrationID;
+
+/**
+ * Represents a configuration for server-side ad insertion (SSAI).
+ *
+ * @remarks
+ * <br/> - Available since v2.12.0.
+ *
+ * @public
+ */
+export interface ServerSideAdInsertionConfiguration {
+    /**
+     * The identifier for the SSAI integration.
+     */
+    integration: SSAIIntegrationId;
+}

package/src/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.ts

@@ -0,0 +1,51 @@
+import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
+import type { TypedSource } from '../../SourceDescription';
+
+/**
+ * The identifier of the Yospace integration.
+ *
+ * @public
+ */
+export type YospaceSSAIIntegrationID = 'yospace';
+
+/**
+ * The type of the Yospace stream, represented by a value from the following list:
+ * <br/> - `'live'`: The stream is a live stream.
+ * <br/> - `'livepause'`: The stream is a live stream with a large DVR window.
+ * <br/> - `'nonlinear'`: The stream is a Non-Linear Start-Over stream.
+ * <br/> - `'vod'`: The stream is a video-on-demand stream.
+ *
+ * @public
+ */
+export type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
+
+/**
+ * Represents a configuration for server-side ad insertion with the Yospace pre-integration.
+ *
+ * @remarks
+ * <br/> - Available since v2.14.7.
+ *
+ * @public
+ */
+export interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
+    /**
+     * The identifier for the SSAI pre-integration.
+     */
+    integration: YospaceSSAIIntegrationID;
+
+    /**
+     * The type of the requested stream.
+     *
+     * @defaultValue `'live'`
+     */
+    streamType?: YospaceStreamType;
+}
+
+/**
+ * Represents a media resource with a Yospace server-side ad insertion request.
+ *
+ * @public
+ */
+export interface YospaceTypedSource extends TypedSource {
+    ssai: YospaceServerSideAdInsertionConfiguration;
+}

package/src/api/source/ads/ssai/barrel.ts

@@ -0,0 +1,4 @@
+export * from './GoogleDAIConfiguration';
+export * from './ImagineServerSideAdInsertionConfiguration';
+export * from './ServerSideAdInsertionConfiguration';
+export * from './YospaceServerSideAdInsertionConfiguration';

package/src/api/source/barrel.ts

@@ -1,3 +1,4 @@
+export * from './ads/barrel';
 export * from './drm/barrel';
 export * from './dash/barrel';
 export * from './hls/barrel';

package/src/api/source/drm/DRMConfiguration.ts

@@ -92,34 +92,6 @@ export interface KeySystemConfiguration {
    * The certificate for the key system. This can be either an ArrayBuffer or Uint8Array containing the raw certificate bytes or a base64-encoded variant of this.
    */
   certificate?: string;
-
-  /**
-   * Process the certificate's request.
-   *
-   * @deprecated Please use {@link registerContentProtectionIntegration} and {@link ContentProtectionIntegration.onCertificateRequest} instead.
-   */
-  certificateRequestProcessor?: DRMProcessor;
-
-  /**
-   * Process the certificate's response.
-   *
-   * @deprecated Please use {@link registerContentProtectionIntegration} and {@link ContentProtectionIntegration.onCertificateResponse} instead.
-   */
-  certificateResponseProcessor?: DRMProcessor;
-
-  /**
-   * Process the license's request.
-   *
-   * @deprecated Please use {@link registerContentProtectionIntegration} and {@link ContentProtectionIntegration.onLicenseRequest} instead.
-   */
-  licenseRequestProcessor?: DRMProcessor;
-
-  /**
-   * Process the license's response.
-   *
-   * @deprecated Please use {@link registerContentProtectionIntegration} and {@link ContentProtectionIntegration.onLicenseResponse} instead.
-   */
-  licenseResponseProcessor?: DRMProcessor;
 }
 
 /**
@@ -162,13 +134,6 @@ export interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration
  */
 export type WidevineKeySystemConfiguration = KeySystemConfiguration;
 
-/**
- * A function which processes DRM data.
- *
- * @public
- */
-export type DRMProcessor = (arrayBuffer: ArrayBuffer) => ArrayBuffer;
-
 /**
  * Describes the ClearKey key system configuration.
  *

package/src/api/track/MediaTrack.ts

@@ -37,7 +37,7 @@ export interface MediaTrack extends Track {
   /**
    * The label of the media track.
    */
-  label: string;
+  readonly label: string;
 
   /**
    * The language of the media track.
@@ -61,5 +61,25 @@ export interface MediaTrack extends Track {
    * <br/> - If desired qualities are present, the Adaptive Bitrate mechanism of the player will limit itself to these qualities.
    * <br/> - If one desired quality is present, the Adaptive Bitrate mechanism of the player will be disabled and the desired quality will be played back.
    */
-  targetQuality: number | number[] | undefined;
+  readonly targetQuality: number | number[] | undefined;
+}
+
+export function findMediaTrackByUid(mediaTracks: MediaTrack[], uid: number | undefined): MediaTrack | undefined {
+  return mediaTracks.find((track) => track.uid === uid);
+}
+
+export function findQualityByUid(mediaTrack: MediaTrack, uid: number | undefined): Quality | undefined {
+  return mediaTrack.qualities.find((quality) => quality.uid === uid);
+}
+
+export function findQualitiesByUid(mediaTrack: MediaTrack | undefined, uid: number | number[] | undefined): Quality[] | undefined {
+  if (uid && mediaTrack) {
+    if (Array.isArray(uid)) {
+      return mediaTrack.qualities.filter((quality) => uid.includes(quality.uid));
+    } else {
+      const quality = findQualityByUid(mediaTrack, uid);
+      return quality ? [quality] : undefined;
+    }
+  }
+  return undefined;
 }