react-native-theoplayer 1.6.1 → 1.7.1

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

@@ -0,0 +1,18 @@
+import type { NativeContentProtectionEvent } from './NativeContentProtectionEvent';
+import type { CertificateResponse } from 'react-native-theoplayer';
+import type { NativeCertificateRequest } from './NativeCertificateRequest';
+export interface NativeCertificateResponse extends NativeContentProtectionEvent {
+    url: string;
+    status: number;
+    statusText: string;
+    headers: {
+        [headerName: string]: string;
+    };
+    base64body: string;
+    request: NativeCertificateRequest;
+}
+export interface NativeCertificateResponseResult extends NativeContentProtectionEvent {
+    base64body: string;
+}
+export declare function fromNativeCertificateResponse(response: NativeCertificateResponse): CertificateResponse;
+export declare function toNativeCertificateResponseResult(requestId: string, integrationId: string, keySystemId: string, response: ArrayBuffer): NativeCertificateResponseResult;

package/lib/typescript/src/internal/drm/NativeContentProtectionEvent.d.ts

@@ -0,0 +1,5 @@
+export interface NativeContentProtectionEvent {
+    requestId: string;
+    integrationId: string;
+    keySystemId: string;
+}

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

@@ -0,0 +1,14 @@
+import type { NativeContentProtectionEvent } from './NativeContentProtectionEvent';
+import type { LicenseRequest } from 'react-native-theoplayer';
+export interface NativeLicenseRequest extends NativeContentProtectionEvent {
+    url: string;
+    method: string;
+    headers: {
+        [headerName: string]: string;
+    };
+    base64body: string | null;
+    useCredentials: boolean;
+    fairplaySkdUrl: string | undefined;
+}
+export declare function fromNativeLicenseRequest(request: NativeLicenseRequest): LicenseRequest;
+export declare function toNativeLicenseRequest(requestId: string, integrationId: string, keySystemId: string, request: LicenseRequest): NativeLicenseRequest;

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

@@ -0,0 +1,18 @@
+import type { NativeContentProtectionEvent } from './NativeContentProtectionEvent';
+import type { LicenseResponse } from 'react-native-theoplayer';
+import type { NativeLicenseRequest } from './NativeLicenseRequest';
+export interface NativeLicenseResponse extends NativeContentProtectionEvent {
+    url: string;
+    status: number;
+    statusText: string;
+    headers: {
+        [headerName: string]: string;
+    };
+    base64body: string;
+    request: NativeLicenseRequest;
+}
+export interface NativeLicenseResponseResult extends NativeContentProtectionEvent {
+    base64body: string;
+}
+export declare function fromNativeLicenseResponse(response: NativeLicenseResponse): LicenseResponse;
+export declare function toNativeLicenseResponseResult(requestId: string, integrationId: string, keySystemId: string, response: ArrayBuffer): NativeLicenseResponseResult;

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

@@ -0,0 +1,5 @@
+export declare function decodeNanInf(v: number): number;
+export declare const objectToString: () => string;
+export declare function arrayContainsElement_<T>(array: ReadonlyArray<T>, element: T): boolean;
+export declare const isArrayBufferView_: typeof ArrayBuffer.isView;
+export declare function isBufferSource(bufferSource: any): bufferSource is BufferSource;

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

@@ -1,5 +1,7 @@
-import type { TextTrackCue as NativeTextTrackCue, TextTrack as NativeTextTrack, MediaTrack as NativeMediaTrack } from 'theoplayer';
+import type { TextTrackCue as NativeTextTrackCue, TextTrack as NativeTextTrack, MediaTrack as NativeMediaTrack, Quality as NativeQuality } from 'theoplayer';
 import type { TextTrack, TextTrackCue, MediaTrack } from 'react-native-theoplayer';
 export declare function fromNativeCue(cue: NativeTextTrackCue): TextTrackCue;
 export declare function fromNativeTextTrack(track: NativeTextTrack): TextTrack;
 export declare function fromNativeMediaTrack(track: NativeMediaTrack): MediaTrack;
+export declare function findNativeQualityByUid(mediaTrack: NativeMediaTrack, uid: number | undefined): NativeQuality | undefined;
+export declare function findNativeQualitiesByUid(mediaTrack: NativeMediaTrack | undefined, uid: number | number[] | undefined): NativeQuality[] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-theoplayer",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "A THEOplayer video component for react-native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -48,7 +48,7 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^11.0.0",
     "@react-native-community/eslint-config": "^2.0.0",
-    "@release-it/conventional-changelog": "^2.0.0",
+    "@release-it/conventional-changelog": "^5.1.1",
     "@types/react": "^17.0.1",
     "@types/react-native": "0.64.2",
     "commitlint": "^11.0.0",
@@ -62,7 +62,7 @@
     "react": "17.0.1",
     "react-native": "0.64.2",
     "react-native-builder-bob": "^0.18.0",
-    "release-it": "^14.2.2",
+    "release-it": "^15.5.0",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
@@ -110,6 +110,7 @@
     ]
   },
   "dependencies": {
+    "buffer": "^6.0.3",
     "theoplayer": "^3.4.0"
   }
 }

package/src/api/THEOplayerView.ts

@@ -10,8 +10,10 @@ import type {
   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 {
   /**
@@ -19,6 +21,14 @@ export interface THEOplayerViewProps {
    */
   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.
    */
@@ -74,6 +84,11 @@ export interface THEOplayerViewProps {
    */
   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.
    */
@@ -172,7 +187,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;
 
@@ -183,7 +198,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;
 
@@ -209,13 +224,23 @@ 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/src/api/abr/ABRConfiguration.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 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 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/src/api/abr/barrel.ts

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

package/src/api/ads/Ad.ts

@@ -0,0 +1,267 @@
+/**
+ * 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 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 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/src/api/ads/AdBreak.ts

@@ -0,0 +1,44 @@
+/**
+ * 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/src/api/ads/AdsAPI.ts

@@ -0,0 +1,53 @@
+/**
+ * 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;
+}