bitmovin-player-react-native 1.2.0 → 1.4.0

package/src/audioSession.ts

@@ -13,7 +13,7 @@ import AudioSessionModule from './modules/AudioSessionModule';
  * - `record`: The category for recording audio while also silencing playback audio.
  * - `soloAmbient`: The default audio session category.
  *
- * @remarks Platform: iOS
+ * @platform iOS
  * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/category
  */
 export type AudioSessionCategory =
@@ -27,14 +27,14 @@ export type AudioSessionCategory =
 /**
  * An object that communicates to the system how you intend to use audio in your app.
  *
- * @remarks Platform: iOS
+ * @platform iOS
  * @see https://developer.apple.com/documentation/avfaudio/avaudiosession
  */
 export const AudioSession = {
   /**
    * Sets the audio session's category.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/1616583-setcategory
    */
   setCategory: async (category: AudioSessionCategory): Promise<void> => {

package/src/bitmovinCastManager.ts

@@ -3,7 +3,7 @@ import BitmovinCastManagerModule from './modules/BitmovinCastManagerModule';
 
 /**
  * The options to be used for initializing `BitmovinCastManager`
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface BitmovinCastManagerOptions {
   /**
@@ -23,7 +23,7 @@ export interface BitmovinCastManagerOptions {
  * The `BitmovinCastManager` needs to be initialized by calling `BitmovinCastManager.initialize`
  * before `Player` creation to enable casting features.
  *
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export const BitmovinCastManager = {
   /**
@@ -63,7 +63,7 @@ export const BitmovinCastManager = {
    * Make sure to call this method on every Android Activity switch.
    *
    * @returns A promise that resolves when the context was updated successfully
-   * @remarks Platform: Android
+   * @platform Android
    */
   updateContext: async (): Promise<void> => {
     if (Platform.OS === 'ios') {

package/src/bufferConfig.ts

@@ -27,7 +27,7 @@ export interface BufferConfig {
    *
    * Default is `5` seconds.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   restartThreshold?: number;
   /**
@@ -36,7 +36,7 @@ export interface BufferConfig {
    *
    * Default is `2.5` seconds.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   startupThreshold?: number;
 }

package/src/components/PlayerView/events.ts

@@ -120,56 +120,56 @@ export type PlayerViewEvents = {
   /**
    * Event emitted when casting to a cast-compatible device is available.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastAvailable?: (event: CastAvailableEvent) => void;
   /**
    * Event emitted when the playback on a cast-compatible device was paused.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastPaused?: (event: CastPausedEvent) => void;
   /**
    * Event emitted when the playback on a cast-compatible device has finished.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastPlaybackFinished?: (event: CastPlaybackFinishedEvent) => void;
   /**
    * Event emitted when playback on a cast-compatible device has started.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastPlaying?: (event: CastPlayingEvent) => void;
   /**
    * Event emitted when the cast app is launched successfully.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastStarted?: (event: CastStartedEvent) => void;
   /**
    * Event emitted when casting is initiated, but the user still needs to choose which device should be used.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastStart?: (event: CastStartEvent) => void;
   /**
    * Event emitted when casting to a cast-compatible device is stopped.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastStopped?: (event: CastStoppedEvent) => void;
   /**
    * Event emitted when the time update from the currently used cast-compatible device is received.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastTimeUpdated?: (event: CastTimeUpdatedEvent) => void;
   /**
    * Event emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for
    * playback.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onCastWaitingForDevice?: (event: CastWaitingForDeviceEvent) => void;
   /**
@@ -195,25 +195,25 @@ export type PlayerViewEvents = {
   /**
    * Event emitted when fullscreen mode has been enabled.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onFullscreenEnabled?: (event: FullscreenEnabledEvent) => void;
   /**
    * Event emitted when fullscreen mode has been disabled.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onFullscreenDisabled?: (event: FullscreenDisabledEvent) => void;
   /**
    * Event emitted when fullscreen mode has been entered.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onFullscreenEnter?: (event: FullscreenEnterEvent) => void;
   /**
    * Event emitted when fullscreen mode has been exited.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onFullscreenExit?: (event: FullscreenExitEvent) => void;
   /**
@@ -237,7 +237,7 @@ export type PlayerViewEvents = {
   /**
    * Event emitted when the player entered Picture in Picture mode.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   onPictureInPictureEntered?: (event: PictureInPictureEnteredEvent) => void;
   /**
@@ -247,7 +247,7 @@ export type PlayerViewEvents = {
   /**
    * Event emitted when the player exited Picture in Picture mode.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   onPictureInPictureExited?: (event: PictureInPictureExitedEvent) => void;
   /**
@@ -260,7 +260,7 @@ export type PlayerViewEvents = {
   onPlaybackFinished?: (event: PlaybackFinishedEvent) => void;
   /**
    * Emitted when the player transitions from one playback speed to another.
-   * @remarks Platform: iOS, tvOS
+   * @platform iOS, tvOS
    */
   onPlaybackSpeedChanged?: (event: PlaybackSpeedChangedEvent) => void;
   /**

package/src/components/PlayerView/nativeEvents.ts

@@ -119,19 +119,19 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when casting to a cast-compatible device is available.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastAvailable?: (event: { nativeEvent: CastAvailableEvent }) => void;
   /**
    * Event emitted when the playback on a cast-compatible device was paused.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastPaused?: (event: { nativeEvent: CastPausedEvent }) => void;
   /**
    * Event emitted when the playback on a cast-compatible device has finished.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastPlaybackFinished?: (event: {
     nativeEvent: CastPlaybackFinishedEvent;
@@ -139,38 +139,38 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when playback on a cast-compatible device has started.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastPlaying?: (event: { nativeEvent: CastPlayingEvent }) => void;
   /**
    * Event emitted when the cast app is launched successfully.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastStarted?: (event: { nativeEvent: CastStartedEvent }) => void;
   /**
    * Event emitted when casting is initiated, but the user still needs to choose which device should be used.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastStart?: (event: { nativeEvent: CastStartEvent }) => void;
   /**
    * Event emitted when casting to a cast-compatible device is stopped.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastStopped?: (event: { nativeEvent: CastStoppedEvent }) => void;
   /**
    * Event emitted when the time update from the currently used cast-compatible device is received.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastTimeUpdated?: (event: { nativeEvent: CastTimeUpdatedEvent }) => void;
   /**
    * Event emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for
    * playback.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpCastWaitingForDevice?: (event: {
     nativeEvent: CastWaitingForDeviceEvent;
@@ -200,7 +200,7 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when fullscreen mode has been enabled.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpFullscreenEnabled?: (event: {
     nativeEvent: FullscreenEnabledEvent;
@@ -208,7 +208,7 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when fullscreen mode has been disabled.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpFullscreenDisabled?: (event: {
     nativeEvent: FullscreenDisabledEvent;
@@ -216,13 +216,13 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when fullscreen mode has been entered.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpFullscreenEnter?: (event: { nativeEvent: FullscreenEnterEvent }) => void;
   /**
    * Event emitted when fullscreen mode has been exited.
    *
-   * @remarks Platform: iOS, Android
+   * @platform iOS, Android
    */
   onBmpFullscreenExit?: (event: { nativeEvent: FullscreenExitEvent }) => void;
   /**
@@ -248,7 +248,7 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when the player entered Picture in Picture mode.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   onBmpPictureInPictureEntered?: (event: {
     nativeEvent: PictureInPictureEnteredEvent;
@@ -262,7 +262,7 @@ export type NativePlayerViewEvents = {
   /**
    * Event emitted when the player exited Picture in Picture mode.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   onBmpPictureInPictureExited?: (event: {
     nativeEvent: PictureInPictureExitedEvent;
@@ -279,7 +279,7 @@ export type NativePlayerViewEvents = {
   }) => void;
   /**
    * Emitted when the player transitions from one playback speed to another.
-   * @remarks Platform: iOS, tvOS
+   * @platform iOS, tvOS
    */
   onBmpPlaybackSpeedChanged?: (event: {
     nativeEvent: PlaybackSpeedChangedEvent;

package/src/components/PlayerView/pictureInPictureConfig.ts

@@ -16,7 +16,7 @@ export interface PictureInPictureConfig {
    *
    * Default is `false`.
    *
-   * @remarks Platform: iOS 14.2 and above
+   * @platform iOS 14.2 and above
    */
   shouldEnterOnBackground?: boolean;
 }

package/src/components/PlayerView/playerViewConfig.ts

@@ -36,7 +36,7 @@ export interface PlayerViewConfig {
    *
    * Default is {@link SurfaceType.SurfaceView}.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   surfaceType?: SurfaceType;
 }
@@ -67,7 +67,7 @@ export interface WebUiConfig extends UiConfig {
    * By default this is enabled only for the TV UI variant, as it's needed there to
    * initiate spatial navigation using the remote control.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   focusUiOnInitialization?: boolean;
 }

package/src/decoder/decoderConfig.ts

@@ -3,7 +3,7 @@ import { NativeInstanceConfig } from '../nativeInstance';
 /**
  * Configures the playback behaviour of the player.
  *
- * @remarks Platform: Android
+ * @platform Android
  */
 export interface DecoderConfig extends NativeInstanceConfig {
   /**
@@ -77,7 +77,7 @@ export interface DecoderConfig extends NativeInstanceConfig {
  * Can be set on the `DecoderConfig.decoderPriorityProvider` to override the default decoder selection logic.
  * See {@link DecoderConfig#decoderPriorityProvider} for more details
  *
- * @remarks Platform: Android
+ * @platform Android
  * */
 export interface DecoderPriorityProvider {
   overrideDecodersPriority: (

package/src/drm/index.ts

@@ -15,13 +15,13 @@ export interface DrmConfig extends NativeInstanceConfig {
   /**
    * FairPlay specific configuration.
    *
-   * @remarks Platform: iOS
+   * @platform iOS
    */
   fairplay?: FairplayConfig;
   /**
    * Widevine specific configuration.
    *
-   * @remarks Platform: Android, iOS (only for casting).
+   * @platform Android, iOS (only for casting).
    */
   widevine?: WidevineConfig;
 }

package/src/drm/widevineConfig.ts

@@ -1,6 +1,6 @@
 /**
  * Represents a Widevine Streaming DRM config.
- * @remarks Platform: Android, iOS (only for casting).
+ * @platform Android, iOS (only for casting).
  */
 export interface WidevineConfig {
   /**
@@ -19,7 +19,7 @@ export interface WidevineConfig {
    * Note that both the passed `message` data and this block return value should be a Base64 string.
    * So use whatever solution suits you best to handle Base64 in React Native.
    *
-   * @remarks Platform: Android
+   * @platform Android
    *
    * @param message - Base64 encoded message data.
    * @returns The processed Base64 encoded message.
@@ -33,7 +33,7 @@ export interface WidevineConfig {
    * Note that both the passed `license` data and this block return value should be a Base64 string.
    * So use whatever solution suits you best to handle Base64 in React Native.
    *
-   * @remarks Platform: Android
+   * @platform Android
    *
    * @param license - Base64 encoded license data.
    * @returns The processed Base64 encoded license.
@@ -42,7 +42,7 @@ export interface WidevineConfig {
   /**
    * Set widevine's preferred security level.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   preferredSecurityLevel?: string;
   /**
@@ -51,7 +51,7 @@ export interface WidevineConfig {
    * as the same DRM scheme information.
    * Default: `false`
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   shouldKeepDrmSessionsAlive?: boolean;
 }

package/src/events.ts

@@ -346,63 +346,63 @@ export interface SubtitleChangedEvent extends Event {
 /**
  * Emitted when the player enters Picture in Picture mode.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type PictureInPictureEnterEvent = Event;
 
 /**
  * Emitted when the player exits Picture in Picture mode.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type PictureInPictureExitEvent = Event;
 
 /**
  * Emitted when the player has finished entering Picture in Picture mode on iOS.
  *
- * @remarks Platform: iOS
+ * @platform iOS
  */
 export type PictureInPictureEnteredEvent = Event;
 
 /**
  * Emitted when the player has finished exiting Picture in Picture mode on iOS.
  *
- * @remarks Platform: iOS
+ * @platform iOS
  */
 export type PictureInPictureExitedEvent = Event;
 
 /**
  * Emitted when the fullscreen functionality has been enabled.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type FullscreenEnabledEvent = Event;
 
 /**
  * Emitted when the fullscreen functionality has been disabled.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type FullscreenDisabledEvent = Event;
 
 /**
  * Emitted when the player enters fullscreen mode.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type FullscreenEnterEvent = Event;
 
 /**
  * Emitted when the player exits fullscreen mode.
  *
- * @remarks Platform: iOS, Android
+ * @platform iOS, Android
  */
 export type FullscreenExitEvent = Event;
 
 /**
  * Emitted when the availability of the Picture in Picture mode changed on Android.
  *
- * @remarks Platform: Android
+ * @platform Android
  */
 export interface PictureInPictureAvailabilityChangedEvent extends Event {
   /**
@@ -710,7 +710,7 @@ export interface DownloadFinishedEvent extends Event {
 
 /**
  * Emitted when the player transitions from one playback speed to another.
- * @remarks Platform: iOS, tvOS
+ * @platform iOS, tvOS
  */
 export interface PlaybackSpeedChangedEvent extends Event {
   /**

package/src/media.ts

@@ -82,4 +82,8 @@ export interface AudioQuality {
    * The codec of the media quality.
    */
   codec?: string;
+  /**
+   * The number of audio channels or -1 if unknown.
+   */
+  channelCount?: number;
 }

package/src/modules/PlayerModule.ts

@@ -1,6 +1,17 @@
 import { NativeModule, requireNativeModule } from 'expo-modules-core';
-
-export type PlayerModuleEvents = Record<string, any>;
+import { ImaSettings } from '../advertising';
+
+export type PlayerModuleEvents = {
+  onImaBeforeInitialization: ({
+    nativeId,
+    id,
+    settings,
+  }: {
+    nativeId: string;
+    id: number;
+    settings: ImaSettings;
+  }) => void;
+};
 
 declare class PlayerModule extends NativeModule<PlayerModuleEvents> {
   /**
@@ -148,6 +159,11 @@ declare class PlayerModule extends NativeModule<PlayerModuleEvents> {
    */
   skipAd(nativeId: string): Promise<void>;
 
+  /**
+   * Applies the JS-updated IMA settings for a before-initialization callback.
+   */
+  setPreparedImaSettings(id: number, settings: ImaSettings): Promise<void>;
+
   /**
    * Check if player can play at specified playback speed (iOS only).
    */

package/src/offline/offlineContentConfig.ts

@@ -3,7 +3,7 @@ import { SourceConfig } from '../source';
 
 /**
  * Object used to configure a new `OfflineContentManager` instance.
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export interface OfflineContentConfig extends NativeInstanceConfig {
   /**

package/src/offline/offlineContentManager.ts

@@ -45,7 +45,7 @@ const handleBitmovinNativeOfflineEvent = (
  * without an active network connection. An OfflineContentManager instance can be created via
  * the constructor and will be idle until initialized.
  *
- * @remarks Platform: Android, iOS
+ * @platform Android, iOS
  */
 export class OfflineContentManager extends NativeInstance<OfflineContentConfig> {
   isInitialized = false;
@@ -193,7 +193,7 @@ export class OfflineContentManager extends NativeInstance<OfflineContentConfig>
    * When finished successfully data will be passed to the `OfflineContentManagerListener.onDrmLicenseUpdated`.
    * Errors are transmitted to the `OfflineContentManagerListener.onError`.
    *
-   * @remarks Platform: Android
+   * @platform Android
    */
   releaseLicense = async (): Promise<void> => {
     return OfflineModule.releaseLicense(this.nativeId);