bitmovin-player-react-native/build/source.d.ts

Official React Native bindings for Bitmovin's mobile Player SDKs.

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.
 * @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.
     *
     * @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