react-native-theoplayer 1.6.1 → 1.7.1

package/lib/typescript/lib/module/internal/drm/ContentProtectionRegistry.web.d.ts

@@ -0,0 +1,4 @@
+export class WebContentProtectionRegistry {
+    registerContentProtectionIntegration(integrationId: any, keySystem: any, integrationFactory: any): void;
+}
+export const ContentProtectionRegistry: WebContentProtectionRegistry;

package/lib/typescript/lib/module/internal/drm/NativeCertificateRequest.d.ts

@@ -0,0 +1,17 @@
+export function fromNativeCertificateRequest(request: any): {
+    url: any;
+    method: any;
+    headers: any;
+    useCredentials: any;
+    body: Uint8Array | null;
+};
+export function toNativeCertificateRequest(requestId: any, integrationId: any, keySystemId: any, request: any): {
+    requestId: any;
+    integrationId: any;
+    keySystemId: any;
+    url: any;
+    method: any;
+    headers: any;
+    useCredentials: any;
+    base64body: string | null;
+};

package/lib/typescript/lib/module/internal/drm/NativeCertificateResponse.d.ts

@@ -0,0 +1,20 @@
+export function fromNativeCertificateResponse(response: any): {
+    url: any;
+    status: any;
+    statusText: any;
+    headers: any;
+    body: Uint8Array;
+    request: {
+        url: any;
+        method: any;
+        headers: any;
+        useCredentials: any;
+        body: Uint8Array | null;
+    };
+};
+export function toNativeCertificateResponseResult(requestId: any, integrationId: any, keySystemId: any, response: any): {
+    requestId: any;
+    integrationId: any;
+    keySystemId: any;
+    base64body: string;
+};

package/lib/typescript/lib/module/internal/drm/NativeLicenseRequest.d.ts

@@ -0,0 +1,19 @@
+export function fromNativeLicenseRequest(request: any): {
+    url: any;
+    method: any;
+    headers: any;
+    useCredentials: any;
+    body: Uint8Array | null;
+    fairplaySkdUrl: any;
+};
+export function toNativeLicenseRequest(requestId: any, integrationId: any, keySystemId: any, request: any): {
+    requestId: any;
+    integrationId: any;
+    keySystemId: any;
+    url: any;
+    method: any;
+    headers: any;
+    useCredentials: any;
+    base64body: string | null;
+    fairplaySkdUrl: any;
+};

package/lib/typescript/lib/module/internal/drm/NativeLicenseResponse.d.ts

@@ -0,0 +1,21 @@
+export function fromNativeLicenseResponse(response: any): {
+    url: any;
+    status: any;
+    statusText: any;
+    headers: any;
+    body: Uint8Array;
+    request: {
+        url: any;
+        method: any;
+        headers: any;
+        useCredentials: any;
+        body: Uint8Array | null;
+        fairplaySkdUrl: any;
+    };
+};
+export function toNativeLicenseResponseResult(requestId: any, integrationId: any, keySystemId: any, response: any): {
+    requestId: any;
+    integrationId: any;
+    keySystemId: any;
+    base64body: string;
+};

package/lib/typescript/lib/module/internal/utils/TypeUtils.d.ts

@@ -0,0 +1,5 @@
+export function decodeNanInf(v: any): any;
+export function arrayContainsElement_(array: any, element: any): boolean;
+export function isBufferSource(bufferSource: any): boolean;
+export const objectToString: () => string;
+export const isArrayBufferView_: (arg: any) => arg is ArrayBufferView;

package/lib/typescript/lib/module/internal/web/TrackUtils.d.ts

@@ -27,3 +27,5 @@ export function fromNativeMediaTrack(track: any): {
     qualities: any;
     targetQuality: any;
 };
+export function findNativeQualityByUid(mediaTrack: any, uid: any): any;
+export function findNativeQualitiesByUid(mediaTrack: any, uid: any): any;

package/lib/typescript/src/api/THEOplayerView.d.ts

@@ -2,13 +2,22 @@ import type { SourceDescription } from './source/SourceDescription';
 import type { StyleProp, ViewStyle } from 'react-native';
 import type { DurationChangeEvent, ErrorEvent, LoadedMetadataEvent, ReadyStateChangeEvent, TimeUpdateEvent, ProgressEvent, SegmentNotFoundEvent } from './event/PlayerEvent';
 import type { TextTrackEvent, TextTrackListEvent } from './event/TrackEvent';
-import type { HostComponent } from 'react-native';
 import type { PlayerConfiguration } from './config/PlayerConfiguration';
+import type { ABRConfiguration } from './abr/ABRConfiguration';
+import type { AdEvent } from "./event/AdEvent";
+import type { AdsAPI } from "./ads/AdsAPI";
 export interface THEOplayerViewProps {
     /**
      * The player configuration with THEOplayer license.
      */
     config?: PlayerConfiguration;
+    /**
+     * The player's adaptive bitrate (ABR) configuration.
+     *
+     * @remarks
+     * <br/> - This property is supported on Android & Web platforms only.
+     */
+    abrConfig?: ABRConfiguration;
     /**
      * A source description that determines the current media resource.
      */
@@ -56,6 +65,10 @@ export interface THEOplayerViewProps {
      * Used to set the current selected video track by passing its `uid`, or `null` to select none.
      */
     selectedVideoTrack?: number | null;
+    /**
+     * Used to set the current selected video quality by passing its `uid`, or `null` to select none.
+     */
+    targetVideoQuality?: number | number[] | undefined;
     /**
      * Used to set the current selected audio track by passing its `uid`, or `null` to select none.
      */
@@ -136,7 +149,7 @@ export interface THEOplayerViewProps {
      */
     onSeeking?: () => void;
     /**
-     * Invoked when a seek operation completed and the current playback position has changed
+     * Invoked when a seek operation completed and the current playback position has changed.
      */
     onSeeked?: () => void;
     /**
@@ -145,7 +158,7 @@ export interface THEOplayerViewProps {
      */
     onEnded?: () => void;
     /**
-     * Invoked when the current playback position changed.
+     * Invoked each time the current playback position changed.
      */
     onTimeUpdate?: (event: TimeUpdateEvent) => void;
     /**
@@ -167,12 +180,20 @@ export interface THEOplayerViewProps {
      * Invoked when a text track event occurs.
      */
     onTextTrackEvent?: (event: TextTrackEvent) => void;
+    /**
+     * Invoked when an ad event occurs.
+     */
+    onAdEvent?: (event: AdEvent) => void;
 }
-export interface THEOplayerViewComponent extends HostComponent<THEOplayerViewProps> {
+export interface THEOplayerViewComponent {
     /**
      * Seek to a new position.
      *
      * @param seekTime - new time, in milliseconds.
      */
     seek: (seekTime: number) => void;
+    /**
+     * The API for advertisements.
+     */
+    ads: AdsAPI;
 }

package/lib/typescript/src/api/abr/ABRConfiguration.d.ts

@@ -0,0 +1,95 @@
+/**
+ * The adaptive bitrate strategy of the first segment, represented by a value from the following list:
+ * <br/> - `'performance'`: The player will optimize ABR behavior to focus on the performance of the player. This strategy initiates playback with the lowest quality suitable for the device which means faster start-up time.
+ * <br/> - `'quality'`: The player will optimize ABR behavior to focus displaying the best visual quality to the end-user. This strategy initiates playback with the highest bit rate suitable for the device.
+ * <br/> - `'bandwidth'`: The player will optimize the ABR behavior to focus on displaying the most optimal quality based on historic data of available bandwidth and knowledge of the network conditions.
+ *
+ * @public
+ */
+export declare type ABRStrategyType = 'performance' | 'quality' | 'bandwidth';
+/**
+ * Describes the metadata of the adaptive bitrate strategy.
+ *
+ * @public
+ */
+export interface ABRMetadata {
+    /**
+     * The initial bitrate, in bits per second.
+     *
+     * @defaultValue Bitrate available to the browser.
+     */
+    bitrate?: number;
+}
+/**
+ * Describes the configuration of the adaptive bitrate strategy.
+ *
+ * @public
+ */
+export interface ABRStrategyConfiguration {
+    /**
+     * The strategy for initial playback.
+     */
+    type: ABRStrategyType;
+    /**
+     * The metadata for the initial playback strategy.
+     *
+     * @defaultValue A {@link ABRMetadata} object with default values.
+     */
+    metadata?: ABRMetadata;
+}
+/**
+ * The adaptive bitrate stratey.
+ *
+ * @public
+ */
+export declare type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;
+/**
+ * Describes the adaptive bitrate configuration.
+ *
+ * @public
+ */
+export interface ABRConfiguration {
+    /**
+     * The adaptive bitrate strategy.
+     *
+     * @defaultValue `'bandwidth'`
+     */
+    strategy?: ABRStrategy;
+    /**
+     * The amount which the player should buffer ahead of the current playback position, in seconds.
+     *
+     * @remarks
+     * <br/> - Before v4.3.0: This duration has a maximum of 60 seconds.
+     * <br/> - After v4.3.0: This duration has no maximum.
+     * <br/> - The player might reduce or ignore the configured amount because of device or performance constraints.
+     *
+     * @defaultValue `20`
+     */
+    targetBuffer?: number;
+    /**
+     * The amount of data which the player should keep in its buffer before the current playback position, in seconds.
+     * This configuration option can be used to reduce the memory footprint on memory restricted devices or on devices
+     * which don't automatically prune decoder buffers.
+     *
+     * Note that the player can decide to keep less data in the decoder buffer in case memory is running low.
+     * A value of 0 or lower is not accepted and will be treated as default.
+     *
+     * @defaultValue `30`
+     *
+     * @remarks
+     * <br/> - This property is currently supported on Web platforms only.
+     */
+    bufferLookbackWindow?: number;
+    /**
+     * The maximum length of the player's buffer, in seconds.
+     *
+     * The player will initially buffer up to {@link ABRConfiguration.targetBuffer} seconds of media data.
+     * If the player detects that the decoder is unable to hold so much data,
+     * it will reduce `maxBufferLength` and restrict `targetBuffer` to be less than
+     * this maximum.
+     *
+     * @remarks
+     * <br/> - This property is currently supported on Web platforms only.
+     */
+    readonly maxBufferLength?: number;
+}

package/lib/typescript/src/api/abr/barrel.d.ts

@@ -0,0 +1 @@
+export * from './ABRConfiguration';

package/lib/typescript/src/api/ads/Ad.d.ts

@@ -0,0 +1,238 @@
+/**
+ * Represents a VAST creative. It is either a linear or non-linear ad.
+ *
+ * @public
+ */
+import type { AdBreak } from './AdBreak';
+import type { CompanionAd } from 'theoplayer';
+export interface Ad {
+    /**
+     * The source ad server information included in the ad response.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    adSystem: string | undefined;
+    /**
+     * The integration of the ad, represented by a value from the following list:
+     * <br/> - `'theo'`
+     * <br/> - `'google-ima'`
+     * <br/> - `'google-dai'`
+     * <br/> - `'freewheel'`
+     *
+     * @defaultValue `'theo'`
+     */
+    integration?: string;
+    /**
+     * The type of the ad, represented by a value from the following list:
+     * <br/> - `'linear'`
+     * <br/> - `'nonlinear'`
+     */
+    type: string;
+    /**
+     * The identifier of the creative.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    id: string | undefined;
+    /**
+     * The ready state of the ad.
+     */
+    readyState?: AdReadyState;
+    /**
+     * The ad break which the ad is part of.
+     *
+     * @remarks
+     * <br/> - Available for VAST-ads.
+     */
+    adBreak: AdBreak;
+    /**
+     * The duration of the ad, in seconds.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     * <br/> - Only available for LinearAd.
+     */
+    duration?: number;
+    /**
+     * The width of the ad, in pixels.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    width: number | undefined;
+    /**
+     * The height of the ad.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    height: number | undefined;
+    /**
+     * The URI of the the ad content.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    resourceURI?: string;
+    /**
+     * The website of the advertisement.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    clickThrough: string | undefined;
+    /**
+     * List of companions which can be displayed outside the player.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     * <br/> - Only supported for `'theo'` and `'google-dai'`.
+     */
+    companions: CompanionAd[];
+    /**
+     * Offset after which the ad break may be skipped, in seconds.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     * <br/> - If the offset is -1, the ad is unskippable.
+     * <br/> - If the offset is 0, the ad is immediately skippable.
+     * <br/> - Otherwise it must be a positive number indicating the offset.
+     */
+    skipOffset: number | undefined;
+    /**
+     * The identifier of the selected creative for the ad.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    creativeId: string | undefined;
+    /**
+     * The list of universal ad ID information of the selected creative for the ad.
+     *
+     * @remarks
+     * <br/> - Only supported for `'theo'` and `'google-ima'`.
+     */
+    universalAdIds: UniversalAdId[];
+}
+/**
+ * The ad readiness state, represented by a value from the following list:
+ * <br/> - `'none'`: The ad not loaded state.
+ * <br/> - `'ready'`: The ad loaded state.
+ *
+ * @remarks
+ * <br/> - An ad is loaded when the ad resource (e.g. VAST file) is downloaded.
+ * <br/> - another remark
+ *
+ * @public
+ */
+export declare type AdReadyState = 'none' | 'ready';
+/**
+ * Represents the information regarding the universal identifier of an ad.
+ *
+ * @public
+ */
+export interface UniversalAdId {
+    /**
+     * The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
+     *
+     * @remarks
+     * <br/> - Returns the registry value, or 'unknown' if unavailable.
+     */
+    adIdRegistry: string;
+    /**
+     * The UniversalAdId of the selected creative for the ad.
+     *
+     * @remarks
+     * <br/> - Returns the id value or 'unknown' if unavailable.
+     */
+    adIdValue: string;
+}
+/**
+ * Represents a non-linear ad in the VAST specification.
+ *
+ * @public
+ */
+export interface NonLinearAd extends Ad {
+    /**
+     * The alternative description for the ad.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    altText: string | undefined;
+    /**
+     * The website of the ad.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    clickThrough: string | undefined;
+    /**
+     * The HTML-string with the content of the ad.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    contentHTML: string | undefined;
+}
+/**
+ * The delivery type of the ad content file, represented by a value from the following list:
+ * <br/> - `'progressive'`: Delivered through progressive download protocols (e.g. HTTP).
+ * <br/> - `'streaming'`: Delivered through streaming download protocols.
+ *
+ * @remarks
+ * <br/> - `'streaming'` is currently not supported.
+ *
+ * @public
+ */
+export declare type DeliveryType = 'progressive' | 'streaming';
+/**
+ * Represents metadata of an media file with ad content.
+ *
+ * @remarks
+ * <br/> - This metadata is retrieved from the VAST file.
+ *
+ * @public
+ */
+export interface MediaFile {
+    /**
+     * The delivery type of the video file.
+     */
+    delivery: DeliveryType;
+    /**
+     * The MIME type for the file container.
+     */
+    type: string;
+    /**
+     * The native width of the video file, in pixels.
+     */
+    width: number;
+    /**
+     * The native height of the video file, in pixels.
+     */
+    height: number;
+    /**
+     * The URI of the VAST content.
+     */
+    contentURL: string;
+}
+/**
+ * Represents a linear ad in the VAST specification.
+ *
+ * @public
+ */
+export interface LinearAd extends Ad {
+    /**
+     * The duration of the ad, in seconds.
+     *
+     * @remarks
+     * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
+     */
+    duration: number;
+    /**
+     * List of media files which contain metadata about ad video files.
+     */
+    mediaFiles: MediaFile[];
+}

package/lib/typescript/src/api/ads/AdBreak.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents an ad break in the VMAP specification or an ad pod in the VAST specification.
+ *
+ * @public
+ */
+import type { Ad } from './Ad';
+export interface AdBreak {
+    /**
+     * The integration of the ad break, represented by a value from the following list:
+     * <br/> - `'theo'`
+     * <br/> - `'google-ima'`
+     * <br/> - `'google-dai'`
+     * <br/> - `'freewheel'`
+     */
+    integration: string | undefined;
+    /**
+     * List of ads which will be played sequentially at the ad break's time offset.
+     */
+    ads: Ad[] | undefined;
+    /**
+     * The time offset at which content will be paused to play the ad break, in seconds.
+     */
+    timeOffset: number;
+    /**
+     * The duration of the ad break, in seconds.
+     *
+     * @remarks
+     * <br/> - Ads are lazily loaded. This property becomes available when all ads are loaded.
+     */
+    maxDuration: number | undefined;
+    /**
+     * The remaining duration of the ad break, in seconds.
+     *
+     * @remarks
+     * <br/> - Ads are lazily loaded. This property becomes available when all ads are loaded.
+     * <br/> - This feature is not available in the Google IMA integration and will default to -1.
+     */
+    maxRemainingDuration: number | undefined;
+}

package/lib/typescript/src/api/ads/AdsAPI.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The API for advertisements.
+ */
+import type { AdDescription } from "../source/ads/Ads";
+import type { AdBreak } from "./AdBreak";
+import type { Ad } from "./Ad";
+import type { GoogleDAI } from "./GoogleDai";
+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;
+}

package/lib/typescript/src/api/ads/AdsConfiguration.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Describes the configuration of advertisement.
+ *
+ * @public
+ */
+import type { GoogleImaConfiguration } from './GoogleImaConfiguration';
+export interface AdsConfiguration {
+    /**
+     * Allows configuring which mime types are allowed during ad playback.
+     *
+     * @remarks
+     * <br/> - This feature is only available for Google IMA.
+     * <br/> - If set to an array, all ads with another mime types will be ignored.
+     * <br/> - If set to `undefined` the ad system will pick media based on the browser's capabilities.
+     *
+     * @defaultValue `undefined`
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * Whether an advertisement UI is shown.
+     *
+     * @defaultValue `true`
+     */
+    uiEnabled?: boolean;
+    /**
+     * Whether media files of mid- and postrolls are preloaded.
+     *
+     * @remarks
+     * <br/> - This feature is only available for Google IMA.
+     *
+     * @defaultValue `'midroll-and-postroll'`
+     */
+    preload?: AdPreloadType;
+    /**
+     * The iframe policy for VPAID ads.
+     *
+     * @remarks
+     * <br/> - This feature is only available for Google IMA and SpotX.
+     *
+     * @defaultValue `'enabled'`
+     */
+    vpaidMode?: VPAIDMode;
+    /**
+     * The Google IMA configuration.
+     *
+     * @internal
+     */
+    googleImaConfiguration?: GoogleImaConfiguration;
+}
+/**
+ * The ad preloading strategy, represented by a value from the following list:
+ * <br/> - `'none'`: Ads are not preloaded.
+ * <br/> - `'midroll-and-postroll'`: Mid- and postrolls are preloaded.
+ *
+ * @remarks
+ * <br/> - For Google IMA, preloading starts 4 seconds before ad playback.
+ *
+ * @public
+ */
+export declare type AdPreloadType = 'none' | 'midroll-and-postroll';
+/**
+ * The iframe policies for VPAID ads, represented by a value from the following list:
+ * <br/> - `'enabled'`: Ads will load in a cross domain iframe. This disables access to the site via JavaScript. Ads that require a friendly iframe will fail to play.
+ * <br/> - `'insecure'`: Ads will load in a friendly iframe. This allows access to the site via JavaScript.
+ * <br/> - `'disabled'`: Ads will error when requested.
+ *
+ * @public
+ */
+export declare type VPAIDMode = 'enabled' | 'insecure' | 'disabled';