bitmovin-player-react-native 0.25.0 → 0.26.0

package/RNBitmovinPlayer.podspec

@@ -19,7 +19,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "BitmovinPlayer", "3.64.0"
+  s.dependency "BitmovinPlayer", "3.65.0"
   s.ios.dependency "GoogleAds-IMA-iOS-SDK", "3.19.1"
   s.tvos.dependency "GoogleAds-IMA-tvOS-SDK", "4.9.2"
 end

package/android/build.gradle

@@ -105,5 +105,5 @@ dependencies {
     // Bitmovin
     implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.31.0'
     implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
-    implementation 'com.bitmovin.player:player:3.72.0+jason'
+    implementation 'com.bitmovin.player:player:3.73.0+jason'
 }

package/android/src/main/java/com/bitmovin/player/reactnative/PlayerModule.kt

@@ -550,6 +550,20 @@ class PlayerModule(context: ReactApplicationContext) : BitmovinBaseModule(contex
         }
     }
 
+    /**
+     * Set [nativeId]'s player video quality.
+     * NOTE: ONLY available on Android. No effect on iOS and tvOS devices.
+     * @param nativeId Target player Id.
+     * @param qualityId The videoQualityId identifier. A list of currently available VideoQualitys can be retrieved via availableVideoQualities. To use automatic quality selection, Quality.AUTO_ID can be passed as qualityId.
+     * @param promise JS promise object.
+     */
+    @ReactMethod
+    fun setVideoQuality(nativeId: NativeId, qualityId: String, promise: Promise) {
+        promise.unit.resolveOnUiThreadWithPlayer(nativeId) {
+            source?.setVideoQuality(qualityId)
+        }
+    }
+
     /**
      * Resolve [nativeId]'s current playback speed.
      */

package/lib/index.d.mts

@@ -923,7 +923,7 @@ declare enum SourceType {
     PROGRESSIVE = "progressive"
 }
 /**
- * The different loading states a `Source` instance can be in.
+ * The different loading states a {@link Source} instance can be in.
  */
 declare enum LoadingState {
     /**
@@ -1021,7 +1021,7 @@ interface SourceConfig extends NativeInstanceConfig {
      */
     options?: SourceOptions;
     /**
-     * The `SourceMetadata` for the `Source` to setup custom analytics tracking
+     * The `SourceMetadata` for the {@link Source} to setup custom analytics tracking
      */
     analyticsSourceMetadata?: SourceMetadata;
 }
@@ -1055,19 +1055,19 @@ declare class Source extends NativeInstance<SourceConfig> {
      */
     remoteControl: SourceRemoteControlConfig | null;
     /**
-     * Whether the native `Source` object has been created.
+     * Whether the native {@link Source} object has been created.
      */
     isInitialized: boolean;
     /**
-     * Whether the native `Source` object has been disposed.
+     * Whether the native {@link Source} object has been disposed.
      */
     isDestroyed: boolean;
     /**
-     * Allocates the native `Source` instance and its resources natively.
+     * Allocates the native {@link Source} instance and its resources natively.
      */
     initialize: () => void;
     /**
-     * Destroys the native `Source` and releases all of its allocated resources.
+     * Destroys the native {@link Source} and releases all of its allocated resources.
      */
     destroy: () => void;
     /**
@@ -1091,6 +1091,8 @@ declare class Source extends NativeInstance<SourceConfig> {
     /**
      * Set metadata for the currently loaded source.
      * Setting the metadata to `null` clears the metadata object in native source.
+     *
+     * @param metadata metadata to be set.
      */
     setMetadata: (metadata: Record<string, any> | null) => void;
     /**
@@ -1100,10 +1102,12 @@ declare class Source extends NativeInstance<SourceConfig> {
     /**
      * @returns a `Thumbnail` for the specified playback time if available.
      * Supported thumbnail formats are:
-     * - `WebVtt` configured via `SourceConfig.thumbnailTrack`, on all supported platforms
+     * - `WebVtt` configured via {@link SourceConfig.thumbnailTrack}, on all supported platforms
      * - HLS `Image Media Playlist` in the multivariant playlist, Android-only
      * - DASH `Image Adaptation Set` as specified in DASH-IF IOP, Android-only
      * If a `WebVtt` thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.
+     *
+     * @param time - The time in seconds for which to retrieve the thumbnail.
      */
     getThumbnail: (time: number) => Promise<Thumbnail | null>;
 }
@@ -1284,7 +1288,7 @@ interface ErrorEvent extends Event {
      */
     message: string;
     /**
-     * Underlying data emitted with the Error/Warning.
+     * Underlying data emitted with the error or warning.
      */
     data?: Record<string, any>;
 }
@@ -1358,9 +1362,9 @@ interface PlayingEvent extends Event {
 interface PlaybackFinishedEvent extends Event {
 }
 /**
- * Source object representation the way it appears on `Event` payloads such as `SeekEvent`, for example.
+ * Source object representation the way it appears on event's payloads such as `SeekEvent`, for example.
  *
- * This interface only type hints what should be the shape of a `Source` object inside an `Event`'s
+ * This interface only type hints what should be the shape of a {@link Source} object inside an event's
  * payload during runtime so it has no direct relation with the `Source` class present in `src/source.ts`.
  *
  * Do not mistake it for a `NativeInstance` type.
@@ -1383,7 +1387,7 @@ interface EventSource {
      */
     metadata?: Record<string, any>;
     /**
-     * The current `LoadingState` of the source.
+     * The current {@link LoadingState} of the source.
      */
     loadingState: LoadingState;
 }
@@ -1392,11 +1396,11 @@ interface EventSource {
  */
 interface SeekPosition {
     /**
-     * The relevant `Source`.
+     * The relevant {@link Source}.
      */
     source: EventSource;
     /**
-     * The position within the `source` in seconds.
+     * The position within the {@link Source} in seconds.
      */
     time: number;
 }
@@ -1475,7 +1479,7 @@ interface SourceLoadEvent extends Event {
 /**
  * Emitted when a new source is loaded.
  * This does not mean that the source is immediately ready for playback.
- * `ReadyEvent` indicates the player is ready for immediate playback.
+ * {@link ReadyEvent} indicates the player is ready for immediate playback.
  */
 interface SourceLoadedEvent extends Event {
     /**
@@ -1636,7 +1640,7 @@ interface PictureInPictureAvailabilityChangedEvent extends Event {
  */
 interface AdBreakStartedEvent extends Event {
     /**
-     * The `AdBreak` that has started.
+     * The {@link AdBreak} that has started.
      */
     adBreak?: AdBreak;
 }
@@ -1645,7 +1649,7 @@ interface AdBreakStartedEvent extends Event {
  */
 interface AdBreakFinishedEvent extends Event {
     /**
-     * The `AdBreak` that has finished.
+     * The {@link AdBreak} that has finished.
      */
     adBreak?: AdBreak;
 }
@@ -1654,7 +1658,7 @@ interface AdBreakFinishedEvent extends Event {
  */
 interface AdStartedEvent extends Event {
     /**
-     * The `Ad` this event is related to.
+     * The {@link Ad} this event is related to.
      */
     ad?: Ad;
     /**
@@ -1662,7 +1666,7 @@ interface AdStartedEvent extends Event {
      */
     clickThroughUrl?: string;
     /**
-     * The `AdSourceType` of the started `Ad`.
+     * The {@link AdSourceType} of the started ad.
      */
     clientType?: AdSourceType;
     /**
@@ -1674,7 +1678,7 @@ interface AdStartedEvent extends Event {
      */
     indexInQueue: number;
     /**
-     * The position of the corresponding `Ad`.
+     * The position of the corresponding ad.
      */
     position?: string;
     /**
@@ -1682,7 +1686,7 @@ interface AdStartedEvent extends Event {
      */
     skipOffset: number;
     /**
-     * The content time at which the `Ad` is played.
+     * The main content time at which the ad is played.
      */
     timeOffset: number;
 }
@@ -1691,7 +1695,7 @@ interface AdStartedEvent extends Event {
  */
 interface AdFinishedEvent extends Event {
     /**
-     * The `Ad` that finished playback.
+     * The {@link Ad} that finished playback.
      */
     ad?: Ad;
 }
@@ -1700,11 +1704,11 @@ interface AdFinishedEvent extends Event {
  */
 interface AdErrorEvent extends ErrorEvent {
     /**
-     * The `AdConfig` for which the ad error occurred.
+     * The {@link AdConfig} for which the ad error occurred.
      */
     adConfig?: AdConfig;
     /**
-     * The `AdItem` for which the ad error occurred.
+     * The {@link AdItem} for which the ad error occurred.
      */
     adItem?: AdItem;
 }
@@ -1722,7 +1726,7 @@ interface AdClickedEvent extends Event {
  */
 interface AdSkippedEvent extends Event {
     /**
-     * The `Ad` that was skipped.
+     * The ad that was skipped.
      */
     ad?: Ad;
 }
@@ -1731,7 +1735,7 @@ interface AdSkippedEvent extends Event {
  */
 interface AdQuartileEvent extends Event {
     /**
-     * The `AdQuartile` boundary that playback has progressed over.
+     * The {@link AdQuartile} boundary that playback has progressed over.
      */
     quartile: AdQuartile;
 }
@@ -1749,11 +1753,11 @@ interface AdScheduledEvent extends Event {
  */
 interface AdManifestLoadEvent extends Event {
     /**
-     * The `AdBreak` this event is related to.
+     * The {@link AdBreak} this event is related to.
      */
     adBreak?: AdBreak;
     /**
-     * The `AdConfig` of the loaded ad manifest.
+     * The {@link AdConfig} of the loaded ad manifest.
      */
     adConfig?: AdConfig;
 }
@@ -1762,11 +1766,11 @@ interface AdManifestLoadEvent extends Event {
  */
 interface AdManifestLoadedEvent extends Event {
     /**
-     * The `AdBreak` this event is related to.
+     * The {@link AdBreak} this event is related to.
      */
     adBreak?: AdBreak;
     /**
-     * The `AdConfig` of the loaded ad manifest.
+     * The {@link AdConfig} of the loaded ad manifest.
      */
     adConfig?: AdConfig;
     /**
@@ -1808,21 +1812,21 @@ interface CastAvailableEvent extends Event {
 /**
  * Emitted when the playback on a cast-compatible device was paused.
  *
- * On Android `PausedEvent` is also emitted while casting.
+ * On Android {@link PausedEvent} is also emitted while casting.
  */
 interface CastPausedEvent extends Event {
 }
 /**
  * Emitted when the playback on a cast-compatible device has finished.
  *
- * On Android `PlaybackFinishedEvent` is also emitted while casting.
+ * On Android {@link PlaybackFinishedEvent} is also emitted while casting.
  */
 interface CastPlaybackFinishedEvent extends Event {
 }
 /**
  * Emitted when playback on a cast-compatible device has started.
  *
- * On Android `PlayingEvent` is also emitted while casting.
+ * On Android {@link PlayingEvent} is also emitted while casting.
  */
 interface CastPlayingEvent extends Event {
 }
@@ -1851,7 +1855,7 @@ interface CastStoppedEvent extends Event {
 interface CastTimeUpdatedEvent extends Event {
 }
 /**
- * Contains information for the `CastWaitingForDeviceEvent`.
+ * Contains information for the {@link CastWaitingForDeviceEvent}.
  */
 interface CastPayload {
     /**
@@ -1863,7 +1867,7 @@ interface CastPayload {
      */
     deviceName: string | null;
     /**
-     * The type of the payload (always "cast").
+     * The type of the payload (always `"cast"`).
      */
     type: string;
 }
@@ -1873,7 +1877,7 @@ interface CastPayload {
  */
 interface CastWaitingForDeviceEvent extends Event {
     /**
-     * The `CastPayload` object for the event
+     * The {@link CastPayload} object for the event
      */
     castPayload: CastPayload;
 }
@@ -3254,12 +3258,12 @@ declare class BufferApi {
 }
 
 /**
- * Loads, controls and renders audio and video content represented through `Source`s. A player
- * instance can be created via the `usePlayer` hook and will idle until one or more `Source`s are
- * loaded. Once `load` is called, the player becomes active and initiates necessary downloads to
+ * 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
+ * loaded. Once {@link Player.load} or {@link Player.loadSource} is called, the player becomes active and initiates necessary downloads to
  * start playback of the loaded source(s).
  *
- * Can be attached to `PlayerView` component in order to use Bitmovin's Player Web UI.
+ * Can be attached to {@link PlayerView} component in order to use Bitmovin's Player Web UI.
  * @see PlayerView
  */
 declare class Player extends NativeInstance<PlayerConfig> {
@@ -3295,19 +3299,19 @@ declare class Player extends NativeInstance<PlayerConfig> {
      */
     destroy: () => void;
     /**
-     * Loads a new `Source` from `sourceConfig` into the player.
+     * Loads a new {@link Source} from `sourceConfig` into the player.
      */
     load: (sourceConfig: SourceConfig) => void;
     /**
-     * Loads the downloaded content from `OfflineContentManager` into the player.
+     * Loads the downloaded content from {@link OfflineContentManager} into the player.
      */
     loadOfflineContent: (offlineContentManager: OfflineContentManager, options?: OfflineSourceOptions) => void;
     /**
-     * Loads the given `Source` into the player.
+     * Loads the given {@link Source} into the player.
      */
     loadSource: (source: Source) => void;
     /**
-     * Unloads all `Source`s from the player.
+     * Unloads all {@link Source}s from the player.
      */
     unload: () => void;
     /**
@@ -3334,6 +3338,8 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * Has no effect for VoD.
      *
      * Has no effect if no sources are loaded.
+     *
+     * @param offset - Target offset from the live edge in seconds.
      */
     timeShift: (offset: number) => void;
     /**
@@ -3400,15 +3406,17 @@ declare class Player extends NativeInstance<PlayerConfig> {
      */
     getAudioTrack: () => Promise<AudioTrack | null>;
     /**
-     * @returns An array containing AudioTrack objects for all available audio tracks.
+     * @returns An array containing {@link AudioTrack} objects for all available audio tracks.
      */
     getAvailableAudioTracks: () => Promise<AudioTrack[]>;
     /**
      * Sets the audio track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableAudioTracks.
+     *
+     * @param trackIdentifier - The {@link AudioTrack.identifier} to be set.
      */
     setAudioTrack: (trackIdentifier: string) => Promise<void>;
     /**
-     * @returns The currently selected subtitle track or `null`.
+     * @returns The currently selected {@link SubtitleTrack} or `null`.
      */
     getSubtitleTrack: () => Promise<SubtitleTrack | null>;
     /**
@@ -3417,10 +3425,12 @@ declare class Player extends NativeInstance<PlayerConfig> {
     getAvailableSubtitles: () => Promise<SubtitleTrack[]>;
     /**
      * Sets the subtitle track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableSubtitles.
+     *
+     * @param trackIdentifier - The {@link SubtitleTrack.identifier} to be set.
      */
     setSubtitleTrack: (trackIdentifier?: string) => Promise<void>;
     /**
-     * Dynamically schedules the `adItem` for playback.
+     * Dynamically schedules the {@link AdItem} for playback.
      * Has no effect if there is no active playback session.
      *
      * @param adItem - Ad to be scheduled for playback.
@@ -3441,13 +3451,13 @@ declare class Player extends NativeInstance<PlayerConfig> {
      */
     isAd: () => Promise<boolean>;
     /**
-     * The current time shift of the live stream in seconds. This value is always 0 if the active `source` is not a
+     * The current time shift of the live stream in seconds. This value is always 0 if the active {@link Source} is not a
      * live stream or no sources are loaded.
      */
     getTimeShift: () => Promise<number>;
     /**
      * The limit in seconds for time shifting. This value is either negative or 0 and it is always 0 if the active
-     * `source` is not a live stream or no sources are loaded.
+     * {@link Source} is not a live stream or no sources are loaded.
      */
     getMaxTimeShift: () => Promise<number>;
     /**
@@ -3458,16 +3468,18 @@ declare class Player extends NativeInstance<PlayerConfig> {
      */
     setMaxSelectableBitrate: (bitrate: number | null) => void;
     /**
-     * @returns a `Thumbnail` for the specified playback time for the currently active source if available.
+     * @returns a {@link Thumbnail} for the specified playback time for the currently active source if available.
      * Supported thumbnail formats are:
-     * - `WebVtt` configured via `SourceConfig.thumbnailTrack`, on all supported platforms
+     * - `WebVtt` configured via {@link SourceConfig.thumbnailTrack}, on all supported platforms
      * - HLS `Image Media Playlist` in the multivariant playlist, Android-only
      * - DASH `Image Adaptation Set` as specified in DASH-IF IOP, Android-only
      * If a `WebVtt` thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.
+     *
+     * @param time - The time in seconds for which to retrieve the thumbnail.
      */
     getThumbnail: (time: number) => Promise<Thumbnail | null>;
     /**
-     * Whether casting to a cast-compatible remote device is available. `CastAvailableEvent` signals when
+     * Whether casting to a cast-compatible remote device is available. {@link CastAvailableEvent} signals when
      * casting becomes available.
      *
      * @platform iOS, Android
@@ -3487,7 +3499,7 @@ declare class Player extends NativeInstance<PlayerConfig> {
      */
     castVideo: () => void;
     /**
-     * Stops casting the current video. Has no effect if `isCasting` is false.
+     * Stops casting the current video. Has no effect if {@link Player.isCasting} is `false`.
      *
      * @platform iOS, Android
      */
@@ -3502,6 +3514,14 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * @returns An array containing all available video qualities the player can adapt between.
      */
     getAvailableVideoQualities: () => Promise<VideoQuality[]>;
+    /**
+     * Sets the video quality.
+     * @remarks Only available on 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.
+     */
+    setVideoQuality: (qualityId: String) => void;
     /**
      * Sets the playback speed of the player. Fast forward, slow motion and reverse playback are supported.
      * @note
@@ -3526,7 +3546,7 @@ declare class Player extends NativeInstance<PlayerConfig> {
     getPlaybackSpeed: () => Promise<number>;
     /**
      * Checks the possibility to play the media at specified playback speed.
-     * @param playbackSpeed The playback speed to check.
+     * @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
      */