bitmovin-player-react-native 0.3.1 → 0.5.0

package/lib/index.d.ts

@@ -1,5 +1,480 @@
 import { ViewStyle } from 'react-native';
 
+/**
+ * Quartiles that can be reached during an ad playback.
+ */
+declare enum AdQuartile {
+    FIRST = "first",
+    MID_POINT = "mid_point",
+    THIRD = "third"
+}
+/**
+ * The possible types an `AdSource` can be.
+ */
+declare enum AdSourceType {
+    IMA = "ima",
+    UNKNOWN = "unknown",
+    PROGRESSIVE = "progressive"
+}
+/**
+ * Represents an ad source which can be assigned to an `AdItem`. An `AdItem` can have multiple `AdSource`s
+ * as waterfalling option.
+ */
+interface AdSource {
+    /**
+     * The ad tag / url to the ad manifest.
+     */
+    tag: string;
+    /**
+     * The `AdSourceType` of this `AdSource`.
+     */
+    type: AdSourceType;
+}
+/**
+ * Represents an ad break which can be scheduled for playback.
+ *
+ * One single `AdItem` can have multiple `AdSource`s where all but the first act as fallback ad sources
+ * if the first one fails to load. The start and end of an ad break are signaled via `AdBreakStartedEvent`
+ * and `AdBreakFinishedEvent`.
+ */
+interface AdItem {
+    /**
+     * The playback position at which the ad break is scheduled to start. Default value is "pre".
+     *
+     * Possible values are:
+     *  • "pre": pre-roll ad (for VoD and Live streaming)
+     *  • "post": post-roll ad (for VoD streaming only)
+     *  • fractional seconds: "10", "12.5" (mid-roll ad, for VoD and Live streaming)
+     *  • percentage of the entire video duration: "25%", "50%" (mid-roll ad, for VoD streaming only)
+     *  • timecode hh:mm:ss.mmm: "00:10:30.000", "01:00:00.000" (mid-roll ad, for VoD streaming only)
+     */
+    position?: string;
+    /**
+     * The `AdSource`s that make up this `AdItem`. The first ad source in this array is used as the main ad.
+     * Subsequent ad sources act as a fallback, meaning that if the main ad source does not provide a
+     * valid response, the subsequent ad sources will be utilized one after another.
+     *
+     * The fallback ad sources need to have the same `AdSourceType` as the main ad source.
+     */
+    sources: AdSource[];
+}
+/**
+ * Contains configuration values regarding the ads which should be played back by the player.
+ */
+interface AdvertisingConfig {
+    /**
+     * The ad items that are scheduled when a new playback session is started via `Player.load()`.
+     */
+    schedule: AdItem[];
+}
+/**
+ * Contains the base configuration options for an ad.
+ */
+interface AdConfig {
+    /**
+     * Specifies how many seconds of the main video content should be replaced by ad break(s).
+     */
+    replaceContentDuration: number;
+}
+/**
+ * Holds various additional ad data.
+ */
+interface AdData {
+    /**
+     * The average bitrate of the progressive media file as defined in the VAST response.
+     */
+    bitrate?: number;
+    /**
+     * The maximum bitrate of the streaming media file as defined in the VAST response.
+     */
+    maxBitrate?: number;
+    /**
+     * The MIME type of the media file or creative as defined in the VAST response.
+     */
+    mimeType?: string;
+    /**
+     * The minimum bitrate of the streaming media file as defined in the VAST response.
+     */
+    minBitrate?: number;
+}
+/**
+ * Defines basic properties available for every ad type.
+ */
+interface Ad {
+    /**
+     * The url the user should be redirected to when clicking the ad.
+     */
+    clickThroughUrl?: string;
+    /**
+     * Holds various additional `AdData`.
+     */
+    data?: AdData;
+    /**
+     * The height of the ad.
+     */
+    height: number;
+    /**
+     * Identifier for the ad. This might be autogenerated.
+     */
+    id?: string;
+    /**
+     * Determines whether an ad is linear, i.e. playback of main content needs to be paused for the ad.
+     */
+    isLinear: boolean;
+    /**
+     * The corresponding media file url for the ad.
+     */
+    mediaFileUrl?: string;
+    /**
+     * The width of the ad.
+     */
+    width: number;
+}
+/**
+ * Contains information about an ad break.
+ */
+interface AdBreak {
+    /**
+     * The ads scheduled for this `AdBreak`.
+     */
+    ads: Ad[];
+    /**
+     * The id of the corresponding `AdBreakConfig`. This will be auto-generated.
+     */
+    id: string;
+    /**
+     * The time in seconds in the media timeline the `AdBreak` is scheduled for.
+     */
+    scheduleTime: number;
+}
+
+interface NativeInstanceConfig {
+    /**
+     * Optionally user-defined string `id` for the native instance.
+     * Used to access a certain native instance from any point in the source code then call
+     * methods/properties on it.
+     *
+     * When left empty, a random `UUIDv4` is generated for it.
+     * @example
+     * Accessing or creating the `Player` with `nativeId` equal to `my-player`:
+     * ```
+     * const player = new Player({ nativeId: 'my-player' })
+     * player.play(); // call methods and properties...
+     * ```
+     */
+    nativeId?: string;
+}
+declare abstract class NativeInstance<Config extends NativeInstanceConfig> {
+    /**
+     * Optionally user-defined string `id` for the native instance, or UUIDv4.
+     */
+    readonly nativeId: string;
+    /**
+     * The configuration object used to initialize this instance.
+     */
+    readonly config?: Config;
+    /**
+     * Generate UUID in case the user-defined `nativeId` is empty.
+     */
+    constructor(config?: Config);
+    /**
+     * Flag indicating whether the native resources of this object have been created internally
+     * .i.e `initialize` has been called.
+     */
+    abstract isInitialized: boolean;
+    /**
+     * Create the native object/resources that will be managed by this instance.
+     */
+    abstract initialize(): void;
+    /**
+     * Flag indicating whether the native resources of this object have been disposed .i.e
+     * `destroy` has been called.
+     */
+    abstract isDestroyed: boolean;
+    /**
+     * Dispose the native object/resources created by this instance during `initialize`.
+     */
+    abstract destroy(): void;
+}
+
+/**
+ * Available cdn provider options for AnalyticsConfig.
+ */
+declare enum CdnProvider {
+    BITMOVIN = "bitmovin",
+    AKAMAI = "akamai",
+    FASTLY = "fastly",
+    MAXCDN = "maxcdn",
+    CLOUDFRONT = "cloudfront",
+    CHINACACHE = "chinacache",
+    BITGRAVITY = "bitgravity"
+}
+/**
+ * Object used to configure a new `AnalyticsCollector` instance.
+ */
+interface AnalyticsConfig extends NativeInstanceConfig, CustomDataConfig {
+    /**
+     * CDN Provide that the video playback session is using.
+     */
+    cdnProvider?: CdnProvider;
+    /**
+     * User ID of the customer.
+     */
+    customUserId?: string;
+    /**
+     * Experiment name needed for A/B testing.
+     */
+    experimentName?: string;
+    /**
+     * ID of the video in the CMS system.
+     */
+    videoId?: string;
+    /**
+     * Human readable title of the video asset currently playing.
+     */
+    title?: string;
+    /**
+     * Analytics key.
+     */
+    key: string;
+    /**
+     * Player key.
+     */
+    playerKey?: string;
+    /**
+     * Breadcrumb path to show where in the app the user is.
+     */
+    path?: string;
+    /**
+     * Flag to see if stream is live before stream metadata is available (default: false).
+     */
+    isLive?: boolean;
+    /**
+     * Flag to enable Ad tracking (default: false).
+     */
+    ads?: boolean;
+    /**
+     * Flag to use randomised userId not depending on device specific values (default: false).
+     */
+    randomizeUserId?: boolean;
+}
+interface CustomDataConfig {
+    /**
+     * Optional free-form custom data
+     */
+    customData1?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData2?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData3?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData4?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData5?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData6?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData7?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData8?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData9?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData10?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData11?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData12?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData13?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData14?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData15?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData16?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData17?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData18?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData19?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData20?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData21?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData22?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData23?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData24?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData25?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData26?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData27?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData28?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData29?: string;
+    /**
+     * Optional free-form custom data
+     */
+    customData30?: string;
+}
+
+/**
+ * Analytics collector that can be attached to a player object in order to collect and send
+ * its analytics information.
+ */
+declare class AnalyticsCollector extends NativeInstance<AnalyticsConfig> {
+    /**
+     * Whether the native `AnalyticsCollector` object has been created.
+     */
+    isInitialized: boolean;
+    /**
+     * Whether the native `AnalyticsCollector` object has been disposed.
+     */
+    isDestroyed: boolean;
+    /**
+     * Initializes a native `BitmovinPlayerCollector` object.
+     */
+    initialize: () => void;
+    /**
+     * Disposes the native `BitmovinPlayerCollector` object that has been created
+     * during initialization.
+     */
+    destroy: () => void;
+    /**
+     * Attach a player instance to this analytics plugin. After this is completed, BitmovinAnalytics
+     * will start monitoring and sending analytics data based on the attached player instance.
+     *
+     * @param playerId - Native Id of the player to attach this collector instance.
+     */
+    attach: (playerId: string) => void;
+    /**
+     * Detach a player instance from this analytics plugin if there's any attached. If no player is attached,
+     * nothing happens.
+     */
+    detach: () => void;
+    /**
+     * Dynamically updates analytics custom data information. Use this method
+     * to update your custom data during runtime.
+     *
+     * @param customData - Analytics custom data config.
+     */
+    setCustomDataOnce: (customData: CustomDataConfig) => void;
+    /**
+     * Sets the internal analytics custom data state.
+     *
+     * @param customData - Analytics custom data config.
+     */
+    setCustomData: (customData: CustomDataConfig) => void;
+    /**
+     * Gets the current custom data config from the native `BitmovinPlayerCollector` instance.
+     *
+     * @returns The current custom data config.
+     */
+    getCustomData: () => Promise<CustomDataConfig>;
+    /**
+     * Gets the current user id used by the native `BitmovinPlayerCollector` instance.
+     *
+     * @returns The current user id.
+     */
+    getUserId: () => Promise<string>;
+}
+
+/**
+ * An audio session category defines a set of audio behaviors.
+ * Choose a category that most accurately describes the audio behavior you require.
+ *
+ * Note the `playback` category is required in order to properly enable picture in picture support.
+ *
+ * - `ambient`: The category for an app in which sound playback is nonprimary — that is, your app also works with the sound turned off.
+ * - `multiRoute`: The category for routing distinct streams of audio data to different output devices at the same time.
+ * - `playAndRecord`: The category for recording (input) and playback (output) of audio, such as for a Voice over Internet Protocol (VoIP) app.
+ * - `playback`: The category for playing recorded music or other sounds that are central to the successful use of your app.
+ * - `record`: The category for recording audio while also silencing playback audio.
+ * - `soloAmbient`: The default audio session category.
+ *
+ * @platform iOS
+ * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/category
+ */
+declare type AudioSessionCategory = 'ambient' | 'multiRoute' | 'playAndRecord' | 'playback' | 'record' | 'soloAmbient';
+/**
+ * An object that communicates to the system how you intend to use audio in your app.
+ *
+ * @platform iOS
+ * @see https://developer.apple.com/documentation/avfaudio/avaudiosession
+ */
+declare const AudioSession: {
+    /**
+     * Sets the audio session's category.
+     *
+     * @platform iOS
+     * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/1616583-setcategory
+     */
+    setCategory: (category: AudioSessionCategory) => Promise<void>;
+};
+
 /**
  * Utility type that maps the specified optional props from the target `Type` to be
  * required props. Note all the other props stay unaffected.
@@ -69,6 +544,40 @@ interface SubtitleTrack {
  */
 declare type SideLoadedSubtitleTrack = MakeRequired<SubtitleTrack, 'url' | 'label' | 'language' | 'format'>;
 
+/**
+ * Quality definition of a video representation.
+ */
+interface VideoQuality {
+    /**
+     * The id of the media quality.
+     */
+    id: string;
+    /**
+     * The label of the media quality that should be exposed to the user.
+     */
+    label?: string;
+    /**
+     * The bitrate of the media quality.
+     */
+    bitrate?: number;
+    /**
+     * The codec of the media quality.
+     */
+    codec?: string;
+    /**
+     * The frame rate of the video quality. If the frame rate is not known or not applicable a value of -1 will be returned.
+     */
+    frameRate?: number;
+    /**
+     * The height of the video quality.
+     */
+    height?: number;
+    /**
+     * The width of the video quality.
+     */
+    width?: number;
+}
+
 /**
  * Base event type for all events.
  */
@@ -118,186 +627,419 @@ interface PlayerWarningEvent extends ErrorEvent {
 /**
  * Emitted when the player is destroyed.
  */
-interface DestroyEvent extends Event {
+interface DestroyEvent extends Event {
+}
+/**
+ * Emitted when the player is muted.
+ */
+interface MutedEvent extends Event {
+}
+/**
+ * Emitted when the player is unmuted.
+ */
+interface UnmutedEvent extends Event {
+}
+/**
+ * Emitted when the player is ready for immediate playback, because initial audio/video
+ * has been downloaded.
+ */
+interface ReadyEvent extends Event {
+}
+/**
+ * Emitted when the player is paused.
+ */
+interface PausedEvent extends Event {
+    /**
+     * The player's playback time from when this event happened.
+     */
+    time: number;
+}
+/**
+ * Emitted when the player received an intention to start/resume playback.
+ */
+interface PlayEvent extends Event {
+    /**
+     * The player's playback time from when this event happened.
+     */
+    time: number;
+}
+/**
+ * Emitted when playback has started.
+ */
+interface PlayingEvent extends Event {
+    /**
+     * The player's playback time from when this event happened.
+     */
+    time: number;
+}
+/**
+ * Emitted when the playback of the current media has finished.
+ */
+interface PlaybackFinishedEvent extends Event {
+}
+/**
+ * Source object representation the way it appears on `Event` payloads such as `SeekEvent`, for example.
+ *
+ * This interface only type hints what should be the shape of a `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.
+ */
+interface EventSource {
+    /**
+     * Event's source duration in seconds.
+     */
+    duration: number;
+    /**
+     * Whether this event's source is currently active in a player.
+     */
+    isActive: boolean;
+    /**
+     * Whether this event's source is currently attached to a player instance.
+     */
+    isAttachedToPlayer: boolean;
+    /**
+     * Metadata for this event's source.
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * Emitted when the player is about to seek to a new position.
+ * Only applies to VoD streams.
+ */
+interface SeekEvent extends Event {
+    /**
+     * Removed source metadata.
+     */
+    from: {
+        time: number;
+        source: EventSource;
+    };
+    /**
+     * Added source metadata.
+     */
+    to: {
+        time: number;
+        source: EventSource;
+    };
+}
+/**
+ * Emitted when seeking has finished and data to continue playback is available.
+ * Only applies to VoD streams.
+ */
+interface SeekedEvent extends Event {
+}
+/**
+ * Emitted when the player begins to stall and to buffer due to an empty buffer.
+ */
+interface StallStartedEvent extends Event {
+}
+/**
+ * Emitted when the player ends stalling, due to enough data in the buffer.
+ */
+interface StallEndedEvent extends Event {
+}
+/**
+ * Emitted when the current playback time has changed.
+ */
+interface TimeChangedEvent extends Event {
+    /**
+     * The player's playback time from when this event happened.
+     */
+    currentTime: number;
+}
+/**
+ * Emitted when a new source loading has started.
+ * It doesn't mean that the loading of the new manifest has finished.
+ */
+interface SourceLoadEvent extends Event {
+    /**
+     * Source that is about to load.
+     */
+    source: EventSource;
+}
+/**
+ * Emitted when a new source is loaded.
+ * It doesn't mean that the loading of the new manifest has finished.
+ */
+interface SourceLoadedEvent extends Event {
+    /**
+     * Source that was loaded into player.
+     */
+    source: EventSource;
+}
+/**
+ * Emitted when the current source has been unloaded.
+ */
+interface SourceUnloadedEvent extends Event {
+    /**
+     * Source that was unloaded from player.
+     */
+    source: EventSource;
+}
+/**
+ * Emitted when a source error happens.
+ */
+interface SourceErrorEvent extends ErrorEvent {
+}
+/**
+ * Emitted when a source warning happens.
+ */
+interface SourceWarningEvent extends ErrorEvent {
+}
+/**
+ * Emitted when a new subtitle track is added to the player.
+ */
+interface SubtitleAddedEvent extends Event {
+    /**
+     * Subtitle track that has been added.
+     */
+    subtitleTrack: SubtitleTrack;
+}
+/**
+ * Emitted when a subtitle track is removed from the player.
+ */
+interface SubtitleRemovedEvent extends Event {
+    /**
+     * Subtitle track that has been removed.
+     */
+    subtitleTrack: SubtitleTrack;
+}
+/**
+ * Emitted when the player's selected subtitle track has changed.
+ */
+interface SubtitleChangedEvent extends Event {
+    /**
+     * Subtitle track that was previously selected.
+     */
+    oldSubtitleTrack: SubtitleTrack;
+    /**
+     * Subtitle track that is selected now.
+     */
+    newSubtitleTrack: SubtitleTrack;
+}
+/**
+ * Emitted when the player enters Picture in Picture mode.
+ *
+ * @platform iOS, Android
+ */
+interface PictureInPictureEnterEvent extends Event {
+}
+/**
+ * Emitted when the player exits Picture in Picture mode.
+ *
+ * @platform iOS, Android
+ */
+interface PictureInPictureExitEvent extends Event {
+}
+/**
+ * Emitted when the player has finished entering Picture in Picture mode on iOS.
+ *
+ * @platform iOS
+ */
+interface PictureInPictureEnteredEvent extends Event {
+}
+/**
+ * Emitted when the player has finished exiting Picture in Picture mode on iOS.
+ *
+ * @platform iOS
+ */
+interface PictureInPictureExitedEvent extends Event {
+}
+/**
+ * Emitted when the fullscreen functionality has been enabled.
+ *
+ * @platform iOS, Android
+ */
+interface FullscreenEnabledEvent extends Event {
 }
 /**
- * Emitted when the player is muted.
+ * Emitted when the fullscreen functionality has been disabled.
+ *
+ * @platform iOS, Android
  */
-interface MutedEvent extends Event {
+interface FullscreenDisabledEvent extends Event {
 }
 /**
- * Emitted when the player is unmuted.
+ * Emitted when the player enters fullscreen mode.
+ *
+ * @platform iOS, Android
  */
-interface UnmutedEvent extends Event {
+interface FullscreenEnterEvent extends Event {
 }
 /**
- * Emitted when the player is ready for immediate playback, because initial audio/video
- * has been downloaded.
+ * Emitted when the player exits fullscreen mode.
+ *
+ * @platform iOS, Android
  */
-interface ReadyEvent extends Event {
+interface FullscreenExitEvent extends Event {
 }
 /**
- * Emitted when the player is paused.
+ * Emitted when the availability of the Picture in Picture mode changed on Android.
+ *
+ * @platform Android
  */
-interface PausedEvent extends Event {
+interface PictureInPictureAvailabilityChangedEvent extends Event {
     /**
-     * The player's playback time from when this event happened.
+     * Whether Picture in Picture is available.
      */
-    time: number;
+    isPictureInPictureAvailable: boolean;
 }
 /**
- * Emitted when the player received an intention to start/resume playback.
+ * Emitted when an ad break has started.
  */
-interface PlayEvent extends Event {
+interface AdBreakStartedEvent extends Event {
     /**
-     * The player's playback time from when this event happened.
+     * The `AdBreak` that has started.
      */
-    time: number;
+    adBreak?: AdBreak;
 }
 /**
- * Emitted when playback has started.
+ * Emitted when an ad break has finished.
  */
-interface PlayingEvent extends Event {
+interface AdBreakFinishedEvent extends Event {
     /**
-     * The player's playback time from when this event happened.
+     * The `AdBreak` that has finished.
      */
-    time: number;
+    adBreak?: AdBreak;
 }
 /**
- * Emitted when the playback of the current media has finished.
- */
-interface PlaybackFinishedEvent extends Event {
-}
-/**
- * Source object representation the way it appears on `Event` payloads such as `SeekEvent`, for example.
- *
- * This interface only type hints what should be the shape of a `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.
+ * Emitted when the playback of an ad has started.
  */
-interface EventSource {
+interface AdStartedEvent extends Event {
     /**
-     * Event's source duration in seconds.
+     * The `Ad` this event is related to.
      */
-    duration: number;
+    ad?: Ad;
     /**
-     * Whether this event's source is currently active in a player.
+     * The target URL to open once the user clicks on the ad.
      */
-    isActive: boolean;
+    clickThroughUrl?: string;
     /**
-     * Whether this event's source is currently attached to a player instance.
+     * The `AdSourceType` of the started `Ad`.
      */
-    isAttachedToPlayer: boolean;
+    clientType?: AdSourceType;
     /**
-     * Metadata for this event's source.
+     * The duration of the ad in seconds.
      */
-    metadata?: Record<string, any>;
-}
-/**
- * Emitted when the player is about to seek to a new position.
- * Only applies to VoD streams.
- */
-interface SeekEvent extends Event {
+    duration: number;
     /**
-     * Removed source metadata.
+     * The index of the ad in the queue.
      */
-    from: {
-        time: number;
-        source: EventSource;
-    };
+    indexInQueue: number;
     /**
-     * Added source metadata.
+     * The position of the corresponding `Ad`.
      */
-    to: {
-        time: number;
-        source: EventSource;
-    };
-}
-/**
- * Emitted when seeking has finished and data to continue playback is available.
- * Only applies to VoD streams.
- */
-interface SeekedEvent extends Event {
+    position?: string;
+    /**
+     * The skip offset of the ad in seconds.
+     */
+    skipOffset: number;
+    /**
+     * The content time at which the `Ad` is played.
+     */
+    timeOffset: number;
 }
 /**
- * Emitted when the current playback time has changed.
+ * Emitted when an ad has finished playback.
  */
-interface TimeChangedEvent extends Event {
+interface AdFinishedEvent extends Event {
     /**
-     * The player's playback time from when this event happened.
+     * The `Ad` that finished playback.
      */
-    currentTime: number;
+    ad?: Ad;
 }
 /**
- * Emitted when a new source loading has started.
- * It doesn't mean that the loading of the new manifest has finished.
+ * Emitted when an error with the ad playback occurs.
  */
-interface SourceLoadEvent extends Event {
+interface AdErrorEvent extends ErrorEvent {
     /**
-     * Source that is about to load.
+     * The `AdConfig` for which the ad error occurred.
      */
-    source: EventSource;
+    adConfig?: AdConfig;
+    /**
+     * The `AdItem` for which the ad error occurred.
+     */
+    adItem?: AdItem;
 }
 /**
- * Emitted when a new source is loaded.
- * It doesn't mean that the loading of the new manifest has finished.
+ * Emitted when an ad was clicked.
  */
-interface SourceLoadedEvent extends Event {
+interface AdClickedEvent extends Event {
     /**
-     * Source that was loaded into player.
+     * The click through url of the ad.
      */
-    source: EventSource;
+    clickThroughUrl?: string;
 }
 /**
- * Emitted when the current source has been unloaded.
+ * Emitted when an ad was skipped.
  */
-interface SourceUnloadedEvent extends Event {
+interface AdSkippedEvent extends Event {
     /**
-     * Source that was unloaded from player.
+     * The `Ad` that was skipped.
      */
-    source: EventSource;
+    ad?: Ad;
 }
 /**
- * Emitted when a source error happens.
+ * Emitted when the playback of an ad has progressed over a quartile boundary.
  */
-interface SourceErrorEvent extends ErrorEvent {
+interface AdQuartileEvent extends Event {
+    /**
+     * The `AdQuartile` boundary that playback has progressed over.
+     */
+    quartile: AdQuartile;
 }
 /**
- * Emitted when a source warning happens.
+ * Emitted when an ad manifest was successfully downloaded, parsed and added into the ad break schedule.
  */
-interface SourceWarningEvent extends ErrorEvent {
+interface AdScheduledEvent extends Event {
+    /**
+     * The total number of scheduled ads.
+     */
+    numberOfAds: number;
 }
 /**
- * Emitted when a new subtitle track is added to the player.
+ * Emitted when the download of an ad manifest is started.
  */
-interface SubtitleAddedEvent extends Event {
+interface AdManifestLoadEvent extends Event {
     /**
-     * Subtitle track that has been added.
+     * The `AdBreak` this event is related to.
      */
-    subtitleTrack: SubtitleTrack;
+    adBreak?: AdBreak;
+    /**
+     * The `AdConfig` of the loaded ad manifest.
+     */
+    adConfig?: AdConfig;
 }
 /**
- * Emitted when a subtitle track is removed from the player.
+ * Emitted when an ad manifest was successfully loaded.
  */
-interface SubtitleRemovedEvent extends Event {
+interface AdManifestLoadedEvent extends Event {
     /**
-     * Subtitle track that has been removed.
+     * The `AdBreak` this event is related to.
      */
-    subtitleTrack: SubtitleTrack;
+    adBreak?: AdBreak;
+    /**
+     * The `AdConfig` of the loaded ad manifest.
+     */
+    adConfig?: AdConfig;
+    /**
+     * How long it took for the ad tag to be downloaded in milliseconds.
+     */
+    downloadTime: number;
 }
 /**
- * Emitted when the player's selected subtitle track has changed.
+ * Emitted when the current video playback quality has changed.
  */
-interface SubtitleChangedEvent extends Event {
+interface VideoPlaybackQualityChangedEvent extends Event {
     /**
-     * Subtitle track that was previously selected.
+     * The new quality
      */
-    oldSubtitleTrack: SubtitleTrack;
+    newVideoQuality: VideoQuality;
     /**
-     * Subtitle track that is selected now.
+     * The previous quality
      */
-    newSubtitleTrack: SubtitleTrack;
+    oldVideoQuality: VideoQuality;
 }
 
 /**
@@ -305,10 +1047,30 @@ interface SubtitleChangedEvent extends Event {
  * Used to generate the specific events interface for each component.
  */
 interface EventProps {
+    onAdBreakFinished: AdBreakFinishedEvent;
+    onAdBreakStarted: AdBreakStartedEvent;
+    onAdClicked: AdClickedEvent;
+    onAdError: AdErrorEvent;
+    onAdFinished: AdFinishedEvent;
+    onAdManifestLoad: AdManifestLoadEvent;
+    onAdManifestLoaded: AdManifestLoadedEvent;
+    onAdQuartile: AdQuartileEvent;
+    onAdScheduled: AdScheduledEvent;
+    onAdSkipped: AdSkippedEvent;
+    onAdStarted: AdStartedEvent;
     onDestroy: DestroyEvent;
     onEvent: Event;
+    onFullscreenEnabled: FullscreenEnabledEvent;
+    onFullscreenDisabled: FullscreenDisabledEvent;
+    onFullscreenEnter: FullscreenEnterEvent;
+    onFullscreenExit: FullscreenExitEvent;
     onMuted: MutedEvent;
     onPaused: PausedEvent;
+    onPictureInPictureAvailabilityChanged: PictureInPictureAvailabilityChangedEvent;
+    onPictureInPictureEnter: PictureInPictureEnterEvent;
+    onPictureInPictureEntered: PictureInPictureEnteredEvent;
+    onPictureInPictureExit: PictureInPictureExitEvent;
+    onPictureInPictureExited: PictureInPictureExitedEvent;
     onPlay: PlayEvent;
     onPlaybackFinished: PlaybackFinishedEvent;
     onPlayerActive: PlayerActiveEvent;
@@ -318,6 +1080,8 @@ interface EventProps {
     onReady: ReadyEvent;
     onSeek: SeekEvent;
     onSeeked: SeekedEvent;
+    onStallStarted: StallStartedEvent;
+    onStallEnded: StallEndedEvent;
     onSourceError: SourceErrorEvent;
     onSourceLoad: SourceLoadEvent;
     onSourceLoaded: SourceLoadedEvent;
@@ -328,6 +1092,7 @@ interface EventProps {
     onSubtitleRemoved: SubtitleRemovedEvent;
     onTimeChanged: TimeChangedEvent;
     onUnmuted: UnmutedEvent;
+    onVideoPlaybackQualityChanged: VideoPlaybackQualityChangedEvent;
 }
 /**
  * Event props for `PlayerView`.
@@ -339,55 +1104,6 @@ declare type PlayerViewEvents = {
     [Prop in keyof EventProps]?: (event: EventProps[Prop]) => void;
 };
 
-interface NativeInstanceConfig {
-    /**
-     * Optionally user-defined string `id` for the native instance.
-     * Used to access a certain native instance from any point in the source code then call
-     * methods/properties on it.
-     *
-     * When left empty, a random `UUIDv4` is generated for it.
-     * @example
-     * Accessing or creating the `Player` with `nativeId` equal to `my-player`:
-     * ```
-     * const player = new Player({ nativeId: 'my-player' })
-     * player.play(); // call methods and properties...
-     * ```
-     */
-    nativeId?: string;
-}
-declare abstract class NativeInstance<Config extends NativeInstanceConfig> {
-    /**
-     * Optionally user-defined string `id` for the native instance, or UUIDv4.
-     */
-    readonly nativeId: string;
-    /**
-     * The configuration object used to initialize this instance.
-     */
-    readonly config?: Config;
-    /**
-     * Generate UUID in case the user-defined `nativeId` is empty.
-     */
-    constructor(config?: Config);
-    /**
-     * Flag indicating whether the native resources of this object have been created internally
-     * .i.e `initialize` has been called.
-     */
-    abstract isInitialized: boolean;
-    /**
-     * Create the native object/resources that will be managed by this instance.
-     */
-    abstract initialize(): void;
-    /**
-     * Flag indicating whether the native resources of this object have been disposed .i.e
-     * `destroy` has been called.
-     */
-    abstract isDestroyed: boolean;
-    /**
-     * Dispose the native object/resources created by this instance during `initialize`.
-     */
-    abstract destroy(): void;
-}
-
 /**
  * Represents a FairPlay Streaming DRM config.
  */
@@ -686,6 +1402,10 @@ interface SourceConfig extends NativeInstanceConfig {
      * External subtitle tracks to be added into the player.
      */
     subtitleTracks?: SideLoadedSubtitleTrack[];
+    /**
+     * External thumbnails to be added into the player.
+     */
+    thumbnailTrack?: string;
 }
 /**
  * Represents audio and video content that can be loaded into a player.
@@ -740,6 +1460,93 @@ declare class Source extends NativeInstance<SourceConfig> {
     loadingState: () => Promise<LoadingState>;
 }
 
+/**
+ * Contains config values which can be used to alter the visual presentation and behaviour of the player UI.
+ */
+interface StyleConfig {
+    /**
+     * Sets if the UI should be enabled or not. Default value is true.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     isUiEnabled: false,
+     *   },
+     * });
+     * ```
+     */
+    isUiEnabled?: boolean;
+    /**
+     * Set the CSS file that will be used for the UI. The default CSS file will be completely replaced by the CSS file set with this property.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     playerUiCss: 'https://domain.tld/path/to/bitmovinplayer-ui.css',
+     *   },
+     * });
+     * ```
+     * @platform iOS, Android
+     */
+    playerUiCss?: string;
+    /**
+     * Set a CSS file which contains supplemental styles for the player UI. These styles will be added to the default CSS file or the CSS file set with StyleConfig#playerUiCss.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     supplementalPlayerUiCss: 'https://domain.tld/path/to/bitmovinplayer-supplemental-ui.css',
+     *   },
+     * });
+     * ```
+     * @platform iOS, Android
+     */
+    supplementalPlayerUiCss?: string;
+    /**
+     * Sets the JS file that will be used for the UI. The default JS file will be completely replaced by the JS file set with this property.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     playerUiJs: 'https://domain.tld/path/to/bitmovinplayer-ui.js',
+     *   },
+     * });
+     * ```
+     * @platform iOS, Android
+     */
+    playerUiJs?: string;
+    /**
+     * Determines how the video content is scaled or stretched within the parent container’s bounds.  Possible values are defined in ScalingMode.
+     * Default value is ScalingMode.fit.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     scalingMode: ScalingMode.Zoom,
+     *   },
+     * });
+     * ```
+     */
+    scalingMode?: ScalingMode;
+}
+/**
+ * Specifies how the video content is scaled or stretched.
+ */
+declare enum ScalingMode {
+    /**
+     * Specifies that the player should preserve the video’s aspect ratio and fit the video within the container's bounds.
+     */
+    Fit = "Fit",
+    /**
+     * Specifies that the video should be stretched to fill the container’s bounds. The aspect ratio may not be preserved.
+     */
+    Stretch = "Stretch",
+    /**
+     * Specifies that the player should preserve the video’s aspect ratio and fill the container’s bounds.
+     */
+    Zoom = "Zoom"
+}
+
 /**
  * This configuration is used as an incubator for experimental features. Tweaks are not officially
  * supported and are not guaranteed to be stable, i.e. their naming, functionality and API can
@@ -921,10 +1728,22 @@ interface PlayerConfig extends NativeInstanceConfig {
      * Configures playback behaviour. A default PlaybackConfig is set initially.
      */
     playbackConfig?: PlaybackConfig;
+    /**
+     * Configures the visual presentation and behaviour of the player UI. A default StyleConfig is set initially.
+     */
+    styleConfig?: StyleConfig;
+    /**
+     * Configures advertising functionality. A default AdvertisingConfig is set initially.
+     */
+    advertisingConfig?: AdvertisingConfig;
     /**
      * Configures experimental features. A default TweaksConfig is set initially.
      */
     tweaksConfig?: TweaksConfig;
+    /**
+     * Configures analytics functionality.
+     */
+    analyticsConfig?: AnalyticsConfig;
 }
 /**
  * Configures the playback behaviour of the player.
@@ -990,7 +1809,7 @@ interface PlaybackConfig {
      */
     isBackgroundPlaybackEnabled?: boolean;
     /**
-     * Whether the picture-in-picture mode option is enabled for iOS or not. Default is `false`.
+     * Whether the Picture in Picture mode option is enabled or not. Default is `false`.
      *  @example
      * ```
      * const player = new Player({
@@ -1016,6 +1835,10 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * Currently active source, or `null` if none is active.
      */
     source?: Source;
+    /**
+     * Analytics collector currently attached to this player instance.
+     */
+    analyticsCollector?: AnalyticsCollector;
     /**
      * Whether the native `Player` object has been created.
      */
@@ -1123,6 +1946,45 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * @returns An array containing SubtitleTrack objects for all available subtitle tracks.
      */
     getAvailableSubtitles: () => Promise<SubtitleTrack[]>;
+    /**
+     * Dynamically schedules the `adItem` for playback.
+     * Has no effect if there is no active playback session.
+     *
+     * @param adItem - Ad to be scheduled for playback.
+     *
+     * @platform iOS, Android
+     */
+    scheduleAd: (adItem: AdItem) => void;
+    /**
+     * 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
+     */
+    skipAd: () => void;
+    /**
+     * @returns `true` while an ad is being played back or when main content playback has been paused for ad playback.
+     * @platform iOS, Android
+     */
+    isAd: () => Promise<boolean>;
+}
+
+/**
+ * Handles the UI state change when fullscreen should be entered or exited.
+ */
+interface FullscreenHandler {
+    /**
+     * Indicates if the UI is currently in fullscreen mode
+     */
+    isFullscreenActive: boolean;
+    /**
+     * Is called by the `PlayerView` when the UI should enter fullscreen mode.
+     */
+    enterFullscreen(): void;
+    /**
+     * Is called by the `PlayerView` when the UI should exit fullscreen mode.
+     */
+    exitFullscreen(): void;
 }
 
 /**
@@ -1143,12 +2005,13 @@ interface PlayerViewProps extends BasePlayerViewProps, PlayerViewEvents {
      * and render audio/video inside the `PlayerView`.
      */
     player: Player;
+    fullscreenHandler?: FullscreenHandler;
 }
 /**
  * Component that provides the Bitmovin Player UI and default UI handling to an attached `Player` instance.
  * This component needs a `Player` instance to work properly so make sure one is passed to it as a prop.
  */
-declare function PlayerView(props: PlayerViewProps): JSX.Element;
+declare function PlayerView({ style, player, fullscreenHandler, ...props }: PlayerViewProps): JSX.Element;
 
 /**
  * React hook that creates and returns a reference to a `Player` instance
@@ -1156,4 +2019,4 @@ declare function PlayerView(props: PlayerViewProps): JSX.Element;
  */
 declare function usePlayer(config?: PlayerConfig): Player;
 
-export { BasePlayerViewProps, DestroyEvent, Drm, DrmConfig, ErrorEvent, Event, EventSource, FairplayConfig, LoadingState, MutedEvent, PausedEvent, PlayEvent, PlaybackConfig, PlaybackFinishedEvent, Player, PlayerActiveEvent, PlayerConfig, PlayerErrorEvent, PlayerView, PlayerViewProps, PlayerWarningEvent, PlayingEvent, ReadyEvent, SeekEvent, SeekedEvent, SideLoadedSubtitleTrack, Source, SourceConfig, SourceErrorEvent, SourceLoadEvent, SourceLoadedEvent, SourceType, SourceUnloadedEvent, SourceWarningEvent, SubtitleAddedEvent, SubtitleChangedEvent, SubtitleFormat, SubtitleRemovedEvent, SubtitleTrack, TimeChangedEvent, UnmutedEvent, WidevineConfig, usePlayer };
+export { Ad, AdBreak, AdBreakFinishedEvent, AdBreakStartedEvent, AdClickedEvent, AdConfig, AdData, AdErrorEvent, AdFinishedEvent, AdItem, AdManifestLoadEvent, AdManifestLoadedEvent, AdQuartile, AdQuartileEvent, AdScheduledEvent, AdSkippedEvent, AdSource, AdSourceType, AdStartedEvent, AdvertisingConfig, AnalyticsCollector, AnalyticsConfig, AudioSession, AudioSessionCategory, BasePlayerViewProps, CdnProvider, CustomDataConfig, DestroyEvent, Drm, DrmConfig, ErrorEvent, Event, EventSource, FairplayConfig, FullscreenDisabledEvent, FullscreenEnabledEvent, FullscreenEnterEvent, FullscreenExitEvent, LoadingState, MutedEvent, PausedEvent, PictureInPictureAvailabilityChangedEvent, PictureInPictureEnterEvent, PictureInPictureEnteredEvent, PictureInPictureExitEvent, PictureInPictureExitedEvent, PlayEvent, PlaybackConfig, PlaybackFinishedEvent, Player, PlayerActiveEvent, PlayerConfig, PlayerErrorEvent, PlayerView, PlayerViewProps, PlayerWarningEvent, PlayingEvent, ReadyEvent, ScalingMode, SeekEvent, SeekedEvent, SideLoadedSubtitleTrack, Source, SourceConfig, SourceErrorEvent, SourceLoadEvent, SourceLoadedEvent, SourceType, SourceUnloadedEvent, SourceWarningEvent, StallEndedEvent, StallStartedEvent, StyleConfig, SubtitleAddedEvent, SubtitleChangedEvent, SubtitleFormat, SubtitleRemovedEvent, SubtitleTrack, TimeChangedEvent, UnmutedEvent, VideoPlaybackQualityChangedEvent, WidevineConfig, usePlayer };