react-native-theoplayer 1.8.2 → 2.0.0

package/src/api/player/THEOplayer.ts

@@ -0,0 +1,185 @@
+import type { EventDispatcher } from '../event/EventDispatcher';
+import type { PlayerEventMap } from './PlayerEventMap';
+import type { ABRConfiguration } from '../abr/ABRConfiguration';
+import type { SourceDescription } from '../source/SourceDescription';
+import type { AdsAPI } from '../ads/AdsAPI';
+import type { CastAPI } from '../cast/CastAPI';
+import type { MediaTrack } from '../track/MediaTrack';
+import type { TextTrack } from '../track/TextTrack';
+import type { TimeRange } from '../timeranges/TimeRange';
+import type { TextTrackStyle } from '../track/TextTrackStyle';
+import type { PresentationMode } from '../presentation/PresentationMode';
+import type { PiPConfiguration } from '../pip/PiPConfiguration';
+import type { BackgroundAudioConfiguration } from '../backgroundAudio/BackgroundAudioConfiguration';
+
+export type PreloadType = 'none' | 'metadata' | 'auto' | '';
+
+export type NativeHandleType = unknown;
+
+/**
+ * The THEOplayer API.
+ */
+export interface THEOplayer extends EventDispatcher<PlayerEventMap> {
+  /**
+   * The player's adaptive bitrate (ABR) configuration.
+   *
+   * @remarks
+   * <br/> - This property is supported on Android & Web platforms only.
+   */
+  readonly abr: ABRConfiguration | undefined;
+
+  /**
+   * A source description that determines the current media resource.
+   */
+  source: SourceDescription | undefined;
+
+  /**
+   * Start or resume playback.
+   */
+  play(): void;
+
+  /**
+   * Pause playback.
+   */
+  pause(): void;
+
+  /**
+   * Whether the player is paused.
+   */
+  readonly paused: boolean;
+
+  /**
+   * Whether the player should immediately start playback after source change.
+   */
+  autoplay: boolean;
+
+  /**
+   * The preload setting of the player.
+   */
+  preload: PreloadType;
+
+  /**
+   * Returns a list of TimeRanges that represents the ranges of the media resource that are seekable by the player.
+   */
+  seekable: TimeRange[];
+
+  /**
+   * Returns a list of TimeRanges that represents the ranges of the media resource that are buffered by the player.
+   */
+  buffered: TimeRange[];
+
+  /**
+   * Used to set the playback rate of the media.
+   *
+   * @example
+   * <br/> - `playbackRate = 0.70` will slow down the playback rate of the media by 30%.
+   * <br/> - `playbackRate = 1.25` will speed up the playback rate of the media by 25%.
+   *
+   * @remarks
+   * <br/> - Playback rate is represented by a number where `1` is default playback speed.
+   * <br/> - Playback rate must be a positive number.
+   * <br/> - It is recommended that you limit the range to between 0.5 and 4.
+   */
+  playbackRate: number;
+
+  /**
+   * Used to set the volume of the audio.
+   *
+   * @remarks
+   * <br/> - Volume is represented by a floating point number between `0.0` and `1.0`.
+   */
+  volume: number;
+
+  /**
+   * Determines whether audio is muted.
+   */
+  muted: boolean;
+
+  /**
+   * Whether the player is seeking.
+   */
+  readonly seeking: boolean;
+
+  /**
+   * The PresentationMode of the player. Can be switched to: `picture-in-picture`, `fullscreen` or `inline`
+   */
+  presentationMode: PresentationMode;
+
+  /**
+   * List of audio tracks of the current source.
+   */
+  audioTracks: MediaTrack[];
+
+  /**
+   * List of video tracks of the current source.
+   */
+  videoTracks: MediaTrack[];
+
+  /**
+   * List of text tracks of the current source.
+   */
+  textTracks: TextTrack[];
+
+  /**
+   * Used to set the current selected text track by passing its `uid`, or `undefined` to select none.
+   */
+  selectedTextTrack: number | undefined;
+
+  /**
+   * The text track style API.
+   *
+   * @remarks
+   * Only available for Web.
+   */
+  readonly textTrackStyle: TextTrackStyle;
+
+  /**
+   * Used to set the current selected video track by passing its `uid`, or `undefined` to select none.
+   */
+  selectedVideoTrack: number | undefined;
+
+  /**
+   * Used to set the current selected video quality by passing its `uid`, or `undefined` to select none.
+   */
+  targetVideoQuality: number | number[] | undefined;
+
+  /**
+   * Used to set the current selected audio track by passing its `uid`, or `undefined` to select none.
+   */
+  selectedAudioTrack: number | undefined;
+
+  /**
+   * The current playback position of the media, in milliseconds.
+   */
+  currentTime: number;
+
+  /**
+   * The active configuration for PiP.
+   */
+  pipConfiguration: PiPConfiguration;
+
+  /**
+   * The active configuration for PiP.
+   */
+  backgroundAudioConfiguration: BackgroundAudioConfiguration;
+
+  /**
+   * The duration of the media, in milliseconds.
+   */
+  readonly duration: number;
+
+  /**
+   * The API for advertisements.
+   */
+  readonly ads: AdsAPI;
+
+  /**
+   * The API for casting devices.
+   */
+  readonly cast: CastAPI;
+
+  /**
+   * Native player handle.
+   */
+  readonly nativeHandle: NativeHandleType;
+}

package/src/api/player/barrel.ts

@@ -0,0 +1,2 @@
+export * from './THEOplayer';
+export * from './PlayerEventMap';

package/src/api/presentation/PresentationMode.ts

@@ -0,0 +1,14 @@
+/**
+ * The presentation mode of the player, represented by a value from the following list:
+ * <br/> - `'inline'`: The player is shown in its original location on the page.
+ * <br/> - `'fullscreen'`: The player fills the entire screen.
+ * <br/> - `'picture-in-picture'`: The player is shown on top of the page (see {@link PiPConfiguration} for more options).
+ *
+ * @public
+ */
+
+export enum PresentationMode {
+  fullscreen = 'fullscreen',
+  inline = 'inline',
+  pip = 'picture-in-picture',
+}

package/src/api/presentation/barrel.ts

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

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

@@ -98,4 +98,9 @@ export interface AdDescription {
  *
  * @public
  */
-export type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';
+export enum AdIntegrationKind {
+  freewheel = 'freewheel',
+  google_ima = 'google-ima',
+  spotx = 'spotx',
+  theo = 'theo',
+}

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

@@ -1,4 +1,4 @@
-import type { AdDescription } from "./Ads";
+import type { AdDescription, AdIntegrationKind } from "./Ads";
 
 /**
  * The possible ad unit types, represented by a value from the following list:
@@ -40,7 +40,7 @@ export interface FreeWheelAdDescription extends AdDescription {
   /**
    * The integration of this ad break.
    */
-  integration: 'freewheel';
+  integration: AdIntegrationKind.freewheel;
 
   /**
    * The FreeWheel ad server URL.

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

@@ -1,4 +1,4 @@
-import type { AdDescription, AdSource } from "./Ads";
+import type { AdDescription, AdIntegrationKind, AdSource } from "./Ads";
 
 /**
  * Describes a Google IMA ad break request.
@@ -9,7 +9,7 @@ export interface IMAAdDescription extends AdDescription {
   /**
    * The integration of this ad break.
    */
-  integration: 'google-ima';
+  integration: AdIntegrationKind.google_ima;
 
   /**
    * The source of the ad

package/src/api/track/MediaTrack.ts

@@ -45,23 +45,14 @@ export interface MediaTrack extends Track {
   readonly language: string;
 
   /**
-   * The uid of the active quality of the media track, i.e. the quality that is currently being played.
+   * The active quality of the media track, i.e. the quality that is currently being played.
    */
-  readonly activeQuality: number | undefined;
+  readonly activeQuality: Quality | undefined;
 
   /**
    * The qualities of the media track.
    */
   readonly qualities: Quality[];
-
-  /**
-   * One or more desired uids of qualities of the media track.
-   *
-   * @remarks
-   * <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.
-   */
-  readonly targetQuality: number | number[] | undefined;
 }
 
 export function findMediaTrackByUid(mediaTracks: MediaTrack[], uid: number | undefined): MediaTrack | undefined {

package/src/api/track/TextTrack.ts

@@ -1,11 +1,28 @@
 import type { Track } from './Track';
 import type { TextTrackCue } from './TextTrackCue';
 
-export type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'cea608' | '';
+export enum TextTrackType {
+  cea608 = 'cea608',
+  id3 = 'id3',
+  srt = 'srt',
+  ttml = 'ttml',
+  webvtt = 'webvtt',
+}
 
-export type TextTrackKind = 'subtitles' | 'captions' | 'descriptions' | 'chapters' | 'metadata' | 'thumbnails';
+export enum TextTrackKind {
+  captions = 'captions',
+  chapters = 'chapters',
+  descriptions = 'descriptions',
+  metadata = 'metadata',
+  subtitles = 'subtitles',
+  thumbnails = 'thumbnails',
+}
 
-export type TextTrackMode = 'disabled' | 'showing';
+export enum TextTrackMode {
+  disabled = 'disabled',
+  showing = 'showing',
+  hidden = 'hidden',
+}
 
 export interface TextTrack extends Track {
   /**
@@ -100,18 +117,6 @@ export function isThumbnailTrack(textTrack: TextTrack | undefined): boolean {
   return !!textTrack && (textTrack.kind === 'thumbnails' || (textTrack.kind === 'metadata' && textTrack.label === 'thumbnails'));
 }
 
-export function hasTextTrack(textTrackList: TextTrack[], textTrack: TextTrack): boolean {
-  return !!(textTrackList && textTrack && textTrackList.find((t) => t.uid === textTrack.uid));
-}
-
-export function removeTextTrack(textTrackList: TextTrack[], textTrack: TextTrack): TextTrack[] {
-  return textTrackList && textTrack ? textTrackList.filter((t) => t.uid !== textTrack.uid) : textTrackList;
-}
-
-export function addTextTrack(textTrackList: TextTrack[], textTrack: TextTrack): TextTrack[] {
-  return textTrackList && textTrack && !hasTextTrack(textTrackList, textTrack) ? [...textTrackList, textTrack] : textTrackList;
-}
-
 export function hasTextTrackCue(textTrack: TextTrack, cue: TextTrackCue): boolean {
   return !!(textTrack.cues && cue && textTrack.cues.find((c) => cue.uid === c.uid));
 }

package/src/api/track/TextTrackStyle.ts

@@ -0,0 +1,77 @@
+/**
+ * The text track style API.
+ *
+ * @public
+ */
+export interface TextTrackStyle {
+  /**
+   * The font family for the text track.
+   */
+  fontFamily: string | undefined;
+
+  /**
+   * The font color for the text track.
+   *
+   * @example
+   * <br/> - `red` will set the color of the text to red.
+   * <br/> - `#ff0000` will set the color of the text to red.
+   * <br/> - `rgba(255,0,0,0.5)` will set the color of the text to red, with 50% opacity.
+   */
+  fontColor: string | undefined;
+
+  /**
+   * The font size for the text track.
+   *
+   * @remarks
+   * Can be a percentage value such as '50%', '75%', '100%', '150%' or '200%'.
+   */
+  fontSize: string | undefined;
+
+  /**
+   * The background color for the text track.
+   *
+   * @remarks
+   * This targets the area directly behind the text.
+   *
+   * @example
+   * <br/> - `red` will set the background color of the text track to red.
+   * <br/> - `#ff0000` will set the background color of the text track to red.
+   * <br/> - `rgba(255,0,0,0.5)` will set the background color of the text track to red, with 50% opacity.
+   */
+  backgroundColor: string | undefined;
+
+  /**
+   * The window color for the text track.
+   *
+   * @remarks
+   * This targets the area covering the full width of the text track.
+   *
+   * @example
+   * <br/> - `red` will set the background color of the window of the text track to red.
+   * <br/> - `#ff0000` will set the background color of the window of the text track to red.
+   * <br/> - `rgba(255,0,0,0.5)` will set the background color of the window of the text track to red, with 50% opacity.
+   */
+  windowColor: string | undefined;
+
+  /**
+   * The edge style of the text, represented by a value from the following list:
+   * <br/> - `'none'`
+   * <br/> - `'dropshadow'`
+   * <br/> - `'raised'`
+   * <br/> - `'depressed'`
+   * <br/> - `'uniform`
+   */
+  edgeStyle: EdgeStyle | undefined;
+}
+
+/**
+ * The style of the edge, represented by a value from the following list:
+ * <br/> - `'none'`
+ * <br/> - `'dropshadow'`
+ * <br/> - `'raised'`
+ * <br/> - `'depressed'`
+ * <br/> - `'uniform'`
+ *
+ * @public
+ */
+export type EdgeStyle = 'none' | 'dropshadow' | 'raised' | 'depressed' | 'uniform';

package/src/api/track/Track.ts

@@ -45,3 +45,15 @@ export interface Track {
    */
   readonly language: string;
 }
+
+export function hasTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): boolean {
+  return !!(trackList && track && trackList.find((t) => t.uid === track.uid));
+}
+
+export function removeTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): TTrack[] {
+  return trackList && track ? trackList.filter((t) => t.uid !== track.uid) : trackList;
+}
+
+export function addTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): TTrack[] {
+  return trackList && track && !hasTrack(trackList, track) ? [...trackList, track] : trackList;
+}

package/src/api/track/barrel.ts

@@ -3,3 +3,4 @@ export * from './Quality';
 export * from './TextTrack';
 export * from './TextTrackCue';
 export * from './Track';
+export * from './TextTrackStyle';

package/src/index.tsx

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