bitmovin-player-react-native 0.44.1-alpha.0 → 1.0.0-alpha.0

package/build/source.d.ts

@@ -0,0 +1,216 @@
+import { DrmConfig } from './drm';
+import NativeInstance, { NativeInstanceConfig } from './nativeInstance';
+import { SideLoadedSubtitleTrack } from './subtitleTrack';
+import { Thumbnail } from './thumbnail';
+import { SourceMetadata } from './analytics';
+/**
+ * Types of media that can be handled by the player.
+ */
+export declare enum SourceType {
+    /**
+     * Indicates a missing source type.
+     */
+    NONE = "none",
+    /**
+     * Indicates media type HLS.
+     */
+    HLS = "hls",
+    /**
+     * Indicates media type DASH.
+     */
+    DASH = "dash",
+    /**
+     * Indicates media type Progressive MP4.
+     */
+    PROGRESSIVE = "progressive"
+}
+/**
+ * The different loading states a {@link Source} instance can be in.
+ */
+export declare enum LoadingState {
+    /**
+     * The source is unloaded.
+     */
+    UNLOADED = 0,
+    /**
+     * The source is currently loading.
+     */
+    LOADING = 1,
+    /**
+     * The source is loaded.
+     */
+    LOADED = 2
+}
+/**
+ * Types of SourceOptions.
+ */
+export 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.
+ */
+export 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.
+ */
+export interface SourceConfig extends NativeInstanceConfig {
+    /**
+     *  The url for this source configuration.
+     */
+    url: string;
+    /**
+     * The `SourceType` for this configuration.
+     */
+    type?: SourceType;
+    /**
+     * The title of the video source.
+     */
+    title?: string;
+    /**
+     * The description of the video source.
+     */
+    description?: string;
+    /**
+     * The URL to a preview image displayed until the video starts.
+     */
+    poster?: string;
+    /**
+     * Indicates whether to show the poster image during playback.
+     * Useful, for example, for audio-only streams.
+     */
+    isPosterPersistent?: boolean;
+    /**
+     * The DRM config for the source.
+     */
+    drmConfig?: DrmConfig;
+    /**
+     * External subtitle tracks to be added into the player.
+     */
+    subtitleTracks?: SideLoadedSubtitleTrack[];
+    /**
+     * External thumbnails to be added into the player.
+     */
+    thumbnailTrack?: string;
+    /**
+     * 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;
+    /**
+     * The `SourceMetadata` for the {@link Source} to setup custom analytics tracking
+     */
+    analyticsSourceMetadata?: SourceMetadata;
+}
+/**
+ * The remote control config for a source.
+ * @remarks Platform: iOS
+ */
+export interface SourceRemoteControlConfig {
+    /**
+     * The `SourceConfig` for casting.
+     * Enables to play different content when casting.
+     * This can be useful when the remote playback device supports different streaming formats,
+     * DRM systems, etc. than the local device.
+     * If not set, the local source config will be used for casting.
+     */
+    castSourceConfig?: SourceConfig | null;
+}
+/**
+ * Represents audio and video content that can be loaded into a player.
+ */
+export declare class Source extends NativeInstance<SourceConfig> {
+    /**
+     * The native DRM config reference of this source.
+     */
+    private drm?;
+    /**
+     * The remote control config for this source.
+     * This is only supported on iOS.
+     *
+     * @remarks Platform: iOS
+     */
+    remoteControl: SourceRemoteControlConfig | null;
+    /**
+     * Whether the native {@link Source} object has been created.
+     */
+    isInitialized: boolean;
+    /**
+     * Whether the native {@link Source} object has been disposed.
+     */
+    isDestroyed: boolean;
+    /**
+     * Allocates the native {@link Source} instance and its resources natively.
+     */
+    initialize: () => Promise<void>;
+    /**
+     * Destroys the native {@link Source} and releases all of its allocated resources.
+     */
+    destroy: () => void;
+    /**
+     * The duration of the source in seconds if it’s a VoD or `INFINITY` if it’s a live stream.
+     * Default value is `0` if the duration is not available or not known.
+     */
+    duration: () => Promise<number>;
+    /**
+     * Whether the source is currently active in a player (i.e. playing back or paused).
+     * Only one source can be active in the same player instance at any time.
+     */
+    isActive: () => Promise<boolean>;
+    /**
+     * Whether the source is currently attached to a player instance.
+     */
+    isAttachedToPlayer: () => Promise<boolean>;
+    /**
+     * Metadata for the currently loaded source.
+     */
+    metadata: () => Promise<Record<string, any> | null>;
+    /**
+     * 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;
+    /**
+     * The current `LoadingState` of the source.
+     */
+    loadingState: () => Promise<LoadingState>;
+    /**
+     * @returns a `Thumbnail` for the specified playback time if available.
+     * Supported thumbnail formats are:
+     * - `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>;
+}
+//# sourceMappingURL=source.d.ts.map

package/build/source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,cAAc,EAAE,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C;;GAEG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,WAAW,gBAAgB;CAC5B;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,OAAO,IAAI;IACX;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,sBAAsB,CAAC;CACvD;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,oBAAoB;IACxD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB;;OAEG;IACH,uBAAuB,CAAC,EAAE,cAAc,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CACxC;AAED;;GAEG;AACH,qBAAa,MAAO,SAAQ,cAAc,CAAC,YAAY,CAAC;IACtD;;OAEG;IACH,OAAO,CAAC,GAAG,CAAC,CAAM;IAClB;;;;;OAKG;IACH,aAAa,EAAE,yBAAyB,GAAG,IAAI,CAAQ;IACvD;;OAEG;IACH,aAAa,UAAS;IACtB;;OAEG;IACH,WAAW,UAAS;IAEpB;;OAEG;IACH,UAAU,QAAa,OAAO,CAAC,IAAI,CAAC,CA0BlC;IAEF;;OAEG;IACH,OAAO,aAML;IAEF;;;OAGG;IACH,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,CAElC;IAEF;;;OAGG;IACH,QAAQ,QAAa,OAAO,CAAC,OAAO,CAAC,CAEnC;IAEF;;OAEG;IACH,kBAAkB,QAAa,OAAO,CAAC,OAAO,CAAC,CAE7C;IAEF;;OAEG;IACH,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,CAEtD;IAEF;;;;;OAKG;IACH,WAAW,GAAI,UAAU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,KAAG,IAAI,CAExD;IAEF;;OAEG;IACH,YAAY,QAAa,OAAO,CAAC,YAAY,CAAC,CAI5C;IAEF;;;;;;;;;OASG;IACH,YAAY,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAE5D;CACH"}

package/build/source.js

@@ -0,0 +1,167 @@
+import { Drm } from './drm';
+import NativeInstance from './nativeInstance';
+import SourceModule from './modules/SourceModule';
+/**
+ * Types of media that can be handled by the player.
+ */
+export var SourceType;
+(function (SourceType) {
+    /**
+     * Indicates a missing source type.
+     */
+    SourceType["NONE"] = "none";
+    /**
+     * Indicates media type HLS.
+     */
+    SourceType["HLS"] = "hls";
+    /**
+     * Indicates media type DASH.
+     */
+    SourceType["DASH"] = "dash";
+    /**
+     * Indicates media type Progressive MP4.
+     */
+    SourceType["PROGRESSIVE"] = "progressive";
+})(SourceType || (SourceType = {}));
+/**
+ * The different loading states a {@link Source} instance can be in.
+ */
+export var LoadingState;
+(function (LoadingState) {
+    /**
+     * The source is unloaded.
+     */
+    LoadingState[LoadingState["UNLOADED"] = 0] = "UNLOADED";
+    /**
+     * The source is currently loading.
+     */
+    LoadingState[LoadingState["LOADING"] = 1] = "LOADING";
+    /**
+     * The source is loaded.
+     */
+    LoadingState[LoadingState["LOADED"] = 2] = "LOADED";
+})(LoadingState || (LoadingState = {}));
+/**
+ Timeline reference point to calculate SourceOptions.startOffset from.
+ Default for live: TimelineReferencePoint.EBD Default for VOD: TimelineReferencePoint.START.
+ */
+export var TimelineReferencePoint;
+(function (TimelineReferencePoint) {
+    /**
+     * Relative offset will be calculated from the beginning of the stream or DVR window.
+     */
+    TimelineReferencePoint["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.
+     */
+    TimelineReferencePoint["END"] = "end";
+})(TimelineReferencePoint || (TimelineReferencePoint = {}));
+/**
+ * Represents audio and video content that can be loaded into a player.
+ */
+export class Source extends NativeInstance {
+    /**
+     * The native DRM config reference of this source.
+     */
+    drm;
+    /**
+     * The remote control config for this source.
+     * This is only supported on iOS.
+     *
+     * @remarks Platform: iOS
+     */
+    remoteControl = null;
+    /**
+     * Whether the native {@link Source} object has been created.
+     */
+    isInitialized = false;
+    /**
+     * Whether the native {@link Source} object has been disposed.
+     */
+    isDestroyed = false;
+    /**
+     * Allocates the native {@link Source} instance and its resources natively.
+     */
+    initialize = async () => {
+        if (!this.isInitialized) {
+            const sourceMetadata = this.config?.analyticsSourceMetadata;
+            if (this.config?.drmConfig) {
+                this.drm = new Drm(this.config.drmConfig);
+                this.drm.initialize();
+            }
+            if (sourceMetadata) {
+                await SourceModule.initializeWithAnalyticsConfig(this.nativeId, this.drm?.nativeId, this.config, this.remoteControl || undefined, sourceMetadata);
+            }
+            else {
+                await SourceModule.initializeWithConfig(this.nativeId, this.drm?.nativeId, this.config, this.remoteControl || undefined);
+            }
+            this.isInitialized = true;
+        }
+        return Promise.resolve();
+    };
+    /**
+     * Destroys the native {@link Source} and releases all of its allocated resources.
+     */
+    destroy = () => {
+        if (!this.isDestroyed) {
+            SourceModule.destroy(this.nativeId);
+            this.drm?.destroy();
+            this.isDestroyed = true;
+        }
+    };
+    /**
+     * The duration of the source in seconds if it’s a VoD or `INFINITY` if it’s a live stream.
+     * Default value is `0` if the duration is not available or not known.
+     */
+    duration = async () => {
+        return (await SourceModule.duration(this.nativeId)) || 0;
+    };
+    /**
+     * Whether the source is currently active in a player (i.e. playing back or paused).
+     * Only one source can be active in the same player instance at any time.
+     */
+    isActive = async () => {
+        return (await SourceModule.isActive(this.nativeId)) ?? false;
+    };
+    /**
+     * Whether the source is currently attached to a player instance.
+     */
+    isAttachedToPlayer = async () => {
+        return (await SourceModule.isAttachedToPlayer(this.nativeId)) ?? false;
+    };
+    /**
+     * Metadata for the currently loaded source.
+     */
+    metadata = async () => {
+        return SourceModule.getMetadata(this.nativeId);
+    };
+    /**
+     * 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) => {
+        SourceModule.setMetadata(this.nativeId, metadata);
+    };
+    /**
+     * The current `LoadingState` of the source.
+     */
+    loadingState = async () => {
+        return ((await SourceModule.loadingState(this.nativeId)) || LoadingState.UNLOADED);
+    };
+    /**
+     * @returns a `Thumbnail` for the specified playback time if available.
+     * Supported thumbnail formats are:
+     * - `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 = async (time) => {
+        return SourceModule.getThumbnail(this.nativeId, time);
+    };
+}
+//# sourceMappingURL=source.js.map

package/build/source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAa,MAAM,OAAO,CAAC;AACvC,OAAO,cAAwC,MAAM,kBAAkB,CAAC;AAIxE,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAElD;;GAEG;AACH,MAAM,CAAN,IAAY,UAiBX;AAjBD,WAAY,UAAU;IACpB;;OAEG;IACH,2BAAa,CAAA;IACb;;OAEG;IACH,yBAAW,CAAA;IACX;;OAEG;IACH,2BAAa,CAAA;IACb;;OAEG;IACH,yCAA2B,CAAA;AAC7B,CAAC,EAjBW,UAAU,KAAV,UAAU,QAiBrB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB;;OAEG;IACH,uDAAY,CAAA;IACZ;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,mDAAU,CAAA;AACZ,CAAC,EAbW,YAAY,KAAZ,YAAY,QAavB;AAqBD;;;GAGG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC;;OAEG;IACH,yCAAe,CAAA;IACf;;OAEG;IACH,qCAAW,CAAA;AACb,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC;AAwED;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,cAA4B;IACtD;;OAEG;IACK,GAAG,CAAO;IAClB;;;;;OAKG;IACH,aAAa,GAAqC,IAAI,CAAC;IACvD;;OAEG;IACH,aAAa,GAAG,KAAK,CAAC;IACtB;;OAEG;IACH,WAAW,GAAG,KAAK,CAAC;IAEpB;;OAEG;IACH,UAAU,GAAG,KAAK,IAAmB,EAAE;QACrC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,EAAE,uBAAuB,CAAC;YAC5D,IAAI,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC1C,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACxB,CAAC;YACD,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,YAAY,CAAC,6BAA6B,CAC9C,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,GAAG,EAAE,QAAQ,EAClB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,aAAa,IAAI,SAAS,EAC/B,cAAc,CACf,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,CAAC,oBAAoB,CACrC,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,GAAG,EAAE,QAAQ,EAClB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,aAAa,IAAI,SAAS,CAChC,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF;;OAEG;IACH,OAAO,GAAG,GAAG,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;IACH,CAAC,CAAC;IAEF;;;OAGG;IACH,QAAQ,GAAG,KAAK,IAAqB,EAAE;QACrC,OAAO,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC,CAAC;IAEF;;;OAGG;IACH,QAAQ,GAAG,KAAK,IAAsB,EAAE;QACtC,OAAO,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,CAAC;IAC/D,CAAC,CAAC;IAEF;;OAEG;IACH,kBAAkB,GAAG,KAAK,IAAsB,EAAE;QAChD,OAAO,CAAC,MAAM,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,CAAC;IACzE,CAAC,CAAC;IAEF;;OAEG;IACH,QAAQ,GAAG,KAAK,IAAyC,EAAE;QACzD,OAAO,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF;;;;;OAKG;IACH,WAAW,GAAG,CAAC,QAAoC,EAAQ,EAAE;QAC3D,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF;;OAEG;IACH,YAAY,GAAG,KAAK,IAA2B,EAAE;QAC/C,OAAO,CACL,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,QAAQ,CAC1E,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACH,YAAY,GAAG,KAAK,EAAE,IAAY,EAA6B,EAAE;QAC/D,OAAO,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC,CAAC;CACH","sourcesContent":["import { Drm, DrmConfig } from './drm';\nimport NativeInstance, { NativeInstanceConfig } from './nativeInstance';\nimport { SideLoadedSubtitleTrack } from './subtitleTrack';\nimport { Thumbnail } from './thumbnail';\nimport { SourceMetadata } from './analytics';\nimport SourceModule from './modules/SourceModule';\n\n/**\n * Types of media that can be handled by the player.\n */\nexport enum SourceType {\n  /**\n   * Indicates a missing source type.\n   */\n  NONE = 'none',\n  /**\n   * Indicates media type HLS.\n   */\n  HLS = 'hls',\n  /**\n   * Indicates media type DASH.\n   */\n  DASH = 'dash',\n  /**\n   * Indicates media type Progressive MP4.\n   */\n  PROGRESSIVE = 'progressive',\n}\n\n/**\n * The different loading states a {@link Source} instance can be in.\n */\nexport enum LoadingState {\n  /**\n   * The source is unloaded.\n   */\n  UNLOADED = 0,\n  /**\n   * The source is currently loading.\n   */\n  LOADING = 1,\n  /**\n   * The source is loaded.\n   */\n  LOADED = 2,\n}\n\n/**\n * Types of SourceOptions.\n */\nexport interface SourceOptions {\n  /**\n   * The position where the stream should be started.\n   * Number can be positive or negative depending on the used `TimelineReferencePoint`.\n   * Invalid numbers will be corrected according to the stream boundaries.\n   * For VOD this is applied at the time the stream is loaded, for LIVE when playback starts.\n   */\n  startOffset?: number;\n  /**\n   * Sets the Timeline reference point to calculate the startOffset from.\n   * Default for live: `TimelineReferencePoint.END`.\n   * Default for VOD: `TimelineReferencePoint.START`.\n   */\n  startOffsetTimelineReference?: TimelineReferencePoint;\n}\n\n/**\n Timeline reference point to calculate SourceOptions.startOffset from.\n Default for live: TimelineReferencePoint.EBD Default for VOD: TimelineReferencePoint.START.\n */\nexport enum TimelineReferencePoint {\n  /**\n   * Relative offset will be calculated from the beginning of the stream or DVR window.\n   */\n  START = 'start',\n  /**\n   * Relative offset will be calculated from the end of the stream or the live edge in case of a live stream with DVR window.\n   */\n  END = 'end',\n}\n\n/**\n * Represents a source configuration that be loaded into a player instance.\n */\nexport interface SourceConfig extends NativeInstanceConfig {\n  /**\n   *  The url for this source configuration.\n   */\n  url: string;\n  /**\n   * The `SourceType` for this configuration.\n   */\n  type?: SourceType;\n  /**\n   * The title of the video source.\n   */\n  title?: string;\n  /**\n   * The description of the video source.\n   */\n  description?: string;\n  /**\n   * The URL to a preview image displayed until the video starts.\n   */\n  poster?: string;\n  /**\n   * Indicates whether to show the poster image during playback.\n   * Useful, for example, for audio-only streams.\n   */\n  isPosterPersistent?: boolean;\n  /**\n   * The DRM config for the source.\n   */\n  drmConfig?: DrmConfig;\n  /**\n   * External subtitle tracks to be added into the player.\n   */\n  subtitleTracks?: SideLoadedSubtitleTrack[];\n  /**\n   * External thumbnails to be added into the player.\n   */\n  thumbnailTrack?: string;\n  /**\n   * The optional custom metadata. Also sent to the cast receiver when loading the Source.\n   */\n  metadata?: Record<string, string>;\n  /**\n   * The `SourceOptions` for this configuration.\n   */\n  options?: SourceOptions;\n  /**\n   * The `SourceMetadata` for the {@link Source} to setup custom analytics tracking\n   */\n  analyticsSourceMetadata?: SourceMetadata;\n}\n\n/**\n * The remote control config for a source.\n * @remarks Platform: iOS\n */\nexport interface SourceRemoteControlConfig {\n  /**\n   * The `SourceConfig` for casting.\n   * Enables to play different content when casting.\n   * This can be useful when the remote playback device supports different streaming formats,\n   * DRM systems, etc. than the local device.\n   * If not set, the local source config will be used for casting.\n   */\n  castSourceConfig?: SourceConfig | null;\n}\n\n/**\n * Represents audio and video content that can be loaded into a player.\n */\nexport class Source extends NativeInstance<SourceConfig> {\n  /**\n   * The native DRM config reference of this source.\n   */\n  private drm?: Drm;\n  /**\n   * The remote control config for this source.\n   * This is only supported on iOS.\n   *\n   * @remarks Platform: iOS\n   */\n  remoteControl: SourceRemoteControlConfig | null = null;\n  /**\n   * Whether the native {@link Source} object has been created.\n   */\n  isInitialized = false;\n  /**\n   * Whether the native {@link Source} object has been disposed.\n   */\n  isDestroyed = false;\n\n  /**\n   * Allocates the native {@link Source} instance and its resources natively.\n   */\n  initialize = async (): Promise<void> => {\n    if (!this.isInitialized) {\n      const sourceMetadata = this.config?.analyticsSourceMetadata;\n      if (this.config?.drmConfig) {\n        this.drm = new Drm(this.config.drmConfig);\n        this.drm.initialize();\n      }\n      if (sourceMetadata) {\n        await SourceModule.initializeWithAnalyticsConfig(\n          this.nativeId,\n          this.drm?.nativeId,\n          this.config,\n          this.remoteControl || undefined,\n          sourceMetadata\n        );\n      } else {\n        await SourceModule.initializeWithConfig(\n          this.nativeId,\n          this.drm?.nativeId,\n          this.config,\n          this.remoteControl || undefined\n        );\n      }\n      this.isInitialized = true;\n    }\n    return Promise.resolve();\n  };\n\n  /**\n   * Destroys the native {@link Source} and releases all of its allocated resources.\n   */\n  destroy = () => {\n    if (!this.isDestroyed) {\n      SourceModule.destroy(this.nativeId);\n      this.drm?.destroy();\n      this.isDestroyed = true;\n    }\n  };\n\n  /**\n   * The duration of the source in seconds if it’s a VoD or `INFINITY` if it’s a live stream.\n   * Default value is `0` if the duration is not available or not known.\n   */\n  duration = async (): Promise<number> => {\n    return (await SourceModule.duration(this.nativeId)) || 0;\n  };\n\n  /**\n   * Whether the source is currently active in a player (i.e. playing back or paused).\n   * Only one source can be active in the same player instance at any time.\n   */\n  isActive = async (): Promise<boolean> => {\n    return (await SourceModule.isActive(this.nativeId)) ?? false;\n  };\n\n  /**\n   * Whether the source is currently attached to a player instance.\n   */\n  isAttachedToPlayer = async (): Promise<boolean> => {\n    return (await SourceModule.isAttachedToPlayer(this.nativeId)) ?? false;\n  };\n\n  /**\n   * Metadata for the currently loaded source.\n   */\n  metadata = async (): Promise<Record<string, any> | null> => {\n    return SourceModule.getMetadata(this.nativeId);\n  };\n\n  /**\n   * Set metadata for the currently loaded source.\n   * Setting the metadata to `null` clears the metadata object in native source.\n   *\n   * @param metadata metadata to be set.\n   */\n  setMetadata = (metadata: Record<string, any> | null): void => {\n    SourceModule.setMetadata(this.nativeId, metadata);\n  };\n\n  /**\n   * The current `LoadingState` of the source.\n   */\n  loadingState = async (): Promise<LoadingState> => {\n    return (\n      (await SourceModule.loadingState(this.nativeId)) || LoadingState.UNLOADED\n    );\n  };\n\n  /**\n   * @returns a `Thumbnail` for the specified playback time if available.\n   * Supported thumbnail formats are:\n   * - `WebVtt` configured via {@link SourceConfig.thumbnailTrack}, on all supported platforms\n   * - HLS `Image Media Playlist` in the multivariant playlist, Android-only\n   * - DASH `Image Adaptation Set` as specified in DASH-IF IOP, Android-only\n   * If a `WebVtt` thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.\n   *\n   * @param time - The time in seconds for which to retrieve the thumbnail.\n   */\n  getThumbnail = async (time: number): Promise<Thumbnail | null> => {\n    return SourceModule.getThumbnail(this.nativeId, time);\n  };\n}\n"]}

package/build/styleConfig.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Contains config values which can be used to alter the visual presentation and behaviour of the player UI.
+ */
+export 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;
+    /**
+     * Sets which user interface type should be used.
+     * Default value is `UserInterfaceType.bitmovin` on `iOS` and `UserInterfaceType.system` on `tvOS`.
+     * This setting only applies if `StyleConfig.isUiEnabled` is set to true.
+     * @example
+     * ```
+     * const player = new Player({
+     *   styleConfig: {
+     *     userInterfaceType: UserInterfaceType.System,
+     *   },
+     * });
+     * ```
+     * @remarks Platform: iOS, tvOS
+     */
+    userInterfaceType?: UserInterfaceType;
+    /**
+     * Sets 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',
+     *   },
+     * });
+     * ```
+     * @remarks Platform: iOS, Android
+     */
+    playerUiCss?: string;
+    /**
+     * Sets 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',
+     *   },
+     * });
+     * ```
+     * @remarks 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',
+     *   },
+     * });
+     * ```
+     * @remarks 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.
+ */
+export 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"
+}
+/**
+ * Indicates which type of UI should be used.
+ */
+export declare enum UserInterfaceType {
+    /**
+     * Indicates that Bitmovin's customizable UI should be used.
+     */
+    Bitmovin = "Bitmovin",
+    /**
+     * Indicates that the system UI should be used.
+     * @remarks Platform: iOS, tvOS
+     */
+    System = "System",
+    /**
+     * Indicates that only subtitles should be displayed along with the video content.
+     */
+    Subtitle = "Subtitle"
+}
+//# sourceMappingURL=styleConfig.d.ts.map

package/build/styleConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleConfig.d.ts","sourceRoot":"","sources":["../src/styleConfig.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,QAAQ,aAAa;IACrB;;;OAGG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,QAAQ,aAAa;CACtB"}

package/build/styleConfig.js

@@ -0,0 +1,38 @@
+/**
+ * Specifies how the video content is scaled or stretched.
+ */
+export var ScalingMode;
+(function (ScalingMode) {
+    /**
+     * Specifies that the player should preserve the video’s aspect ratio and fit the video within the container's bounds.
+     */
+    ScalingMode["Fit"] = "Fit";
+    /**
+     * Specifies that the video should be stretched to fill the container’s bounds. The aspect ratio may not be preserved.
+     */
+    ScalingMode["Stretch"] = "Stretch";
+    /**
+     * Specifies that the player should preserve the video’s aspect ratio and fill the container’s bounds.
+     */
+    ScalingMode["Zoom"] = "Zoom";
+})(ScalingMode || (ScalingMode = {}));
+/**
+ * Indicates which type of UI should be used.
+ */
+export var UserInterfaceType;
+(function (UserInterfaceType) {
+    /**
+     * Indicates that Bitmovin's customizable UI should be used.
+     */
+    UserInterfaceType["Bitmovin"] = "Bitmovin";
+    /**
+     * Indicates that the system UI should be used.
+     * @remarks Platform: iOS, tvOS
+     */
+    UserInterfaceType["System"] = "System";
+    /**
+     * Indicates that only subtitles should be displayed along with the video content.
+     */
+    UserInterfaceType["Subtitle"] = "Subtitle";
+})(UserInterfaceType || (UserInterfaceType = {}));
+//# sourceMappingURL=styleConfig.js.map

package/build/styleConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleConfig.js","sourceRoot":"","sources":["../src/styleConfig.ts"],"names":[],"mappings":"AAqFA;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;OAEG;IACH,0BAAW,CAAA;IACX;;OAEG;IACH,kCAAmB,CAAA;IACnB;;OAEG;IACH,4BAAa,CAAA;AACf,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBAcX;AAdD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,0CAAqB,CAAA;IACrB;;;OAGG;IACH,sCAAiB,CAAA;IACjB;;OAEG;IACH,0CAAqB,CAAA;AACvB,CAAC,EAdW,iBAAiB,KAAjB,iBAAiB,QAc5B","sourcesContent":["/**\n * Contains config values which can be used to alter the visual presentation and behaviour of the player UI.\n */\nexport interface StyleConfig {\n  /**\n   * Sets if the UI should be enabled or not. Default value is `true`.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     isUiEnabled: false,\n   *   },\n   * });\n   * ```\n   */\n  isUiEnabled?: boolean;\n  /**\n   * Sets which user interface type should be used.\n   * Default value is `UserInterfaceType.bitmovin` on `iOS` and `UserInterfaceType.system` on `tvOS`.\n   * This setting only applies if `StyleConfig.isUiEnabled` is set to true.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     userInterfaceType: UserInterfaceType.System,\n   *   },\n   * });\n   * ```\n   * @remarks Platform: iOS, tvOS\n   */\n  userInterfaceType?: UserInterfaceType;\n  /**\n   * Sets 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.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     playerUiCss: 'https://domain.tld/path/to/bitmovinplayer-ui.css',\n   *   },\n   * });\n   * ```\n   * @remarks Platform: iOS, Android\n   */\n  playerUiCss?: string;\n  /**\n   * Sets 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`.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     supplementalPlayerUiCss: 'https://domain.tld/path/to/bitmovinplayer-supplemental-ui.css',\n   *   },\n   * });\n   * ```\n   * @remarks Platform: iOS, Android\n   */\n  supplementalPlayerUiCss?: string;\n  /**\n   * 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.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     playerUiJs: 'https://domain.tld/path/to/bitmovinplayer-ui.js',\n   *   },\n   * });\n   * ```\n   * @remarks Platform: iOS, Android\n   */\n  playerUiJs?: string;\n  /**\n   * Determines how the video content is scaled or stretched within the parent container’s bounds. Possible values are defined in `ScalingMode`.\n   * Default value is `ScalingMode.fit`.\n   * @example\n   * ```\n   * const player = new Player({\n   *   styleConfig: {\n   *     scalingMode: ScalingMode.Zoom,\n   *   },\n   * });\n   * ```\n   */\n  scalingMode?: ScalingMode;\n}\n\n/**\n * Specifies how the video content is scaled or stretched.\n */\nexport enum ScalingMode {\n  /**\n   * Specifies that the player should preserve the video’s aspect ratio and fit the video within the container's bounds.\n   */\n  Fit = 'Fit',\n  /**\n   * Specifies that the video should be stretched to fill the container’s bounds. The aspect ratio may not be preserved.\n   */\n  Stretch = 'Stretch',\n  /**\n   * Specifies that the player should preserve the video’s aspect ratio and fill the container’s bounds.\n   */\n  Zoom = 'Zoom',\n}\n\n/**\n * Indicates which type of UI should be used.\n */\nexport enum UserInterfaceType {\n  /**\n   * Indicates that Bitmovin's customizable UI should be used.\n   */\n  Bitmovin = 'Bitmovin',\n  /**\n   * Indicates that the system UI should be used.\n   * @remarks Platform: iOS, tvOS\n   */\n  System = 'System',\n  /**\n   * Indicates that only subtitles should be displayed along with the video content.\n   */\n  Subtitle = 'Subtitle',\n}\n"]}

package/build/subtitleFormat.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Supported subtitle/caption file formats.
+ * @remarks Platform: Android, iOS, tvOS
+ */
+export declare enum SubtitleFormat {
+    /**
+     * Closed Captioning (CEA) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    CEA = "cea",
+    /**
+     * Timed Text Markup Language (TTML) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    TTML = "ttml",
+    /**
+     * Web Video Text Tracks Format (WebVTT) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    VTT = "vtt",
+    /**
+     * SubRip (SRT) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    SRT = "srt"
+}
+//# sourceMappingURL=subtitleFormat.d.ts.map

package/build/subtitleFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subtitleFormat.d.ts","sourceRoot":"","sources":["../src/subtitleFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,cAAc;IACxB;;;OAGG;IACH,GAAG,QAAQ;IACX;;;OAGG;IACH,IAAI,SAAS;IACb;;;OAGG;IACH,GAAG,QAAQ;IACX;;;OAGG;IACH,GAAG,QAAQ;CACZ"}

package/build/subtitleFormat.js

@@ -0,0 +1,28 @@
+/**
+ * Supported subtitle/caption file formats.
+ * @remarks Platform: Android, iOS, tvOS
+ */
+export var SubtitleFormat;
+(function (SubtitleFormat) {
+    /**
+     * Closed Captioning (CEA) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    SubtitleFormat["CEA"] = "cea";
+    /**
+     * Timed Text Markup Language (TTML) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    SubtitleFormat["TTML"] = "ttml";
+    /**
+     * Web Video Text Tracks Format (WebVTT) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    SubtitleFormat["VTT"] = "vtt";
+    /**
+     * SubRip (SRT) subtitle format.
+     * @remarks Platform: Android, iOS, tvOS
+     */
+    SubtitleFormat["SRT"] = "srt";
+})(SubtitleFormat || (SubtitleFormat = {}));
+//# sourceMappingURL=subtitleFormat.js.map

package/build/subtitleFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subtitleFormat.js","sourceRoot":"","sources":["../src/subtitleFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,cAqBX;AArBD,WAAY,cAAc;IACxB;;;OAGG;IACH,6BAAW,CAAA;IACX;;;OAGG;IACH,+BAAa,CAAA;IACb;;;OAGG;IACH,6BAAW,CAAA;IACX;;;OAGG;IACH,6BAAW,CAAA;AACb,CAAC,EArBW,cAAc,KAAd,cAAc,QAqBzB","sourcesContent":["/**\n * Supported subtitle/caption file formats.\n * @remarks Platform: Android, iOS, tvOS\n */\nexport enum SubtitleFormat {\n  /**\n   * Closed Captioning (CEA) subtitle format.\n   * @remarks Platform: Android, iOS, tvOS\n   */\n  CEA = 'cea',\n  /**\n   * Timed Text Markup Language (TTML) subtitle format.\n   * @remarks Platform: Android, iOS, tvOS\n   */\n  TTML = 'ttml',\n  /**\n   * Web Video Text Tracks Format (WebVTT) subtitle format.\n   * @remarks Platform: Android, iOS, tvOS\n   */\n  VTT = 'vtt',\n  /**\n   * SubRip (SRT) subtitle format.\n   * @remarks Platform: Android, iOS, tvOS\n   */\n  SRT = 'srt',\n}\n"]}