bitmovin-player-react-native 1.2.0 → 1.4.0

package/src/offline/offlineContentManagerListener.ts

@@ -3,7 +3,7 @@ import { OfflineState } from './offlineState';
 
 /**
  * Enum to hold the `eventType` on the `BitmovinNativeOfflineEventData`
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export enum OfflineEventType {
   onCompleted = 'onCompleted',
@@ -19,7 +19,7 @@ export enum OfflineEventType {
 
 /**
  * The base interface for all offline events.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineEvent<T extends OfflineEventType> {
   /**
@@ -42,7 +42,7 @@ export interface OfflineEvent<T extends OfflineEventType> {
 
 /**
  * Emitted when the download process has completed.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OnCompletedEvent
   extends OfflineEvent<OfflineEventType.onCompleted> {
@@ -54,7 +54,7 @@ export interface OnCompletedEvent
 
 /**
  * Emitted when an error has occurred.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OnErrorEvent extends OfflineEvent<OfflineEventType.onError> {
   /**
@@ -69,7 +69,7 @@ export interface OnErrorEvent extends OfflineEvent<OfflineEventType.onError> {
 
 /**
  * Emitted when there is a progress change for the process call.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OnProgressEvent
   extends OfflineEvent<OfflineEventType.onProgress> {
@@ -81,7 +81,7 @@ export interface OnProgressEvent
 
 /**
  * Emitted when the `OfflineContentOptions` is available after a `OfflineContentManager.getOptions` call.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OnOptionsAvailableEvent
   extends OfflineEvent<OfflineEventType.onOptionsAvailable> {
@@ -93,39 +93,39 @@ export interface OnOptionsAvailableEvent
 
 /**
  * Emitted when the DRM license was updated.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export type OnDrmLicenseUpdatedEvent =
   OfflineEvent<OfflineEventType.onDrmLicenseUpdated>;
 
 /**
  * Emitted when the DRM license has expired.
- * @remarks Platform: iOS
+ * @platform iOS
  */
 export type OnDrmLicenseExpiredEvent =
   OfflineEvent<OfflineEventType.onDrmLicenseExpired>;
 
 /**
  * Emitted when all active actions have been suspended.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export type OnSuspendedEvent = OfflineEvent<OfflineEventType.onSuspended>;
 
 /**
  * Emitted when all actions have been resumed.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export type OnResumedEvent = OfflineEvent<OfflineEventType.onResumed>;
 
 /**
  * Emitted when the download of the media content was canceled by the user and all partially downloaded content has been deleted from disk.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export type OnCanceledEvent = OfflineEvent<OfflineEventType.onCanceled>;
 
 /**
  * The type aggregation for all possible native offline events received from the `DeviceEventEmitter`
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export type BitmovinNativeOfflineEventData =
   | OnCompletedEvent
@@ -140,7 +140,7 @@ export type BitmovinNativeOfflineEventData =
 
 /**
  * The listener that can be passed to the `OfflineContentManager` to receive callbacks for different events.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineContentManagerListener {
   /**

package/src/offline/offlineContentOptions.ts

@@ -1,6 +1,6 @@
 /**
  * Superclass of entries which can be selected to download for offline playback
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineContentOptionEntry {
   /**
@@ -15,7 +15,7 @@ export interface OfflineContentOptionEntry {
 
 /**
  * Represents the downloadable options provided via the `onOptionsAvailable` callback on `OfflineContentManagerListener`
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineContentOptions {
   /**

package/src/offline/offlineDownloadRequest.ts

@@ -1,6 +1,6 @@
 /**
  * Represents the configuration to start a download.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineDownloadRequest {
   /**

package/src/offline/offlineSourceOptions.ts

@@ -1,11 +1,11 @@
 /**
  * Object used configure how the native offline managers create and get offline source configurations
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineSourceOptions {
   /**
    * Whether or not the player should restrict playback only to audio, video and subtitle tracks which are stored offline on the device. This has to be set to true if the device has no network access.
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   restrictedToAssetCache?: boolean;
 }

package/src/offline/offlineState.ts

@@ -1,6 +1,6 @@
 /**
  * Contains the state an OfflineContentManager can have.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export enum OfflineState {
   /**

package/src/playbackConfig.ts

@@ -83,7 +83,7 @@ export interface PlaybackConfig {
   /**
    * Configures decoder behaviour.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   decoderConfig?: DecoderConfig;
 }

package/src/player.ts

@@ -1,3 +1,4 @@
+import { EventSubscription } from 'expo-modules-core';
 import { Platform } from 'react-native';
 import PlayerModule from './modules/PlayerModule';
 import NativeInstance from './nativeInstance';
@@ -8,7 +9,7 @@ import { OfflineContentManager, OfflineSourceOptions } from './offline';
 import { Thumbnail } from './thumbnail';
 import { AnalyticsApi } from './analytics/player';
 import { PlayerConfig } from './playerConfig';
-import { AdItem } from './advertising';
+import { AdItem, ImaSettings } from './advertising';
 import { BufferApi } from './bufferApi';
 import { VideoQuality } from './media';
 import { Network } from './network';
@@ -50,11 +51,13 @@ export class Player extends NativeInstance<PlayerConfig> {
   private network?: Network;
 
   private decoderConfig?: DecoderConfigBridge;
+  private onImaBeforeInitializationSubscription?: EventSubscription;
   /**
    * Allocates the native `Player` instance and its resources natively.
    */
   initialize = async (): Promise<void> => {
     if (!this.isInitialized) {
+      this.ensureImaBeforeInitializationListener();
       if (this.config?.networkConfig) {
         this.network = new Network(this.config.networkConfig);
         await this.network.initialize();
@@ -93,6 +96,8 @@ export class Player extends NativeInstance<PlayerConfig> {
       this.source?.destroy();
       this.network?.destroy();
       this.decoderConfig?.destroy();
+      this.onImaBeforeInitializationSubscription?.remove();
+      this.onImaBeforeInitializationSubscription = undefined;
       this.isDestroyed = true;
     }
   };
@@ -198,6 +203,36 @@ export class Player extends NativeInstance<PlayerConfig> {
     PlayerModule.setVolume(this.nativeId, volume);
   };
 
+  private ensureImaBeforeInitializationListener = () => {
+    const callback = this.config?.advertisingConfig?.ima?.beforeInitialization;
+    if (!callback) {
+      return;
+    }
+    if (this.onImaBeforeInitializationSubscription) {
+      return;
+    }
+    this.onImaBeforeInitializationSubscription = PlayerModule.addListener(
+      'onImaBeforeInitialization',
+      ({ nativeId, id, settings }) => {
+        if (nativeId !== this.nativeId) {
+          return;
+        }
+        const cloned: ImaSettings = { ...settings };
+        let prepared = cloned;
+        try {
+          const result = callback(cloned);
+          prepared =
+            result && typeof result === 'object'
+              ? { ...cloned, ...result }
+              : cloned;
+        } catch {
+          prepared = cloned;
+        }
+        PlayerModule.setPreparedImaSettings(id, prepared);
+      }
+    );
+  };
+
   /**
    * @returns The player's current volume level.
    */
@@ -257,7 +292,7 @@ export class Player extends NativeInstance<PlayerConfig> {
   };
 
   /**
-   * @remarks Only available for iOS devices.
+   * @platform iOS
    * @returns `true` when media is played externally using AirPlay.
    */
   isAirPlayActive = async (): Promise<boolean> => {
@@ -271,7 +306,7 @@ export class Player extends NativeInstance<PlayerConfig> {
   };
 
   /**
-   * @remarks Only available for iOS devices.
+   * @platform iOS
    * @returns `true` when AirPlay is available.
    */
   isAirPlayAvailable = async (): Promise<boolean> => {
@@ -336,7 +371,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    *
    * @param adItem - Ad to be scheduled for playback.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   scheduleAd = (adItem: AdItem) => {
     PlayerModule.scheduleAd(this.nativeId, adItem);
@@ -346,7 +381,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.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   skipAd = () => {
     PlayerModule.skipAd(this.nativeId);
@@ -354,7 +389,7 @@ 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.
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   isAd = async (): Promise<boolean> => {
     return (await PlayerModule.isAd(this.nativeId)) ?? false;
@@ -404,7 +439,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * Whether casting to a cast-compatible remote device is available. {@link CastAvailableEvent} signals when
    * casting becomes available.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   isCastAvailable = async (): Promise<boolean> => {
     return (await PlayerModule.isCastAvailable(this.nativeId)) ?? false;
@@ -413,7 +448,7 @@ export class Player extends NativeInstance<PlayerConfig> {
   /**
    * Whether video is currently being casted to a remote device and not played locally.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   isCasting = async (): Promise<boolean> => {
     return (await PlayerModule.isCasting(this.nativeId)) ?? false;
@@ -423,7 +458,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * Initiates casting the current video to a cast-compatible remote device. The user has to choose to which device it
    * should be sent.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   castVideo = () => {
     PlayerModule.castVideo(this.nativeId);
@@ -432,7 +467,7 @@ export class Player extends NativeInstance<PlayerConfig> {
   /**
    * Stops casting the current video. Has no effect if {@link Player.isCasting} is `false`.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   castStop = () => {
     PlayerModule.castStop(this.nativeId);
@@ -456,7 +491,7 @@ export class Player extends NativeInstance<PlayerConfig> {
 
   /**
    * Sets the video quality.
-   * @remarks Platform: Android
+   * @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.
    */
@@ -502,7 +537,7 @@ export class Player extends NativeInstance<PlayerConfig> {
    * 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`.
-   * @remarks Platform: iOS, tvOS
+   * @platform iOS, tvOS
    */
   canPlayAtPlaybackSpeed = async (
     playbackSpeed: number

package/src/source.ts

@@ -136,7 +136,7 @@ export interface SourceConfig extends NativeInstanceConfig {
 
 /**
  * The remote control config for a source.
- * @remarks Platform: iOS
+ * @platform iOS
  */
 export interface SourceRemoteControlConfig {
   /**
@@ -161,7 +161,7 @@ export class Source extends NativeInstance<SourceConfig> {
    * The remote control config for this source.
    * This is only supported on iOS.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   remoteControl: SourceRemoteControlConfig | null = null;
   /**

package/src/styleConfig.ts

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

package/src/subtitleFormat.ts

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

package/src/subtitleTrack.ts

@@ -3,7 +3,7 @@ import { SubtitleFormat } from './subtitleFormat';
 
 /**
  * Describes a subtitle track.
- * @remarks Platform: Android, iOS, tvOS
+ * @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`.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   timeChangedInterval?: number;
   /**
@@ -49,7 +49,7 @@ export interface TweaksConfig {
    *
    * Default is false.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   isNativeHlsParsingEnabled?: boolean;
   /**
@@ -62,7 +62,7 @@ export interface TweaksConfig {
    *
    * Default is true.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   isCustomHlsLoadingEnabled?: boolean;
   /**
@@ -76,7 +76,7 @@ export interface TweaksConfig {
    *
    * Default is 0.5.
    *
-   * @remarks Platform: iOS
+   * @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.
    *
-   * @remarks Platform: iOS
+   * @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.
    *
-   * @remarks Platform: iOS
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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"
    *
-   * @remarks Platform: Android
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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.
    *
-   * @remarks Platform: Android
+   * @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}
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   updatesNowPlayingInfoCenter?: boolean;
 
@@ -192,7 +192,7 @@ export interface TweaksConfig {
    *
    * Default is `null` i.e not set
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   forceReuseVideoCodecReasons?: ForceReuseVideoCodecReason[];
 }