react-native-theoplayer 2.16.1 → 3.0.0-pre1

package/lib/typescript/api/event/EventListener.d.ts

@@ -4,4 +4,4 @@ import type { Event } from './Event';
  *
  * @public
  */
-export declare type EventListener<TEvent extends Event> = (event: TEvent) => void;
+export type EventListener<TEvent extends Event> = (event: TEvent) => void;

package/lib/typescript/api/player/THEOplayer.d.ts

@@ -12,7 +12,7 @@ import type { PresentationMode } from '../presentation/PresentationMode';
 import type { PiPConfiguration } from '../pip/PiPConfiguration';
 import type { BackgroundAudioConfiguration } from '../backgroundAudio/BackgroundAudioConfiguration';
 import type { PlayerVersion } from './PlayerVersion';
-export declare type PreloadType = 'none' | 'metadata' | 'auto' | '';
+export type PreloadType = 'none' | 'metadata' | 'auto' | '';
 /**
  * Specifies an aspect ratio for the player.
  *
@@ -28,7 +28,7 @@ export declare enum AspectRatio {
     FILL = "fill",
     ASPECT_FILL = "aspectFill"
 }
-export declare type NativeHandleType = unknown;
+export type NativeHandleType = unknown;
 /**
  * The THEOplayer API.
  */

package/lib/typescript/api/source/SourceDescription.d.ts

@@ -13,7 +13,7 @@ import type { AdDescription } from './ads/Ads';
 import type { MetadataDescription } from './metadata/MetadataDescription';
 import type { ServerSideAdInsertionConfiguration } from "./ads/ssai/ServerSideAdInsertionConfiguration";
 import type { AnalyticsDescription } from "./analytics/AnalyticsDescription";
-export declare type Source = TypedSource;
+export type Source = TypedSource;
 /**
  * A media resource or list of media resources.
  *
@@ -22,7 +22,7 @@ export declare type Source = TypedSource;
  *
  * @public
  */
-export declare type Sources = Source | Source[];
+export type Sources = Source | Source[];
 /**
  * The cross-origin setting of a source, represented by a value from the following list:
  * <br/> - `'anonymous'`: CORS requests will have the credentials flag set to 'same-origin'.
@@ -34,7 +34,7 @@ export declare type Sources = Source | Source[];
  *
  * @public
  */
-export declare type CrossOriginSetting = '' | 'anonymous' | 'use-credentials';
+export type CrossOriginSetting = '' | 'anonymous' | 'use-credentials';
 /**
  * Describes the configuration of a player's source.
  *

package/lib/typescript/api/source/ads/Ads.d.ts

@@ -9,7 +9,7 @@
  *
  * @public
  */
-export declare type AdSourceType = 'vast' | 'vmap' | 'adrule';
+export type AdSourceType = 'vast' | 'vmap' | 'adrule';
 /**
  * Describes the source of the ad.
  *

package/lib/typescript/api/source/ads/FreeWheelAdDescription.d.ts

@@ -8,7 +8,7 @@ import type { AdDescription, AdIntegrationKind } from "./Ads";
  *
  * @public
  */
-export declare type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
+export type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
 /**
  * Represents a FreeWheel cue.
  *

package/lib/typescript/api/source/ads/ssai/GoogleDAIConfiguration.d.ts

@@ -5,7 +5,7 @@ import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertion
  *
  * @public
  */
-export declare type GoogleDAISSAIIntegrationID = 'google-dai';
+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.
@@ -13,7 +13,7 @@ export declare type GoogleDAISSAIIntegrationID = 'google-dai';
  *
  * @public
  */
-export declare type DAIAvailabilityType = 'vod' | 'live';
+export type DAIAvailabilityType = 'vod' | 'live';
 /**
  * Represents a configuration for server-side ad insertion with the Google DAI pre-integration.
  *

package/lib/typescript/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.d.ts

@@ -5,7 +5,7 @@ import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertion
  *
  * @public
  */
-export declare type ImagineSSAIIntegrationID = 'imagine';
+export type ImagineSSAIIntegrationID = 'imagine';
 /**
  * Describes the SSAI configuration of the Imagine integration.
  *

package/lib/typescript/api/source/ads/ssai/ServerSideAdInsertionConfiguration.d.ts

@@ -9,7 +9,7 @@ import type { ImagineSSAIIntegrationID } from './ImagineServerSideAdInsertionCon
  *
  * @public
  */
-export declare type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID | ImagineSSAIIntegrationID;
+export type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID | ImagineSSAIIntegrationID;
 /**
  * Represents a configuration for server-side ad insertion (SSAI).
  *

package/lib/typescript/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.d.ts

@@ -5,7 +5,7 @@ import type { TypedSource } from '../../SourceDescription';
  *
  * @public
  */
-export declare type YospaceSSAIIntegrationID = 'yospace';
+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.
@@ -15,7 +15,7 @@ export declare type YospaceSSAIIntegrationID = 'yospace';
  *
  * @public
  */
-export declare type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
+export type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
 /**
  * Represents a configuration for server-side ad insertion with the Yospace pre-integration.
  *

package/lib/typescript/api/source/dash/DashPlaybackConfiguration.d.ts

@@ -10,7 +10,7 @@
  *
  * @public
  */
-export declare type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
+export type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *

package/lib/typescript/api/source/drm/DRMConfiguration.d.ts

@@ -95,7 +95,7 @@ export interface KeySystemConfiguration {
  *
  * @public
  */
-export declare type LicenseType = 'temporary' | 'persistent';
+export type LicenseType = 'temporary' | 'persistent';
 /**
  * Describes the FairPlay key system configuration.
  *
@@ -123,7 +123,7 @@ export interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration
  *
  * @public
  */
-export declare type WidevineKeySystemConfiguration = KeySystemConfiguration;
+export type WidevineKeySystemConfiguration = KeySystemConfiguration;
 /**
  * Describes the ClearKey key system configuration.
  *
@@ -229,4 +229,4 @@ export interface DRMConfiguration {
  *
  * @public
  */
-export declare type KeySystemId = 'widevine' | 'fairplay' | 'playready';
+export type KeySystemId = 'widevine' | 'fairplay' | 'playready';

package/lib/typescript/api/source/hls/HlsPlaybackConfiguration.d.ts

@@ -18,7 +18,7 @@
  *
  * @public
  */
-export declare type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
+export type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *

package/lib/typescript/api/track/MediaTrack.d.ts

@@ -1,6 +1,6 @@
 import type { Track } from './Track';
 import type { Quality } from './Quality';
-export declare type MediaTrackKind = 'main' | 'alternative';
+export type MediaTrackKind = 'main' | 'alternative';
 /**
  * Represents a media track (audio or video) of a media resource.
  *

package/lib/typescript/index.d.ts

@@ -1,3 +1,4 @@
 export * from './api/barrel';
 export { THEOplayerView } from './internal/THEOplayerView';
 export { ContentProtectionRegistry } from './internal/drm/ContentProtectionRegistry';
+export { MediaCache } from './internal/cache/MediaCache';

package/lib/typescript/internal/THEOplayerView.web.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
 import type { THEOplayerViewProps } from 'react-native-theoplayer';
-export declare function THEOplayerView(props: React.PropsWithChildren<THEOplayerViewProps>): JSX.Element;
+export declare function THEOplayerView(props: React.PropsWithChildren<THEOplayerViewProps>): React.JSX.Element;

package/lib/typescript/internal/adapter/THEOplayerWebAdapter.d.ts

@@ -1,7 +1,7 @@
 import { DefaultEventDispatcher } from './event/DefaultEventDispatcher';
 import type { AdsAPI, CastAPI, MediaTrack, NativeHandleType, PlayerConfiguration, PlayerEventMap, PlayerVersion, PreloadType, TextTrack, TextTrackStyle, THEOplayer } from 'react-native-theoplayer';
 import { AspectRatio, PresentationMode } from 'react-native-theoplayer';
-import * as THEOplayerWeb from 'theoplayer';
+import { ChromelessPlayer as NativeChromelessPlayer } from 'theoplayer';
 import type { ABRConfiguration, SourceDescription } from 'src/api/barrel';
 import type { PiPConfiguration } from 'src/api/pip/PiPConfiguration';
 import type { BackgroundAudioConfiguration } from 'src/api/backgroundAudio/BackgroundAudioConfiguration';
@@ -15,7 +15,7 @@ export declare class THEOplayerWebAdapter extends DefaultEventDispatcher<PlayerE
     private _targetVideoQuality;
     private _backgroundAudioConfiguration;
     private _pipConfiguration;
-    constructor(player: THEOplayerWeb.ChromelessPlayer, config?: PlayerConfiguration);
+    constructor(player: NativeChromelessPlayer, config?: PlayerConfiguration);
     get abr(): ABRConfiguration | undefined;
     get source(): SourceDescription | undefined;
     set source(source: SourceDescription | undefined);

package/lib/typescript/internal/adapter/WebEventForwarder.d.ts

@@ -1,9 +1,9 @@
-import type * as THEOplayer from 'theoplayer';
+import type { ChromelessPlayer } from 'theoplayer';
 import type { THEOplayerWebAdapter } from './THEOplayerWebAdapter';
 export declare class WebEventForwarder {
     private readonly _player;
     private readonly _facade;
-    constructor(player: THEOplayer.ChromelessPlayer, facade: THEOplayerWebAdapter);
+    constructor(player: ChromelessPlayer, facade: THEOplayerWebAdapter);
     private addEventListeners;
     unload(): void;
     private removeEventListeners;

package/lib/typescript/internal/adapter/ads/THEOplayerWebAdsAdapter.d.ts

@@ -1,9 +1,9 @@
 import type { Ad, AdBreak, AdDescription, AdsAPI, GoogleDAI } from 'react-native-theoplayer';
-import type * as THEOplayer from 'theoplayer';
+import type { ChromelessPlayer } from 'theoplayer';
 export declare class THEOplayerWebAdsAdapter implements AdsAPI {
     private readonly _player;
     private _dai;
-    constructor(player: THEOplayer.ChromelessPlayer);
+    constructor(player: ChromelessPlayer);
     currentAdBreak(): Promise<AdBreak>;
     currentAds(): Promise<Ad[]>;
     playing(): Promise<boolean>;

package/lib/typescript/internal/adapter/cast/THEOplayerWebCastAdapter.d.ts

@@ -1,8 +1,8 @@
 import type { Airplay, CastAPI, Chromecast } from 'react-native-theoplayer';
-import type * as THEOplayer from 'theoplayer';
+import type { ChromelessPlayer } from 'theoplayer';
 export declare class THEOplayerWebCastAdapter implements CastAPI {
     private readonly _player;
-    constructor(player: THEOplayer.ChromelessPlayer);
+    constructor(player: ChromelessPlayer);
     get casting(): boolean;
     get chromecast(): Chromecast | undefined;
     get airplay(): Airplay | undefined;

package/lib/typescript/internal/adapter/event/native/NativeCastEvent.d.ts

@@ -1,6 +1,6 @@
 import type { CastState, ChromecastError } from 'react-native-theoplayer';
 import type { CastEventType } from 'react-native-theoplayer';
-export declare type NativeCastEvent = NativeChromecastChangeEvent | NativeAirplayStateChangeEvent | NativeChromecastErrorEvent;
+export type NativeCastEvent = NativeChromecastChangeEvent | NativeAirplayStateChangeEvent | NativeChromecastErrorEvent;
 export interface NativeChromecastChangeEvent {
     readonly type: CastEventType.CHROMECAST_STATE_CHANGE;
     readonly state: CastState;

package/lib/typescript/internal/adapter/web/WebPresentationModeManager.d.ts

@@ -1,13 +1,13 @@
 import type { PlayerEventMap } from 'react-native-theoplayer';
 import { PresentationMode } from 'react-native-theoplayer';
-import type * as THEOplayerWeb from 'theoplayer';
+import type { ChromelessPlayer } from 'theoplayer';
 import type { DefaultEventDispatcher } from '../event/DefaultEventDispatcher';
 export declare class WebPresentationModeManager {
     private readonly _player;
     private _presentationMode;
     private _element;
     private _eventForwarder;
-    constructor(player: THEOplayerWeb.ChromelessPlayer, eventForwarder: DefaultEventDispatcher<PlayerEventMap>);
+    constructor(player: ChromelessPlayer, eventForwarder: DefaultEventDispatcher<PlayerEventMap>);
     get presentationMode(): PresentationMode;
     set presentationMode(presentationMode: PresentationMode);
     private prepareForPresentationModeChanges;

package/lib/typescript/internal/cache/MediaCache.d.ts

@@ -0,0 +1,25 @@
+import { CacheStatus, MediaCacheAPI } from '../../api/cache/MediaCacheAPI';
+import type { CachingTaskList } from '../../api/cache/CachingTaskList';
+import { DefaultEventDispatcher } from '../adapter/event/DefaultEventDispatcher';
+import type { CacheEventMap } from '../../api/cache/events/CacheEvent';
+import type { SourceDescription } from 'react-native-theoplayer';
+import type { CachingTaskParameters } from '../../api/cache/CachingTaskParameters';
+import type { CachingTask } from '../../api/cache/CachingTask';
+export declare class NativeMediaCache extends DefaultEventDispatcher<CacheEventMap> implements MediaCacheAPI {
+    private _emitter;
+    private _status;
+    private _tasks;
+    constructor();
+    createTask(source: SourceDescription, parameters: CachingTaskParameters): Promise<CachingTask>;
+    get status(): CacheStatus;
+    get tasks(): CachingTaskList;
+    private initialize;
+    private getInitialState;
+    private onCacheStatusChange;
+    private onAddCachingTaskEvent;
+    private onRemoveCachingTaskEvent;
+    private onCachingTaskProgressEvent;
+    private onCachingTaskStatusChangeEvent;
+    private taskById;
+}
+export declare const MediaCache: NativeMediaCache;

package/lib/typescript/internal/cache/MediaCache.web.d.ts

@@ -0,0 +1,16 @@
+import type { CacheStatus, MediaCacheAPI } from 'react-native-theoplayer';
+import type { CachingTaskList } from 'react-native-theoplayer';
+import { DefaultEventDispatcher } from '../adapter/event/DefaultEventDispatcher';
+import type { CacheEventMap } from 'react-native-theoplayer';
+import type { SourceDescription } from 'react-native-theoplayer';
+import type { CachingTaskParameters } from 'react-native-theoplayer';
+import type { CachingTask } from 'react-native-theoplayer';
+export declare class WebMediaCache extends DefaultEventDispatcher<CacheEventMap> implements MediaCacheAPI {
+    constructor();
+    private onAddTask;
+    private onRemoveTask;
+    createTask(source: SourceDescription, parameters: CachingTaskParameters): Promise<CachingTask>;
+    get status(): CacheStatus;
+    get tasks(): CachingTaskList;
+}
+export declare const MediaCache: WebMediaCache;

package/lib/typescript/internal/cache/NativeCachingTaskAdapter.d.ts

@@ -0,0 +1,33 @@
+import { DefaultEventDispatcher } from '../adapter/event/DefaultEventDispatcher';
+import type { CachingTask, CachingTaskEventMap, CachingTaskLicense, CachingTaskParameters, SourceDescription, TimeRange } from 'react-native-theoplayer';
+import type { CacheTaskStatus } from 'react-native-theoplayer';
+import { NativeCachingTaskParameters } from "./NativeCachingTaskParametersAdapter";
+export interface NativeCachingTask {
+    readonly id: string;
+    readonly status: CacheTaskStatus;
+    readonly source: SourceDescription;
+    readonly parameters: NativeCachingTaskParameters;
+    readonly duration: number;
+    readonly cached: TimeRange[];
+    readonly secondsCached: number;
+    readonly percentageCached: number;
+    readonly bytes: number;
+    readonly bytesCached: number;
+}
+export declare class NativeCachingTaskAdapter extends DefaultEventDispatcher<CachingTaskEventMap> implements CachingTask {
+    readonly bytes: number;
+    readonly bytesCached: number;
+    readonly cached: TimeRange[];
+    readonly duration: number;
+    readonly id: string;
+    readonly license: CachingTaskLicense;
+    readonly parameters: CachingTaskParameters;
+    readonly percentageCached: number;
+    readonly secondsCached: number;
+    readonly source: SourceDescription;
+    readonly status: CacheTaskStatus;
+    constructor(task: NativeCachingTask);
+    pause(): void;
+    remove(): void;
+    start(): void;
+}

package/lib/typescript/internal/cache/NativeCachingTaskParametersAdapter.d.ts

@@ -0,0 +1,11 @@
+import type { CachingTaskParameters } from 'react-native-theoplayer';
+import type { CachingPreferredTrackSelection } from "../../api/cache/CachingPreferredTrackSelection";
+export interface NativeCachingTaskParameters {
+    readonly amount: number | string;
+    readonly expirationDate: number | undefined;
+    readonly bandwidth: number | undefined;
+    readonly preferredTrackSelection: CachingPreferredTrackSelection | undefined;
+    readonly allowsCellularAccess: boolean | undefined;
+}
+export declare function fromNativeCachingTaskParameters(parameters: NativeCachingTaskParameters): CachingTaskParameters;
+export declare function toNativeCachingTaskParameters(parameters: CachingTaskParameters): NativeCachingTaskParameters;

package/lib/typescript/internal/cache/WebCachingTaskAdapter.d.ts

@@ -0,0 +1,25 @@
+import type { CachingTask, CachingTaskEventMap, CachingTaskLicense, CachingTaskParameters, SourceDescription, TimeRange } from 'react-native-theoplayer';
+import type { CachingTask as WebCachingTask } from 'theoplayer';
+import type { CacheTaskStatus } from 'react-native-theoplayer';
+import type { StringKeyOf } from '../../api/event/EventDispatcher';
+import type { EventListener } from '../../api/event/EventListener';
+export declare class WebCachingTaskAdapter implements CachingTask {
+    private webCachingTask;
+    constructor(webCachingTask: WebCachingTask);
+    get bytes(): number;
+    get bytesCached(): number;
+    get cached(): TimeRange[];
+    get duration(): number;
+    get id(): string;
+    get license(): CachingTaskLicense;
+    get parameters(): CachingTaskParameters;
+    get percentageCached(): number;
+    get secondsCached(): number;
+    get source(): SourceDescription;
+    get status(): CacheTaskStatus;
+    start(): void;
+    pause(): void;
+    remove(): void;
+    addEventListener<TType extends StringKeyOf<CachingTaskEventMap>>(type: TType[] | TType, listener: EventListener<CachingTaskEventMap[TType]>): void;
+    removeEventListener<TType extends StringKeyOf<CachingTaskEventMap>>(type: TType[] | TType, listener: EventListener<CachingTaskEventMap[TType]>): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-theoplayer",
-  "version": "2.16.1",
+  "version": "3.0.0-pre1",
   "description": "A THEOplayer video component for react-native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -48,22 +48,23 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^11.0.0",
     "@react-native-community/eslint-config": "^2.0.0",
-    "@release-it/conventional-changelog": "^5.1.1",
-    "@types/react": "^18.0.31",
-    "@types/react-native": "^0.71.5",
-    "commitlint": "^11.0.0",
-    "eslint": "^7.2.0",
-    "eslint-config-prettier": "^7.0.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "eslint-plugin-react-native": "^4.0.0",
+    "@release-it/conventional-changelog": "^7.0.2",
+    "@types/react": "^18.2.24",
+    "@types/react-native": "^0.72.3",
+    "commitlint": "^17.7.2",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^7.2.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-react-native": "^4.1.0",
     "husky": "^6.0.0",
-    "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
+    "pod-install": "^0.1.39",
+    "prettier": "^2.8.8",
     "react": "^18.2.0",
-    "react-native": "^0.71.5",
-    "react-native-builder-bob": "^0.18.0",
-    "release-it": "^15.5.0",
-    "typescript": "^4.1.3"
+    "react-native": "^0.72.5",
+    "react-native-builder-bob": "^0.18.3",
+    "release-it": "^16.2.1",
+    "theoplayer": "^6.1.0",
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
     "react": "*",

package/react-native-theoplayer.podspec

@@ -20,7 +20,7 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => "12.0", :tvos => "12.0" }
   s.source       = { :git => "https://www.theoplayer.com/.git", :tag => "#{s.version}" }
   
-  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift'
+  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift', 'ios/cache/*.swift'
   s.resources = ['ios/*.css']
   
   # ReactNative Dependency
@@ -36,14 +36,14 @@ Pod::Spec.new do |s|
     }
   else 
   	puts "Using THEOplayer-core SDK"
-    s.dependency "THEOplayerSDK-core", "~> 5.11"
+    s.dependency "THEOplayerSDK-core", "~> 6.0"
     if theofeatures.include?("GOOGLE_IMA") 
 	  puts "Adding THEOplayer-Integration-GoogleIMA"
-      s.dependency "THEOplayer-Integration-GoogleIMA", "~> 5.11"
+      s.dependency "THEOplayer-Integration-GoogleIMA", "~> 6.0"
     end
     if theofeatures.include?("CHROMECAST")
 	  puts "Adding THEOplayer-Integration-GoogleCast"
-      s.ios.dependency "THEOplayer-Integration-GoogleCast", "~> 5.11"
+      s.ios.dependency "THEOplayer-Integration-GoogleCast", "~> 6.0"
     end
     if theofeatures.include?("SIDELOADED_TEXTTRACKS") 
 	  puts "Adding THEOplayer-Connector-SideloadedSubtitle"

package/src/api/ads/GoogleImaConfiguration.ts

@@ -7,6 +7,7 @@ export interface GoogleImaConfiguration {
   /**
    * Whether the native (mobile) IMA implementation will be used.
    *
+   * @deprecated This property applies to native web-based player SDKs and will be removed.
    * @internal
    */
   useNativeIma: boolean;

package/src/api/barrel.ts

@@ -1,5 +1,6 @@
 export * from './abr/barrel';
 export * from './ads/barrel';
+export * from './cache/barrel';
 export * from './cast/barrel';
 export * from './pip/barrel';
 export * from './config/barrel';

package/src/api/cache/CachingPreferredTrackSelection.ts

@@ -0,0 +1,24 @@
+/**
+ * The preferred track selection.
+ *
+ * @public
+ */
+export interface CachingPreferredTrackSelection {
+  /**
+   * The list of language tags that indicates the preferred audio tracks to be cached.
+   *
+   * An empty array will result to picking the first available track.
+   */
+  audioTrackSelection: string[];
+
+  /**
+   * The expiration date of the cached data.
+   *
+   * @remarks
+   * <br/> - Must be a date in the future.
+   * <br/> - Data might be removed by the browser if it runs out of disk space.
+   *
+   * @defaultValue 30 minutes after starting the caching task.
+   */
+  textTrackSelection?: string[];
+}

package/src/api/cache/CachingTask.ts

@@ -0,0 +1,107 @@
+import type { SourceDescription } from 'react-native-theoplayer';
+import type { EventDispatcher } from '../event/EventDispatcher';
+import type { CachingTaskLicense } from './CachingTaskLicense';
+import type { CachingTaskParameters } from './CachingTaskParameters';
+import type { CachingTaskEventMap } from './events/CachingTaskEvent';
+import type { TimeRange } from '../timeranges/TimeRange';
+/**
+ * The cache task status, represented by a value from the following list:
+ * <br/> - `'idle'`: The task has been created, but has not started downloading content.
+ * <br/> - `'loading'`: The task is currently downloading the content.
+ * <br/> - `'done'`: The task has finished downloading all content.
+ * <br/> - `'error'`: The task has encountered an error while downloading or evicting content.
+ * <br/> - `'evicted'`: All data associated with the task has been removed because the task expired or the user invoked the {@link CachingTask.remove|remove} method.
+ *
+ * @public
+ */
+export enum CacheTaskStatus {
+  idle = 'idle',
+  loading = 'loading',
+  done = 'done',
+  error = 'error',
+  evicted = 'evicted',
+}
+
+/**
+ * Represents a caching task.
+ *
+ * @public
+ */
+export interface CachingTask extends EventDispatcher<CachingTaskEventMap> {
+  /**
+   * The generated identifier for the task.
+   */
+  readonly id: string;
+
+  /**
+   * The current status of the task.
+   */
+  readonly status: CacheTaskStatus;
+
+  /**
+   * The media source associated with the task.
+   */
+  readonly source: SourceDescription;
+
+  /**
+   * The configuration of the task.
+   */
+  readonly parameters: CachingTaskParameters;
+
+  /**
+   * The requested cached duration of the media, in seconds.
+   */
+  readonly duration: number;
+
+  /**
+   * The time ranges cached, in milliseconds.
+   */
+  readonly cached: TimeRange[];
+
+  /**
+   * The duration cached, in seconds.
+   */
+  readonly secondsCached: number;
+
+  /**
+   * The percentage cached, a value between 0 and 1.
+   */
+  readonly percentageCached: number;
+
+  /**
+   * The estimation of the amount this task will download and store, in bytes.
+   *
+   * @remarks
+   * <br/> - Available only on Web and Android.
+   * <br/> - Returns -1 if the estimate is not available yet.
+   */
+  readonly bytes: number;
+
+  /**
+   * The amount downloaded and stored, in bytes.
+   */
+  readonly bytesCached: number;
+
+  /**
+   * The API for license related queries and operations
+   */
+  readonly license: CachingTaskLicense;
+
+  /**
+   * Start caching the media.
+   */
+  start(): void;
+
+  /**
+   * Remove the cached media.
+   */
+  remove(): void;
+
+  /**
+   * Pause caching the media.
+   *
+   * @remarks
+   * <br/> - A paused task can be resumed with {@link CachingTask.start}.
+   */
+  pause(): void;
+}

package/src/api/cache/CachingTaskLicense.ts

@@ -0,0 +1,15 @@
+/**
+ * The {@link CachingTask}'s license API.
+ *
+ * @public
+ */
+import type { DRMConfiguration } from 'react-native-theoplayer';
+
+export interface CachingTaskLicense {
+  /**
+   * Renew all the licenses associated with this task.
+   *
+   * @param drmConfiguration - The DRM configuration used for license renewals. Defaults to the DRM configuration of the original sourceDescription when omitted.
+   */
+  renew(drmConfiguration?: DRMConfiguration): void;
+}