bitmovin-player-react-native 0.44.1-alpha.0 → 1.0.0-alpha.0

package/src/player.ts

@@ -1,4 +1,5 @@
-import { NativeModules, Platform } from 'react-native';
+import { Platform } from 'react-native';
+import PlayerModule from './modules/PlayerModule';
 import NativeInstance from './nativeInstance';
 import { Source, SourceConfig } from './source';
 import { AudioTrack } from './audioTrack';
@@ -13,8 +14,6 @@ import { VideoQuality } from './media';
 import { Network } from './network';
 import { DecoderConfigBridge } from './decoder';
 
-const PlayerModule = NativeModules.PlayerModule;
-
 /**
  * Loads, controls and renders audio and video content represented through {@link Source}s. A player
  * instance can be created via the {@link usePlayer} hook and will idle until one or more {@link Source}s are
@@ -54,25 +53,25 @@ export class Player extends NativeInstance<PlayerConfig> {
   /**
    * Allocates the native `Player` instance and its resources natively.
    */
-  initialize = () => {
+  initialize = async (): Promise<void> => {
     if (!this.isInitialized) {
       if (this.config?.networkConfig) {
         this.network = new Network(this.config.networkConfig);
-        this.network.initialize();
+        await this.network.initialize();
       }
-      this.maybeInitDecoderConfig();
+      await this.maybeInitDecoderConfig();
       const analyticsConfig = this.config?.analyticsConfig;
       if (analyticsConfig) {
-        PlayerModule.initWithAnalyticsConfig(
+        await PlayerModule.initializeWithAnalyticsConfig(
           this.nativeId,
+          analyticsConfig,
           this.config,
           this.network?.nativeId,
-          this.decoderConfig?.nativeId,
-          analyticsConfig
+          this.decoderConfig?.nativeId
         );
         this.analytics = new AnalyticsApi(this.nativeId);
       } else {
-        PlayerModule.initWithConfig(
+        await PlayerModule.initializeWithConfig(
           this.nativeId,
           this.config,
           this.network?.nativeId,
@@ -82,6 +81,7 @@ export class Player extends NativeInstance<PlayerConfig> {
 
       this.isInitialized = true;
     }
+    return Promise.resolve();
   };
 
   /**
@@ -122,9 +122,10 @@ export class Player extends NativeInstance<PlayerConfig> {
    * Loads the given {@link Source} into the player.
    */
   loadSource = (source: Source) => {
-    source.initialize();
     this.source = source;
-    PlayerModule.loadSource(this.nativeId, source.nativeId);
+    source.initialize().then(() => {
+      PlayerModule.loadSource(this.nativeId, source.nativeId);
+    });
   };
 
   /**
@@ -201,7 +202,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * @returns The player's current volume level.
    */
   getVolume = async (): Promise<number> => {
-    return PlayerModule.getVolume(this.nativeId);
+    return (await PlayerModule.getVolume(this.nativeId)) ?? 0;
   };
 
   /**
@@ -217,42 +218,42 @@ export class Player extends NativeInstance<PlayerConfig> {
   getCurrentTime = async (
     mode: 'relative' | 'absolute' = 'absolute'
   ): Promise<number> => {
-    return PlayerModule.currentTime(this.nativeId, mode);
+    return (await PlayerModule.currentTime(this.nativeId, mode)) ?? 0;
   };
 
   /**
    * @returns The total duration in seconds of the current video or INFINITY if it’s a live stream.
    */
   getDuration = async (): Promise<number> => {
-    return PlayerModule.duration(this.nativeId);
+    return (await PlayerModule.duration(this.nativeId)) ?? 0;
   };
 
   /**
    * @returns `true` if the player is muted.
    */
   isMuted = async (): Promise<boolean> => {
-    return PlayerModule.isMuted(this.nativeId);
+    return (await PlayerModule.isMuted(this.nativeId)) ?? false;
   };
 
   /**
    * @returns `true` if the player is currently playing, i.e. has started and is not paused.
    */
   isPlaying = async (): Promise<boolean> => {
-    return PlayerModule.isPlaying(this.nativeId);
+    return (await PlayerModule.isPlaying(this.nativeId)) ?? false;
   };
 
   /**
    * @returns `true` if the player has started playback but it's currently paused.
    */
   isPaused = async (): Promise<boolean> => {
-    return PlayerModule.isPaused(this.nativeId);
+    return (await PlayerModule.isPaused(this.nativeId)) ?? false;
   };
 
   /**
    * @returns `true` if the displayed video is a live stream.
    */
   isLive = async (): Promise<boolean> => {
-    return PlayerModule.isLive(this.nativeId);
+    return (await PlayerModule.isLive(this.nativeId)) ?? false;
   };
 
   /**
@@ -266,7 +267,7 @@ export class Player extends NativeInstance<PlayerConfig> {
       );
       return false;
     }
-    return PlayerModule.isAirPlayActive(this.nativeId);
+    return (await PlayerModule.isAirPlayActive(this.nativeId)) ?? false;
   };
 
   /**
@@ -280,7 +281,7 @@ export class Player extends NativeInstance<PlayerConfig> {
       );
       return false;
     }
-    return PlayerModule.isAirPlayAvailable(this.nativeId);
+    return (await PlayerModule.isAirPlayAvailable(this.nativeId)) ?? false;
   };
 
   /**
@@ -326,7 +327,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * @param trackIdentifier - The {@link SubtitleTrack.identifier} to be set.
    */
   setSubtitleTrack = async (trackIdentifier?: string): Promise<void> => {
-    return PlayerModule.setSubtitleTrack(this.nativeId, trackIdentifier);
+    return PlayerModule.setSubtitleTrack(this.nativeId, trackIdentifier ?? '');
   };
 
   /**
@@ -335,7 +336,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    *
    * @param adItem - Ad to be scheduled for playback.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   scheduleAd = (adItem: AdItem) => {
     PlayerModule.scheduleAd(this.nativeId, adItem);
@@ -345,7 +346,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * Skips the current ad.
    * Has no effect if the current ad is not skippable or if no ad is being played back.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   skipAd = () => {
     PlayerModule.skipAd(this.nativeId);
@@ -353,10 +354,10 @@ export class Player extends NativeInstance<PlayerConfig> {
 
   /**
    * @returns `true` while an ad is being played back or when main content playback has been paused for ad playback.
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   isAd = async (): Promise<boolean> => {
-    return PlayerModule.isAd(this.nativeId);
+    return (await PlayerModule.isAd(this.nativeId)) ?? false;
   };
 
   /**
@@ -364,7 +365,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * live stream or no sources are loaded.
    */
   getTimeShift = async (): Promise<number> => {
-    return PlayerModule.getTimeShift(this.nativeId);
+    return (await PlayerModule.getTimeShift(this.nativeId)) ?? 0;
   };
 
   /**
@@ -372,7 +373,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * {@link Source} is not a live stream or no sources are loaded.
    */
   getMaxTimeShift = async (): Promise<number> => {
-    return PlayerModule.getMaxTimeShift(this.nativeId);
+    return (await PlayerModule.getMaxTimeShift(this.nativeId)) ?? 0;
   };
 
   /**
@@ -403,26 +404,26 @@ export class Player extends NativeInstance<PlayerConfig> {
    * Whether casting to a cast-compatible remote device is available. {@link CastAvailableEvent} signals when
    * casting becomes available.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   isCastAvailable = async (): Promise<boolean> => {
-    return PlayerModule.isCastAvailable(this.nativeId);
+    return (await PlayerModule.isCastAvailable(this.nativeId)) ?? false;
   };
 
   /**
    * Whether video is currently being casted to a remote device and not played locally.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   isCasting = async (): Promise<boolean> => {
-    return PlayerModule.isCasting(this.nativeId);
+    return (await PlayerModule.isCasting(this.nativeId)) ?? false;
   };
 
   /**
    * Initiates casting the current video to a cast-compatible remote device. The user has to choose to which device it
    * should be sent.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   castVideo = () => {
     PlayerModule.castVideo(this.nativeId);
@@ -431,7 +432,7 @@ export class Player extends NativeInstance<PlayerConfig> {
   /**
    * Stops casting the current video. Has no effect if {@link Player.isCasting} is `false`.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   castStop = () => {
     PlayerModule.castStop(this.nativeId);
@@ -455,12 +456,11 @@ export class Player extends NativeInstance<PlayerConfig> {
 
   /**
    * Sets the video quality.
-   * @remarks Only available on Android.
-   * @platform Android
+   * @remarks Platform: Android
    *
    * @param qualityId value obtained from {@link VideoQuality}'s `id` property, which can be obtained via `Player.getAvailableVideoQualities()` to select a specific quality. To use automatic quality selection, 'auto' can be passed here.
    */
-  setVideoQuality = (qualityId: String) => {
+  setVideoQuality = (qualityId: string) => {
     if (Platform.OS !== 'android') {
       console.warn(
         `[Player ${this.nativeId}] Method setVideoQuality is not available for iOS and tvOS devices. Only Android devices.`
@@ -472,17 +472,17 @@ export class Player extends NativeInstance<PlayerConfig> {
 
   /**
    * Sets the playback speed of the player. Fast forward, slow motion and reverse playback are supported.
-   * @note
+   * @remarks
+   * Platform: iOS, tvOS
+   *
    * - Slow motion is indicated by values between `0` and `1`.
    * - Fast forward by values greater than `1`.
    * - Slow reverse is used by values between `0` and `-1`, and fast reverse is used by values less than `-1`. iOS and tvOS only.
-   * @note
-   * Negative values are ignored during Casting and on Android.
-   * @note
-   * During reverse playback the playback will continue until the beginning of the active source is
-   * reached. When reaching the beginning of the source, playback will be paused and the playback
-   * speed will be reset to its default value of `1`. No {@link PlaybackFinishedEvent} will be
-   * emitted in this case.
+   * - Negative values are ignored during Casting and on Android.
+   * - During reverse playback the playback will continue until the beginning of the active source is
+   *   reached. When reaching the beginning of the source, playback will be paused and the playback
+   *   speed will be reset to its default value of `1`. No {@link PlaybackFinishedEvent} will be
+   *   emitted in this case.
    *
    * @param playbackSpeed - The playback speed to set.
    */
@@ -495,14 +495,14 @@ export class Player extends NativeInstance<PlayerConfig> {
    * @returns The player's current playback speed.
    */
   getPlaybackSpeed = async (): Promise<number> => {
-    return PlayerModule.getPlaybackSpeed(this.nativeId);
+    return (await PlayerModule.getPlaybackSpeed(this.nativeId)) ?? 0;
   };
 
   /**
    * Checks the possibility to play the media at specified playback speed.
    * @param playbackSpeed - The playback speed to check.
    * @returns `true` if it's possible to play the media at the specified playback speed, otherwise `false`. On Android it always returns `undefined`.
-   * @platform iOS, tvOS
+   * @remarks Platform: iOS, tvOS
    */
   canPlayAtPlaybackSpeed = async (
     playbackSpeed: number
@@ -513,7 +513,12 @@ export class Player extends NativeInstance<PlayerConfig> {
       );
       return undefined;
     }
-    return PlayerModule.canPlayAtPlaybackSpeed(this.nativeId, playbackSpeed);
+    return (
+      (await PlayerModule.canPlayAtPlaybackSpeed(
+        this.nativeId,
+        playbackSpeed
+      )) ?? false
+    );
   };
 
   private maybeInitDecoderConfig = () => {

package/src/source.ts

@@ -1,11 +1,9 @@
-import { NativeModules } from 'react-native';
 import { Drm, DrmConfig } from './drm';
 import NativeInstance, { NativeInstanceConfig } from './nativeInstance';
 import { SideLoadedSubtitleTrack } from './subtitleTrack';
 import { Thumbnail } from './thumbnail';
 import { SourceMetadata } from './analytics';
-
-const SourceModule = NativeModules.SourceModule;
+import SourceModule from './modules/SourceModule';
 
 /**
  * Types of media that can be handled by the player.
@@ -138,7 +136,7 @@ export interface SourceConfig extends NativeInstanceConfig {
 
 /**
  * The remote control config for a source.
- * @platform iOS
+ * @remarks Platform: iOS
  */
 export interface SourceRemoteControlConfig {
   /**
@@ -163,7 +161,7 @@ export class Source extends NativeInstance<SourceConfig> {
    * The remote control config for this source.
    * This is only supported on iOS.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   remoteControl: SourceRemoteControlConfig | null = null;
   /**
@@ -178,7 +176,7 @@ export class Source extends NativeInstance<SourceConfig> {
   /**
    * Allocates the native {@link Source} instance and its resources natively.
    */
-  initialize = () => {
+  initialize = async (): Promise<void> => {
     if (!this.isInitialized) {
       const sourceMetadata = this.config?.analyticsSourceMetadata;
       if (this.config?.drmConfig) {
@@ -186,23 +184,24 @@ export class Source extends NativeInstance<SourceConfig> {
         this.drm.initialize();
       }
       if (sourceMetadata) {
-        SourceModule.initWithAnalyticsConfig(
+        await SourceModule.initializeWithAnalyticsConfig(
           this.nativeId,
           this.drm?.nativeId,
           this.config,
-          this.remoteControl,
+          this.remoteControl || undefined,
           sourceMetadata
         );
       } else {
-        SourceModule.initWithConfig(
+        await SourceModule.initializeWithConfig(
           this.nativeId,
           this.drm?.nativeId,
           this.config,
-          this.remoteControl
+          this.remoteControl || undefined
         );
       }
       this.isInitialized = true;
     }
+    return Promise.resolve();
   };
 
   /**
@@ -221,7 +220,7 @@ export class Source extends NativeInstance<SourceConfig> {
    * Default value is `0` if the duration is not available or not known.
    */
   duration = async (): Promise<number> => {
-    return SourceModule.duration(this.nativeId);
+    return (await SourceModule.duration(this.nativeId)) || 0;
   };
 
   /**
@@ -229,14 +228,14 @@ export class Source extends NativeInstance<SourceConfig> {
    * Only one source can be active in the same player instance at any time.
    */
   isActive = async (): Promise<boolean> => {
-    return SourceModule.isActive(this.nativeId);
+    return (await SourceModule.isActive(this.nativeId)) ?? false;
   };
 
   /**
    * Whether the source is currently attached to a player instance.
    */
   isAttachedToPlayer = async (): Promise<boolean> => {
-    return SourceModule.isAttachedToPlayer(this.nativeId);
+    return (await SourceModule.isAttachedToPlayer(this.nativeId)) ?? false;
   };
 
   /**
@@ -260,7 +259,9 @@ export class Source extends NativeInstance<SourceConfig> {
    * The current `LoadingState` of the source.
    */
   loadingState = async (): Promise<LoadingState> => {
-    return SourceModule.loadingState(this.nativeId);
+    return (
+      (await SourceModule.loadingState(this.nativeId)) || LoadingState.UNLOADED
+    );
   };
 
   /**

package/src/styleConfig.ts

@@ -26,7 +26,7 @@ export interface StyleConfig {
    *   },
    * });
    * ```
-   * @platform iOS, tvOS
+   * @remarks Platform: iOS, tvOS
    */
   userInterfaceType?: UserInterfaceType;
   /**
@@ -39,7 +39,7 @@ export interface StyleConfig {
    *   },
    * });
    * ```
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   playerUiCss?: string;
   /**
@@ -52,7 +52,7 @@ export interface StyleConfig {
    *   },
    * });
    * ```
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   supplementalPlayerUiCss?: string;
   /**
@@ -65,7 +65,7 @@ export interface StyleConfig {
    *   },
    * });
    * ```
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   playerUiJs?: string;
   /**
@@ -111,7 +111,7 @@ export enum UserInterfaceType {
   Bitmovin = 'Bitmovin',
   /**
    * Indicates that the system UI should be used.
-   * @platform iOS, tvOS
+   * @remarks Platform: iOS, tvOS
    */
   System = 'System',
   /**

package/src/subtitleFormat.ts

@@ -1,26 +1,26 @@
 /**
  * Supported subtitle/caption file formats.
- * @platform Android, iOS, tvOS
+ * @remarks Platform: Android, iOS, tvOS
  */
 export enum SubtitleFormat {
   /**
    * Closed Captioning (CEA) subtitle format.
-   * @platform Android, iOS, tvOS
+   * @remarks Platform: Android, iOS, tvOS
    */
   CEA = 'cea',
   /**
    * Timed Text Markup Language (TTML) subtitle format.
-   * @platform Android, iOS, tvOS
+   * @remarks Platform: Android, iOS, tvOS
    */
   TTML = 'ttml',
   /**
    * Web Video Text Tracks Format (WebVTT) subtitle format.
-   * @platform Android, iOS, tvOS
+   * @remarks Platform: Android, iOS, tvOS
    */
   VTT = 'vtt',
   /**
    * SubRip (SRT) subtitle format.
-   * @platform Android, iOS, tvOS
+   * @remarks Platform: Android, iOS, tvOS
    */
   SRT = 'srt',
 }

package/src/subtitleTrack.ts

@@ -3,7 +3,7 @@ import { SubtitleFormat } from './subtitleFormat';
 
 /**
  * Describes a subtitle track.
- * @platform Android, iOS, tvOS
+ * @remarks Platform: Android, iOS, tvOS
  */
 export interface SubtitleTrack {
   /**

package/src/tweaksConfig.ts

@@ -35,7 +35,7 @@ export interface TweaksConfig {
    * Default value in iOS is `1.0`.
    * Default value in Android is `0.2`.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
   timeChangedInterval?: number;
   /**
@@ -49,7 +49,7 @@ export interface TweaksConfig {
    *
    * Default is false.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   isNativeHlsParsingEnabled?: boolean;
   /**
@@ -62,7 +62,7 @@ export interface TweaksConfig {
    *
    * Default is true.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   isCustomHlsLoadingEnabled?: boolean;
   /**
@@ -76,7 +76,7 @@ export interface TweaksConfig {
    *
    * Default is 0.5.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   seekToEndThreshold?: number;
   /**
@@ -85,7 +85,7 @@ export interface TweaksConfig {
    * - 'relaxed': Starts playback when enough media data is buffered and continuous playback without stalling can be ensured. If insufficient media data is buffered for playback to start, the player will act as if the buffer became empty during playback.
    * - 'aggressive': When the buffer is not empty, this setting will cause the player to start playback of available media immediately. If insufficient media data is buffered for playback to start, the player will act as if the buffer became empty during playback.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   playbackStartBehaviour?: 'relaxed' | 'aggressive';
   /**
@@ -94,20 +94,20 @@ export interface TweaksConfig {
    * - 'relaxed': The player will wait until the buffer is filled that it can, most likely, ensure continuous playback without another stalling right after playback continued.
    * - 'aggressive': The player will try to unstall as soon as some media data became available and will start playback of this media immediately.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   unstallingBehaviour?: 'relaxed' | 'aggressive';
   /**
    * Constantly aggregated and weighted bandwidth samples are summed up to this weight limit to calculate an bandwidth estimation. Remaining samples (i.e. that would lead to exceeding the limit) are dropped from memory as they are not relevant anymore.
    * Default is 2000.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   bandwidthEstimateWeightLimit?: number;
   /**
    * Some devices have an incorrect implementation of MediaCodec.setOutputSurface. This leads to failure when the surface changes. To prevent failure, the codec will be released and re-instantiated in those scenarios.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   devicesThatRequireSurfaceWorkaround?: {
     /**
@@ -132,14 +132,14 @@ export interface TweaksConfig {
    * - "en_us" is normalized to "en-us"
    * - "en-US-x-lvariant-POSIX" is normalized to "en-us-posix"
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   languagePropertyNormalization?: boolean;
   /**
    * The interval in which dynamic DASH windows are updated locally. I.e. The rate by which the
    * playback window is moved forward on the timeline.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   localDynamicDashWindowUpdateInterval?: number;
   /**
@@ -147,7 +147,7 @@ export interface TweaksConfig {
    * DRM sessions for clear content avoids the recreation of decoders when transitioning between clear
    * and encrypted sections of content. Default is false.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   useDrmSessionForClearPeriods?: boolean;
   /**
@@ -156,7 +156,7 @@ export interface TweaksConfig {
    * periods in a DRM protected source. Using DRM sessions for clear content avoids the recreation of
    * decoders when transitioning between clear and encrypted sections of content. Default is false.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   useDrmSessionForClearSources?: boolean;
   /**
@@ -164,7 +164,7 @@ export interface TweaksConfig {
    * matching extractor was found. If the fallback is applied, this will ignore potential incompatibilities
    * with streams and thus can result in unstable or failing playback.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   useFiletypeExtractorFallbackForHls?: boolean;
   /**
@@ -177,7 +177,7 @@ export interface TweaksConfig {
    * Default is `true`.
    *
    * @deprecated To enable the Now Playing information use {@link MediaControlConfig.isEnabled}
-   * @platform iOS
+   * @remarks Platform: iOS
    */
   updatesNowPlayingInfoCenter?: boolean;
 
@@ -192,7 +192,7 @@ export interface TweaksConfig {
    *
    * Default is `null` i.e not set
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
-  forceReuseVideoCodecReasons?: Array<ForceReuseVideoCodecReason>;
+  forceReuseVideoCodecReasons?: ForceReuseVideoCodecReason[];
 }

package/src/ui/customMessageHandlerModule.ts

@@ -0,0 +1,46 @@
+import { NativeModule, requireNativeModule } from 'expo-modules-core';
+
+export type CustomMessageHandlerModuleEvents = {
+  onReceivedSynchronousMessage: ({
+    nativeId,
+    id,
+    message,
+    data,
+  }: {
+    nativeId: string;
+    id: number;
+    message: string;
+    data: string | undefined;
+  }) => void;
+  onReceivedAsynchronousMessage: ({
+    nativeId,
+    message,
+    data,
+  }: {
+    nativeId: string;
+    message: string;
+    data: string | undefined;
+  }) => void;
+};
+
+/**
+ * Native CustomMessageHandlerModule using Expo modules API.
+ * Provides modern async/await interface while maintaining backward compatibility.
+ */
+declare class CustomMessageHandlerModule extends NativeModule<CustomMessageHandlerModuleEvents> {
+  registerHandler(nativeId: string): Promise<void>;
+  destroy(nativeId: string): Promise<void>;
+  onReceivedSynchronousMessageResult(
+    id: number,
+    result: string | undefined
+  ): Promise<void>;
+  sendMessage(
+    nativeId: string,
+    message: string,
+    data: string | undefined
+  ): Promise<void>;
+}
+
+export default requireNativeModule<CustomMessageHandlerModule>(
+  'CustomMessageHandlerModule'
+);