bitmovin-player-react-native 0.9.2 → 0.10.0

package/lib/index.d.ts

@@ -1,4 +1,15 @@
-import { ViewStyle } from 'react-native';
+import { EmitterSubscription, ViewStyle } from 'react-native';
+
+/**
+ * Configures the adaptation logic.
+ */
+interface AdaptationConfig {
+    /**
+     * The upper bitrate boundary in bits per second for approximate network bandwidth consumption of the played source.
+     * Can be set to `undefined` for no limitation.
+     */
+    maxSelectableBitrate?: number;
+}
 
 /**
  * Quartiles that can be reached during an ad playback.
@@ -1496,6 +1507,38 @@ declare enum LoadingState {
      */
     LOADED = 2
 }
+/**
+ * Types of SourceOptions.
+ */
+interface SourceOptions {
+    /**
+     * The position where the stream should be started.
+     * Number can be positive or negative depending on the used `TimelineReferencePoint`.
+     * Invalid numbers will be corrected according to the stream boundaries.
+     * For VOD this is applied at the time the stream is loaded, for LIVE when playback starts.
+     */
+    startOffset?: number;
+    /**
+     * Sets the Timeline reference point to calculate the startOffset from.
+     * Default for live: `TimelineReferencePoint.END`.
+     * Default for VOD: `TimelineReferencePoint.START`.
+     */
+    startOffsetTimelineReference?: TimelineReferencePoint;
+}
+/**
+ Timeline reference point to calculate SourceOptions.startOffset from.
+ Default for live: TimelineReferencePoint.EBD Default for VOD: TimelineReferencePoint.START.
+ */
+declare enum TimelineReferencePoint {
+    /**
+     * Relative offset will be calculated from the beginning of the stream or DVR window.
+     */
+    START = "start",
+    /**
+     * Relative offset will be calculated from the end of the stream or the live edge in case of a live stream with DVR window.
+     */
+    END = "end"
+}
 /**
  * Represents a source configuration that be loaded into a player instance.
  */
@@ -1537,6 +1580,10 @@ interface SourceConfig extends NativeInstanceConfig {
      * The optional custom metadata. Also sent to the cast receiver when loading the Source.
      */
     metadata?: Record<string, string>;
+    /**
+     * The `SourceOptions` for this configuration.
+     */
+    options?: SourceOptions;
 }
 /**
  * Represents audio and video content that can be loaded into a player.
@@ -1865,6 +1912,324 @@ interface TweaksConfig {
     useFiletypeExtractorFallbackForHls?: boolean;
 }
 
+/**
+ * Contains the state an OfflineContentManager can have.
+ * @platform Android, iOS
+ */
+declare enum OfflineState {
+    /**
+     * The offline content is downloaded and ready for offline playback.
+     */
+    Downloaded = "Downloaded",
+    /**
+     * The offline content is currently downloading.
+     */
+    Downloading = "Downloading",
+    /**
+     * The download of the offline content is suspended, and is only partly downloaded yet.
+     */
+    Suspended = "Suspended",
+    /**
+     * The offline content is not downloaded. However, some data may be still cached.
+     */
+    NotDownloaded = "NotDownloaded"
+}
+
+/**
+ * Represents the configuration to start a download.
+ * @platform Android, iOS
+ */
+interface OfflineDownloadRequest {
+    /**
+     * Minimum video bitrate to download. The nearest higher available bitrate will be selected.
+     */
+    minimumBitrate?: number;
+    /**
+     * Audio tracks with IDs to download.
+     */
+    audioOptionIds?: string[];
+    /**
+     * Text tracks with IDs to download.
+     */
+    textOptionIds?: string[];
+}
+
+/**
+ * Object used to configure a new `OfflineContentManager` instance.
+ * @platform Android, iOS
+ */
+interface OfflineContentConfig extends NativeInstanceConfig {
+    /**
+     * An identifier for this source that is unique within the location and must never change.
+     * The root folder will contain a folder based on this id.
+     */
+    identifier: string;
+    /**
+     * The `SourceConfig` used to download the offline resources.
+     */
+    sourceConfig: SourceConfig;
+}
+
+/**
+ * Object used configure how the native offline managers create and get offline source configurations
+ * @platform Android, iOS
+ */
+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.
+     * @platform iOS
+     */
+    restrictedToAssetCache?: boolean;
+}
+
+/**
+ * Superclass of entries which can be selected to download for offline playback
+ * @platform Android, iOS
+ */
+interface OfflineContentOptionEntry {
+    /**
+     * The ID of the option.
+     */
+    id: string;
+    /**
+     * The language of the option.
+     */
+    language?: string;
+}
+/**
+ * Represents the downloadable options provided via the `onOptionsAvailable` callback on `OfflineContentManagerListener`
+ * @platform Android, iOS
+ */
+interface OfflineContentOptions {
+    /**
+     * Represents the audio options available for download
+     */
+    audioOptions: OfflineContentOptionEntry[];
+    /**
+     * Represents the text options available for download
+     */
+    textOptions: OfflineContentOptionEntry[];
+}
+
+/**
+ * Enum to hold the `eventType` on the `BitmovinNativeOfflineEventData`
+ * @platform Android, iOS
+ */
+declare enum OfflineEventType {
+    onCompleted = "onCompleted",
+    onError = "onError",
+    onProgress = "onProgress",
+    onOptionsAvailable = "onOptionsAvailable",
+    onDrmLicenseUpdated = "onDrmLicenseUpdated",
+    onDrmLicenseExpired = "onDrmLicenseExpired",
+    onSuspended = "onSuspended",
+    onResumed = "onResumed",
+    onCanceled = "onCanceled"
+}
+/**
+ * The base interface for all offline events.
+ * @platform Android, iOS
+ */
+interface OfflineEvent<T extends OfflineEventType> {
+    /**
+     * The native id associated with the `OfflineContentManager` emitting this event
+     */
+    nativeId: string;
+    /**
+     * The supplied id representing the source associated with the `OfflineContentManager` emitting this event.
+     */
+    identifier: string;
+    /**
+     * The `OfflineEventType` that correlates to which native `OfflineContentManagerListener` method was called.
+     */
+    eventType: T;
+    /**
+     * The current offline download state
+     */
+    state: OfflineState;
+}
+/**
+ * Emitted when the download process has completed.
+ * @platform Android, iOS
+ */
+interface OnCompletedEvent extends OfflineEvent<OfflineEventType.onCompleted> {
+    /**
+     * The options that are available to download
+     */
+    options?: OfflineContentOptions;
+}
+/**
+ * Emitted when an error has occurred.
+ * @platform Android, iOS
+ */
+interface OnErrorEvent extends OfflineEvent<OfflineEventType.onError> {
+    /**
+     * The error code of the process error
+     */
+    code?: number;
+    /**
+     * The error message of the process error
+     */
+    message?: string;
+}
+/**
+ * Emitted when there is a progress change for the process call.
+ * @platform Android, iOS
+ */
+interface OnProgressEvent extends OfflineEvent<OfflineEventType.onProgress> {
+    /**
+     * The progress for the current process
+     */
+    progress: number;
+}
+/**
+ * Emitted when the `OfflineContentOptions` is available after a `OfflineContentManager.getOptions` call.
+ * @platform Android, iOS
+ */
+interface OnOptionsAvailableEvent extends OfflineEvent<OfflineEventType.onOptionsAvailable> {
+    /**
+     * The options that are available to download
+     */
+    options?: OfflineContentOptions;
+}
+/**
+ * Emitted when the DRM license was updated.
+ * @platform Android, iOS
+ */
+interface OnDrmLicenseUpdatedEvent extends OfflineEvent<OfflineEventType.onDrmLicenseUpdated> {
+}
+/**
+ * Emitted when the DRM license has expired.
+ * @platform iOS
+ */
+interface OnDrmLicenseExpiredEvent extends OfflineEvent<OfflineEventType.onDrmLicenseExpired> {
+}
+/**
+ * Emitted when all active actions have been suspended.
+ * @platform Android, iOS
+ */
+interface OnSuspendedEvent extends OfflineEvent<OfflineEventType.onSuspended> {
+}
+/**
+ * Emitted when all actions have been resumed.
+ * @platform Android, iOS
+ */
+interface OnResumedEvent extends 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.
+ * @platform Android, iOS
+ */
+interface OnCanceledEvent extends OfflineEvent<OfflineEventType.onCanceled> {
+}
+/**
+ * The type aggregation for all possible native offline events received from the `DeviceEventEmitter`
+ * @platform Android, iOS
+ */
+declare type BitmovinNativeOfflineEventData = OnCompletedEvent | OnOptionsAvailableEvent | OnProgressEvent | OnErrorEvent | OnDrmLicenseUpdatedEvent | OnDrmLicenseExpiredEvent | OnSuspendedEvent | OnResumedEvent | OnCanceledEvent;
+/**
+ * The listener that can be passed to the `OfflineContentManager` to receive callbacks for different events.
+ * @platform Android, iOS
+ */
+interface OfflineContentManagerListener {
+    onCompleted?: (e: OnCompletedEvent) => void;
+    onError?: (e: OnErrorEvent) => void;
+    onProgress?: (e: OnProgressEvent) => void;
+    onOptionsAvailable?: (e: OnOptionsAvailableEvent) => void;
+    onDrmLicenseUpdated?: (e: OnDrmLicenseUpdatedEvent) => void;
+    onDrmLicenseExpired?: (e: OnDrmLicenseExpiredEvent) => void;
+    onSuspended?: (e: OnSuspendedEvent) => void;
+    onResumed?: (e: OnResumedEvent) => void;
+    onCanceled?: (e: OnCanceledEvent) => void;
+}
+declare const handleBitmovinNativeOfflineEvent: (data: BitmovinNativeOfflineEventData, listeners: Set<OfflineContentManagerListener>) => void;
+
+/**
+ * Provides the means to download and store sources locally that can be played back with a Player
+ * without an active network connection. An OfflineContentManager instance can be created via
+ * the constructor and will be idle until initialized.
+ *
+ * @platform Android, iOS
+ */
+declare class OfflineContentManager extends NativeInstance<OfflineContentConfig> {
+    isInitialized: boolean;
+    isDestroyed: boolean;
+    eventSubscription?: EmitterSubscription;
+    listeners: Set<OfflineContentManagerListener>;
+    drm?: Drm;
+    constructor(config: OfflineContentConfig);
+    /**
+     * Allocates the native `OfflineManager` instance and its resources natively.
+     * Registers the `DeviceEventEmitter` listener to receive data from the native `OfflineContentManagerListener` callbacks
+     */
+    initialize: () => Promise<void>;
+    /**
+     * Adds a listener to the receive data from the native `OfflineContentManagerListener` callbacks
+     * Returns a function that removes this listener from the `OfflineContentManager` that registered it.
+     */
+    addListener: (listener: OfflineContentManagerListener) => (() => void);
+    /**
+     * Destroys the native `OfflineManager` and releases all of its allocated resources.
+     */
+    destroy: () => Promise<void>;
+    /**
+     * Gets the current state of the `OfflineContentManager`
+     */
+    state: () => Promise<OfflineState>;
+    /**
+     * Loads the current `OfflineContentOptions`.
+     * When the options are loaded the data will be passed to the `OfflineContentManagerListener.onOptionsAvailable`.
+     */
+    getOptions: () => Promise<void>;
+    /**
+     * Enqueues downloads according to the `OfflineDownloadRequest`.
+     * The promise will reject in the event of null or invalid request parameters.
+     * The promise will reject when calling this method when download has already started or is completed.
+     * The promise will resolve when the download has been queued. The download will is not finished when the promise resolves.
+     */
+    download: (request: OfflineDownloadRequest) => Promise<void>;
+    /**
+     * Resumes all suspended actions.
+     */
+    resume: () => Promise<void>;
+    /**
+     * Suspends all active actions.
+     */
+    suspend: () => Promise<void>;
+    /**
+     * Cancels and deletes the active download.
+     */
+    cancelDownload: () => Promise<void>;
+    /**
+     * Resolves how many bytes of storage are used by the offline content.
+     */
+    usedStorage: () => Promise<number>;
+    /**
+     * Deletes everything related to the related content ID.
+     */
+    deleteAll: () => Promise<void>;
+    /**
+     * Downloads the offline license.
+     * When finished successfully, data will be passed to the `OfflineContentManagerListener.onDrmLicenseUpdated`.
+     * Errors are transmitted to the `OfflineContentManagerListener.onError`.
+     */
+    downloadLicense: () => Promise<void>;
+    /**
+     * Releases the currently held offline license.
+     * When finished successfully data will be passed to the `OfflineContentManagerListener.onDrmLicenseUpdated`.
+     * Errors are transmitted to the `OfflineContentManagerListener.onError`.
+     *
+     * @platform Android
+     */
+    releaseLicense: () => Promise<void>;
+    /**
+     * Renews the already downloaded DRM license.
+     * When finished successfully data will be passed to the `OfflineContentManagerListener.onDrmLicenseUpdated`.
+     * Errors are transmitted to the `OfflineContentManagerListener.onError`.
+     */
+    renewOfflineLicense: () => Promise<void>;
+}
+
 /**
  * Object used to configure a new `Player` instance.
  */
@@ -1908,6 +2273,10 @@ interface PlayerConfig extends NativeInstanceConfig {
      * Configures analytics functionality.
      */
     analyticsConfig?: AnalyticsConfig;
+    /**
+     * Configures adaptation logic.
+     */
+    adaptationConfig?: AdaptationConfig;
 }
 /**
  * Configures the playback behaviour of the player.
@@ -2023,6 +2392,10 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * Loads a new `Source` from `sourceConfig` into the player.
      */
     load: (sourceConfig: SourceConfig) => void;
+    /**
+     * Loads the downloaded content from `OfflineContentManager` into the player.
+     */
+    loadOfflineContent: (offlineContentManager: OfflineContentManager, options?: OfflineSourceOptions) => void;
     /**
      * Loads the given `Source` into the player.
      */
@@ -2163,6 +2536,13 @@ declare class Player extends NativeInstance<PlayerConfig> {
      * `source` is not a live stream or no sources are loaded.
      */
     getMaxTimeShift: () => Promise<number>;
+    /**
+     * Sets the upper bitrate boundary for video qualities. All qualities with a bitrate
+     * that is higher than this threshold will not be eligible for automatic quality selection.
+     *
+     * Can be set to `undefined` for no limitation.
+     */
+    setMaxSelectableBitrate: (bitrate: number | null) => void;
 }
 
 /**
@@ -2270,4 +2650,4 @@ declare function PlayerView({ style, player, fullscreenHandler, customMessageHan
  */
 declare function usePlayer(config?: PlayerConfig): Player;
 
-export { Ad, AdBreak, AdBreakFinishedEvent, AdBreakStartedEvent, AdClickedEvent, AdConfig, AdData, AdErrorEvent, AdFinishedEvent, AdItem, AdManifestLoadEvent, AdManifestLoadedEvent, AdQuartile, AdQuartileEvent, AdScheduledEvent, AdSkippedEvent, AdSource, AdSourceType, AdStartedEvent, AdvertisingConfig, AnalyticsCollector, AnalyticsConfig, AudioAddedEvent, AudioChangedEvent, AudioRemovedEvent, AudioSession, AudioSessionCategory, BasePlayerViewProps, CdnProvider, CustomDataConfig, CustomMessageHandler, DestroyEvent, Drm, DrmConfig, ErrorEvent, Event, EventSource, FairplayConfig, FullscreenDisabledEvent, FullscreenEnabledEvent, FullscreenEnterEvent, FullscreenExitEvent, FullscreenHandler, 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, SourceMetadata, SourceType, SourceUnloadedEvent, SourceWarningEvent, StallEndedEvent, StallStartedEvent, StyleConfig, SubtitleAddedEvent, SubtitleChangedEvent, SubtitleFormat, SubtitleRemovedEvent, SubtitleTrack, TimeChangedEvent, TimeShiftEvent, TimeShiftedEvent, UnmutedEvent, UserInterfaceType, VideoPlaybackQualityChangedEvent, WidevineConfig, usePlayer };
+export { Ad, AdBreak, AdBreakFinishedEvent, AdBreakStartedEvent, AdClickedEvent, AdConfig, AdData, AdErrorEvent, AdFinishedEvent, AdItem, AdManifestLoadEvent, AdManifestLoadedEvent, AdQuartile, AdQuartileEvent, AdScheduledEvent, AdSkippedEvent, AdSource, AdSourceType, AdStartedEvent, AdaptationConfig, AdvertisingConfig, AnalyticsCollector, AnalyticsConfig, AudioAddedEvent, AudioChangedEvent, AudioRemovedEvent, AudioSession, AudioSessionCategory, BasePlayerViewProps, BitmovinNativeOfflineEventData, CdnProvider, CustomDataConfig, CustomMessageHandler, DestroyEvent, Drm, DrmConfig, ErrorEvent, Event, EventSource, FairplayConfig, FullscreenDisabledEvent, FullscreenEnabledEvent, FullscreenEnterEvent, FullscreenExitEvent, FullscreenHandler, LoadingState, MutedEvent, OfflineContentConfig, OfflineContentManager, OfflineContentManagerListener, OfflineContentOptionEntry, OfflineContentOptions, OfflineDownloadRequest, OfflineEvent, OfflineEventType, OfflineSourceOptions, OfflineState, OnCanceledEvent, OnCompletedEvent, OnDrmLicenseExpiredEvent, OnDrmLicenseUpdatedEvent, OnErrorEvent, OnOptionsAvailableEvent, OnProgressEvent, OnResumedEvent, OnSuspendedEvent, 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, SourceMetadata, SourceOptions, SourceType, SourceUnloadedEvent, SourceWarningEvent, StallEndedEvent, StallStartedEvent, StyleConfig, SubtitleAddedEvent, SubtitleChangedEvent, SubtitleFormat, SubtitleRemovedEvent, SubtitleTrack, TimeChangedEvent, TimeShiftEvent, TimeShiftedEvent, TimelineReferencePoint, UnmutedEvent, UserInterfaceType, VideoPlaybackQualityChangedEvent, WidevineConfig, handleBitmovinNativeOfflineEvent, usePlayer };