bitmovin-player-react-native 0.1.0 → 0.2.1

package/src/source.ts

@@ -1,3 +1,10 @@
+import { NativeModules } from 'react-native';
+import { Drm, DrmConfig } from './drm';
+import NativeInstance, { NativeInstanceConfig } from './nativeInstance';
+import { SideLoadedSubtitleTrack } from './subtitleTrack';
+
+const SourceModule = NativeModules.SourceModule;
+
 /**
  * Types of media that can be handled by the player.
  */
@@ -41,7 +48,7 @@ export enum LoadingState {
 /**
  * Represents a source configuration that be loaded into a player instance.
  */
-export interface SourceConfig {
+export interface SourceConfig extends NativeInstanceConfig {
   /**
    *  The url for this source configuration.
    */
@@ -63,33 +70,106 @@ export interface SourceConfig {
    * Useful, for example, for audio-only streams.
    */
   isPosterPersistent?: boolean;
+  /**
+   * The DRM config for the source.
+   */
+  drmConfig?: DrmConfig;
+  /**
+   * External subtitle tracks to be added into the player.
+   */
+  subtitleTracks?: SideLoadedSubtitleTrack[];
 }
 
 /**
  * Represents audio and video content that can be loaded into a player.
  */
-export interface Source {
+export class Source extends NativeInstance<SourceConfig> {
+  /**
+   * The native DRM config reference of this source.
+   */
+  drm?: Drm;
+  /**
+   * Whether the native `Source` object has been created.
+   */
+  isInitialized = false;
+  /**
+   * Whether the native `Source` object has been disposed.
+   */
+  isDestroyed = false;
+
+  /**
+   * Allocates the native `Source` instance and its resources natively.
+   */
+  initialize = () => {
+    if (!this.isInitialized) {
+      if (this.config?.drmConfig) {
+        this.drm = new Drm(this.config.drmConfig);
+        this.drm.initialize();
+        SourceModule.initWithDrmConfig(
+          this.nativeId,
+          this.drm.nativeId,
+          this.config
+        );
+      } else {
+        SourceModule.initWithConfig(this.nativeId, this.config);
+      }
+      this.isInitialized = true;
+    }
+  };
+
+  /**
+   * Destroys the native `Source` and releases all of its allocated resources.
+   */
+  destroy = () => {
+    if (!this.isDestroyed) {
+      SourceModule.destroy(this.nativeId);
+      this.drm?.destroy();
+      this.isDestroyed = true;
+    }
+  };
+
   /**
    * The duration of the source in seconds if it’s a VoD or `INFINITY` if it’s a live stream.
    * Default value is `0` if the duration is not available or not known.
    */
-  duration: number;
+  duration = async (): Promise<number> => {
+    return SourceModule.duration(this.nativeId);
+  };
+
   /**
    * Whether the source is currently active in a player (i.e. playing back or paused).
    * Only one source can be active in the same player instance at any time.
    */
-  isActive: boolean;
+  isActive = async (): Promise<boolean> => {
+    return SourceModule.isActive(this.nativeId);
+  };
+
   /**
    * Whether the source is currently attached to a player instance.
    */
-  isAttachedToPlayer: boolean;
+  isAttachedToPlayer = async (): Promise<boolean> => {
+    return SourceModule.isAttachedToPlayer(this.nativeId);
+  };
+
   /**
    * Metadata for the currently loaded source.
-   * Setting the metadata value for a source is not supported yet.
    */
-  metadata?: Record<string, any>;
+  metadata = async (): Promise<Record<string, any> | null> => {
+    return SourceModule.getMetadata(this.nativeId);
+  };
+
+  /**
+   * Set metadata for the currently loaded source.
+   * Setting the metadata to `null` clears the metadata object in native source.
+   */
+  setMetadata = (metadata: Record<string, any> | null): void => {
+    SourceModule.setMetadata(this.nativeId, metadata);
+  };
+
   /**
    * The current `LoadingState` of the source.
    */
-  loadingState?: LoadingState;
+  loadingState = async (): Promise<LoadingState> => {
+    return SourceModule.loadingState(this.nativeId);
+  };
 }

package/src/subtitleTrack.ts

@@ -0,0 +1,60 @@
+import { MakeRequired } from './utils';
+
+/**
+ * Supported subtitle/caption file formats.
+ */
+export enum SubtitleFormat {
+  CEA = 'cea',
+  TTML = 'ttml',
+  VTT = 'vtt',
+}
+
+/**
+ * Represents a custom subtitle track source that can be added to `SourceConfig.subtitleTracks`.
+ */
+export interface SubtitleTrack {
+  /**
+   * The URL to the timed file, e.g. WebVTT file.
+   */
+  url?: string;
+  /**
+   * The label for this track.
+   */
+  label?: string;
+  /**
+   * The unique identifier for this track. If no value is provided, a random UUIDv4 will be generated for it.
+   */
+  identifier?: string;
+  /**
+   * Specifies the file format to be used by this track.
+   */
+  format?: SubtitleFormat;
+  /**
+   * If set to true, this track would be considered as default. Default is `false`.
+   */
+  isDefault?: boolean;
+  /**
+   * Tells if a subtitle track is forced. If set to `true` it means that the player should automatically
+   * select and switch this subtitle according to the selected audio language. Forced subtitles do
+   * not appear in `Player.getAvailableSubtitles`.
+   *
+   * Default is `false`.
+   */
+  isForced?: boolean;
+  /**
+   * The IETF BCP 47 language tag associated with this track, e.g. `pt`, `en`, `es` etc.
+   */
+  language?: string;
+}
+
+/**
+ * Helper type that represents an entry in `SourceConfig.subtitleTracks` list.
+ *
+ * Since `SubtitleTrack` has all of its properties as optionals for total compatibility with
+ * values that may be sent from native code, this type serves as a reinforcer of what properties
+ * should be required during the registration of an external subtitle track from JS.
+ */
+export type SideLoadedSubtitleTrack = MakeRequired<
+  SubtitleTrack,
+  'url' | 'label' | 'language' | 'format'
+>;

package/src/utils.ts

@@ -0,0 +1,15 @@
+/**
+ * Utility type that maps the specified optional props from the target `Type` to be
+ * required props. Note all the other props stay unaffected.
+ *
+ * @example
+ * type MyType = {
+ *   a?: string;
+ *   b?: number;
+ *   c?: boolean;
+ * };
+ *
+ * type MyRequiredType = MakeRequired<MyType, 'a' | 'c'> // => { a: string; b?: number; c: boolean; }
+ */
+export type MakeRequired<Type, Key extends keyof Type> = Omit<Type, Key> &
+  Required<Pick<Type, Key>>;