react-native-theoplayer 1.8.2 → 2.0.0

package/src/api/THEOplayerView.ts

@@ -1,21 +1,6 @@
-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 { MediaTrackEvent, MediaTrackListEvent, TextTrackEvent, TextTrackListEvent } from './event/TrackEvent';
 import type { PlayerConfiguration } from './config/PlayerConfiguration';
-import type { ABRConfiguration } from './abr/ABRConfiguration';
-import type { AdEvent } from './event/AdEvent';
-import type { AdsAPI } from './ads/AdsAPI';
-import type { CastAPI } from './cast/CastAPI';
-import type { CastEvent } from './event/CastEvent';
+import type { THEOplayer } from './player/THEOplayer';
 
 export interface THEOplayerViewProps {
   /**
@@ -23,246 +8,18 @@ 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.
-   */
-  source: SourceDescription;
-
-  /**
-   * Used to set the player's paused state.
-   *
-   * @remarks
-   * <br/> - If paused is initially set to `true`, play-out will start once the source is set.
-   */
-  paused?: boolean;
-
-  /**
-   * 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;
-
-  /**
-   * Determines whether the player is currently playing in fullscreen.
-   */
-  fullscreen?: boolean;
-
-  /**
-   * Used to set the current selected text track by passing its `uid`, or `null` to select none.
-   */
-  selectedTextTrack?: number | null;
-
-  /**
-   * 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.
-   */
-  selectedAudioTrack?: number | null;
-
   /**
    * The style applied to the player view.
    */
   style?: StyleProp<ViewStyle>;
 
   /**
-   * Invoked before the player goes to fullscreen.
-   */
-  onFullscreenPlayerWillPresent?: () => void;
-
-  /**
-   * Invoked after the player went to fullscreen.
-   */
-  onFullscreenPlayerDidPresent?: () => void;
-
-  /**
-   * Invoked before the player returns from fullscreen.
-   */
-  onFullscreenPlayerWillDismiss?: () => void;
-
-  /**
-   * Invoked after the player returned from fullscreen.
-   */
-  onFullscreenPlayerDidDismiss?: () => void;
-
-  /**
-   * Invoked when the player's buffering state has changed.
-   *
-   * @remarks
-   * <br/> - The `isBuffering` value is typically coupled to showing/hiding a loading indicator.
-   *
-   * @param isBuffering A value that indicates whether the player is buffering.
-   */
-  onBufferingStateChange?: (isBuffering: boolean) => void;
-
-  /**
-   * Invoked when the player receives a new source description.
-   */
-  onSourceChange?: () => void;
-
-  /**
-   * Invoked when the player starts loading the manifest.
-   */
-  onLoadStart?: () => void;
-
-  /**
-   * Invoked when the player has determined the duration and dimensions of the
-   * media resource, and the text and media tracks are ready.
-   */
-  onLoadedMetadata?: (event: LoadedMetadataEvent) => void;
-
-  /**
-   * Invoked when the player can render the media data at the current playback position for the first time.
-   */
-  onLoadedData?: () => void;
-
-  /**
-   * Invoked when the player's readyState has changed.
-   */
-  onReadyStateChange?: (event: ReadyStateChangeEvent) => void;
-
-  /**
-   * Invoked when an error occurs.
-   */
-  onError?: (event: ErrorEvent) => void;
-
-  /**
-   * Invoked each time the player has loaded media data.
-   */
-  onProgress?: (event: ProgressEvent) => void;
-
-  /**
-   * Invoked when the player's internal paused state changes to `false`.
-   */
-  onPlay?: () => void;
-
-  /**
-   * Invoked when playback is ready to start after having been paused or delayed due to
-   * lack of media data.
-   */
-  onPlaying?: () => void;
-
-  /**
-   * Invoked when the player's internal paused state changes to `true`.
-   */
-  onPause?: () => void;
-
-  /**
-   * Invoked when a seek operation starts and the player is seeking a new position.
-   */
-  onSeeking?: () => void;
-
-  /**
-   * Invoked when a seek operation completed and the current playback position has changed.
-   */
-  onSeeked?: () => void;
-
-  /**
-   * Invoked when playback has stopped because the end of the media was reached or because
-   * no further data is available.
-   */
-  onEnded?: () => void;
-
-  /**
-   * Invoked each time the current playback position changed.
-   */
-  onTimeUpdate?: (event: TimeUpdateEvent) => void;
-
-  /**
-   * Invoked when the player's duration attribute has been updated.
-   */
-  onDurationChange?: (event: DurationChangeEvent) => void;
-
-  /**
-   * Invoked when a segment can not be found.
-   *
-   * @remarks
-   * <br/> - Only dispatched on DASH streams.
-   */
-  onSegmentNotFound?: (event: SegmentNotFoundEvent) => void;
-
-  /**
-   * Invoked when a text track list event occurs.
-   */
-  onTextTrackListEvent?: (event: TextTrackListEvent) => void;
-
-  /**
-   * Invoked when a text track event occurs.
-   */
-  onTextTrackEvent?: (event: TextTrackEvent) => void;
-
-  /**
-   * Invoked when a media track list event occurs.
-   */
-  onMediaTrackListEvent?: (event: MediaTrackListEvent) => void;
-
-  /**
-   * Invoked when a media track event occurs.
-   */
-  onMediaTrackEvent?: (event: MediaTrackEvent) => void;
-
-  /**
-   * Invoked when an ad event occurs.
-   */
-  onAdEvent?: (event: AdEvent) => void;
-
-  /**
-   * Invoked when a cast event occurs, either for Chromecast or Airplay.
-   */
-  onCastEvent?: (event: CastEvent) => void;
-}
-
-export interface THEOplayerViewComponent {
-  /**
-   * Seek to a new position.
-   *
-   * @param seekTime - new time, in milliseconds.
-   */
-  seek: (seekTime: number) => void;
-
-  /**
-   * The API for advertisements.
+   * Callback for when the internal THEOplayer is ready.
    */
-  ads: AdsAPI;
+  onPlayerReady?: (player: THEOplayer) => void;
 
   /**
-   * The API for casting devices.
+   * Callback for when the internal THEOplayer will be destroyed.
    */
-  cast: CastAPI;
+  onPlayerDestroy?: (player: THEOplayer) => void;
 }

package/src/api/backgroundAudio/BackgroundAudioConfiguration.ts

@@ -0,0 +1,23 @@
+/**
+ * Describes the configuration of the background audio feature.
+ *
+ * @public
+ */
+export interface BackgroundAudioConfiguration {
+  /**
+   * Whether background audio should be enabled when transitioning to background.
+   *
+   * @defaultValue `false`
+   */
+  readonly enabled?: boolean;
+
+  /**
+   * Whether Android's mediaPlaybackService is enabled.
+   *
+   * The mediaPlaybackService is a MediaBrowserService that provides notifications and background playback.
+   * It can be dynamically disabled if the host app already registers a MediaBrowserService that conflicts with this one.
+   *
+   * @defaultValue `true`
+   */
+  readonly mediaPlaybackServiceEnabled?: boolean;
+}

package/src/api/backgroundAudio/barrel.ts

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

package/src/api/barrel.ts

@@ -1,12 +1,16 @@
 export * from './abr/barrel';
 export * from './ads/barrel';
 export * from './cast/barrel';
+export * from './pip/barrel';
 export * from './config/barrel';
 export * from './error/barrel';
 export * from './event/barrel';
+export * from './media/barrel';
 export * from './drm/barrel';
 export * from './source/barrel';
 export * from './timeranges/barrel';
 export * from './track/barrel';
 export * from './utils/barrel';
 export * from './THEOplayerView';
+export * from './player/barrel';
+export * from './presentation/barrel';

package/src/api/cast/Airplay.ts

@@ -3,18 +3,18 @@
  *
  * @public
  */
-import type {CastState} from "./CastState";
+import type { CastState } from './CastState';
 
 export interface Airplay {
   /**
    * Whether the player is connected with an airplay device.
    */
-  casting(): Promise<boolean>;
+  readonly casting: boolean;
 
   /**
    * The state of the casting process.
    */
-  state(): Promise<CastState>;
+  readonly state: CastState;
 
   /**
    * Start a casting session with the player's source.

package/src/api/cast/CastAPI.ts

@@ -1,16 +1,15 @@
-import type {Airplay} from "./Airplay";
-import type {Chromecast} from "./Chromecast";
+import type { Airplay } from './Airplay';
+import type { Chromecast } from './Chromecast';
 
 /**
  * The API for casting.
  */
 
-
 export interface CastAPI {
   /**
    * Whether the player is connected with a casting device.
    */
-  casting(): Promise<boolean>;
+  readonly casting: boolean;
 
   /**
    * The Chromecast API.

package/src/api/cast/CastState.ts

@@ -7,4 +7,9 @@
  *
  * @public
  */
-export type CastState = 'unavailable' | 'available' | 'connecting' | 'connected';
+export enum CastState {
+    unavailable = "unavailable",
+    available = "available",
+    connecting = "connecting",
+    connected = "connected",
+}

package/src/api/cast/Chromecast.ts

@@ -3,18 +3,18 @@
  *
  * @public
  */
-import type {CastState} from "./CastState";
+import type { CastState } from './CastState';
 
 export interface Chromecast {
   /**
    * Whether the player is connected with a chromecast device.
    */
-  casting(): Promise<boolean>;
+  readonly casting: boolean;
 
   /**
    * The state of the casting process.
    */
-  state(): Promise<CastState>;
+  readonly state: CastState;
 
   /**
    * Start a casting session with the player's source.

package/src/api/config/PlayerConfiguration.ts

@@ -1,7 +1,30 @@
 import type { AdsConfiguration } from '../ads/AdsConfiguration';
 import type { CastConfiguration } from '../cast/CastConfiguration';
+import type { MediaControlConfiguration } from '../media/MediaControlConfiguration';
 
 export interface PlayerConfiguration {
+  /**
+   * The directory in which the THEOplayer library worker files are located.
+   * These worker files are THEOplayer.transmux.*
+   *
+   * @remarks
+   * <br/> - This parameter is required when using a HLS source and has no default.
+   *
+   * @example
+   * `'/lib/theoplayer/'`
+   */
+  libraryLocation?: string;
+
+  /**
+   * The muted autoplay policy for web.
+   *
+   * @remarks
+   * <br/> - The muted autoplay policy is impacted by this property and {@link SourceConfiguration.mutedAutoplay}.
+   *
+   * @defaultValue `'none'`.
+   */
+  mutedAutoplay?: MutedAutoplayConfiguration;
+
   /**
    * The ads configuration for the player.
    */
@@ -12,6 +35,11 @@ export interface PlayerConfiguration {
    */
   cast?: CastConfiguration;
 
+  /**
+   * The configuration of media controls and media sessions across platforms.
+   */
+  mediaControl?: MediaControlConfiguration;
+
   /**
    * The license for the player
    */
@@ -27,3 +55,13 @@ export interface PlayerConfiguration {
    */
   readonly chromeless?: boolean;
 }
+
+/**
+ * The muted autoplay policy of a player for web.
+ * <br/> - `'none'`: Disallow muted autoplay. If the player is requested to autoplay while unmuted, and the platform does not support unmuted autoplay, the player will not start playback.
+ * <br/> - `'all'`: Allow muted autoplay. If the player is requested to autoplay while unmuted, and the platform supports muted autoplay, the player will start muted playback.
+ * <br/> - `'content'`: Allow muted autoplay only for the main content. Disallow muted autoplay for e.g. advertisements. (Not yet supported.)
+ *
+ * @public
+ */
+export type MutedAutoplayConfiguration = 'none' | 'all' | 'content';

package/src/api/event/AdEvent.ts

@@ -1,10 +1,11 @@
-import type { Ad, AdBreak } from 'react-native-theoplayer';
+import type { Ad, AdBreak, PlayerEventType } from 'react-native-theoplayer';
+import type { Event } from './Event';
 
-export interface AdEvent {
+export interface AdEvent extends Event<PlayerEventType.AD_EVENT> {
   /**
    * Type of ad event.
    */
-  type: AdEventType;
+  subType: AdEventType;
 
   /**
    * The ad or adbreak for which the event was dispatched.
@@ -12,106 +13,99 @@ export interface AdEvent {
   ad: Ad | AdBreak;
 }
 
-export const AdEventNames = [
+export enum AdEventType {
   /**
    * Dispatched when an ad break is added.
    */
-  'addadbreak',
+  ADD_AD_BREAK = 'addadbreak',
 
   /**
    * Dispatched when an ad break is removed.
    */
-  'removeadbreak',
+  REMOVE_AD_BREAK = 'removeadbreak',
 
   /**
    * Dispatched when an ad is loaded.
    */
-  'adloaded',
+  AD_LOADED = 'adloaded',
 
   /**
    * Dispatched when an ad break begins.
    */
-  'adbreakbegin',
+  AD_BREAK_BEGIN = 'adbreakbegin',
 
   /**
    * Dispatched when an ad break ends.
    */
-  'adbreakend',
+  AD_BREAK_END = 'adbreakend',
 
   /**
    * Dispatched when an ad break changes.
    */
-  'adbreakchange',
+  AD_BREAK_CHANGE = 'adbreakchange',
 
   /**
    * Dispatched when an ad break is updated.
    */
-  'updateadbreak',
+  UPDATE_AD_BREAK = 'updateadbreak',
 
   /**
    * Dispatched when an ad is added.
    */
-  'addad',
+  ADD_AD = 'addad',
 
   /**
    * Dispatched when an ad begins.
    */
-  'adbegin',
+  AD_BEGIN = 'adbegin',
 
   /**
    * Dispatched when an ad ends.
    */
-  'adend',
+  AD_END = 'adend',
 
   /**
    * Dispatched when an ad is updated.
    */
-  'updatead',
-
-  /**
-   * Dispatched when an ad is loaded.
-   */
-  'adloaded',
+  UPDATE_AD = 'updatead',
 
   /**
    * Dispatched when an ad reaches the first quartile.
    */
-  'adfirstquartile',
+  AD_FIRST_QUARTILE = 'adfirstquartile',
 
   /**
    * Dispatched when an ad reaches the mid point.
    */
-  'admidpoint',
+  AD_MIDPOINT = 'admidpoint',
 
   /**
    * Dispatched when an ad reaches the third quartile.
    */
-  'adthirdquartile',
+  AD_THIRD_QUARTILE = 'adthirdquartile',
 
   /**
    * Dispatched when an ad is skipped.
    */
-  'adskip',
+  AD_SKIP = 'adskip',
 
   /**
    * Dispatched when an ad counts as an impression.
    */
-  'adimpression',
+  AD_IMPRESSION = 'adimpression',
 
   /**
    * Dispatched when an ad error occurs.
    */
-  'aderror',
+  AD_ERROR = 'aderror',
 
   /**
    * Dispatched when an ads list is loaded.
    */
-  'admetadata',
+  AD_METADATA = 'admetadata',
 
   /**
    * Dispatched when the ad has stalled playback to buffer.
    */
-  'adbuffering'
-] as const;
-
-export type AdEventType = typeof AdEventNames[number];
+  AD_BUFFERING = 'adbuffering',
+}

package/src/api/event/CastEvent.ts

@@ -1,45 +1,39 @@
-import type { CastState, ChromecastError } from 'react-native-theoplayer';
+import type { CastState, ChromecastError, PlayerEventType } from 'react-native-theoplayer';
+import type { Event } from './Event';
 
-export const CastEventNames = [
+export enum CastEventType {
   /**
    * Dispatched when the ChromeCast state was changed.
    */
-  'chromecaststatechange',
+  CHROMECAST_STATE_CHANGE = 'chromecaststatechange',
 
   /**
    * Dispatched when the Airplay state was changed.
    */
-  'airplaystatechange',
+  AIRPLAY_STATE_CHANGE = 'airplaystatechange',
 
   /**
    * Dispatched when an error occurred when using Chromecast.
    */
-  'chromecasterror',
-] as const;
-
-export type CastEventType = typeof CastEventNames[number];
-
-export interface CastEvent {
-  /**
-   * Type of ad event.
-   */
-  readonly type: CastEventType;
+  CHROMECAST_ERROR = 'chromecasterror',
 }
 
-export interface ChromecastChangeEvent extends CastEvent {
-  readonly type: 'chromecaststatechange';
+export type CastEvent = ChromecastChangeEvent | AirplayStateChangeEvent | ChromecastErrorEvent;
+
+export interface ChromecastChangeEvent extends Event<PlayerEventType.CAST_EVENT> {
+  readonly subType: CastEventType.CHROMECAST_STATE_CHANGE;
 
   readonly state: CastState;
 }
 
-export interface AirplayStateChangeEvent extends CastEvent {
-  readonly type: 'airplaystatechange';
+export interface AirplayStateChangeEvent extends Event<PlayerEventType.CAST_EVENT> {
+  readonly subType: CastEventType.AIRPLAY_STATE_CHANGE;
 
   readonly state: CastState;
 }
 
-export interface ChromecastErrorEvent extends CastEvent {
-  readonly type: 'chromecasterror';
+export interface ChromecastErrorEvent extends Event<PlayerEventType.CAST_EVENT> {
+  readonly subType: CastEventType.CHROMECAST_ERROR;
 
   readonly error: ChromecastError;
 }

package/src/api/event/Event.ts

@@ -0,0 +1,16 @@
+/**
+ * Fired when an event occurs.
+ *
+ * @public
+ */
+export interface Event<TType extends string = string> {
+  /**
+   * The type of the event.
+   */
+  type: TType;
+
+  /**
+   * The creation date of the event.
+   */
+  date: Date;
+}