react-native-theoplayer 1.8.2 → 2.0.0

package/lib/typescript/api/event/barrel.d.ts

@@ -0,0 +1,5 @@
+export * from './AdEvent';
+export * from './CastEvent';
+export * from './PlayerEvent';
+export * from './TrackEvent';
+export * from './Event';

package/lib/typescript/api/media/MediaControlConfiguration.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Describes the configuration of media controls and media sessions across platforms.
+ *
+ * For Android, this applies to the {@link https://developer.android.com/guide/topics/media-apps/working-with-a-media-session Media Session}
+ * functionality, providing the platform with a uniform way of interacting with the player, and the
+ * {@link https://developer.android.com/develop/ui/views/notifications Notification to display information on the media currently playing.
+ *
+ * For Web, this applies to the {@link https://www.w3.org/TR/mediasession/ Media Session} API for customizing media notifications and access to
+ * platform media keys.
+ *
+ * For iOS, this applies to the {@link https://developer.apple.com/documentation/mediaplayer/mpnowplayinginfocenter Now Playing} functionality for
+ * setting information on the media that is currently playing, and the
+ * {@link https://developer.apple.com/documentation/mediaplayer/mpremotecommandcenter Remote Command Center} responds to remote control events sent
+ * by external accessories and system controls.
+ */
+export interface MediaControlConfiguration {
+    /**
+     * Whether the media session feature is enabled.
+     *
+     * @defaultValue `true`
+     *
+     * @remarks
+     * <br/> - This only applies to Web.
+     */
+    readonly mediaSessionEnabled?: boolean;
+}

package/lib/typescript/api/media/barrel.d.ts

@@ -0,0 +1 @@
+export * from './MediaControlConfiguration';

package/lib/typescript/api/pip/PiPConfiguration.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes the configuration of the picture-in-picture feature.
+ *
+ * @public
+ */
+export interface PiPConfiguration {
+    /**
+     * Whether Picture in Picture should be allowed to start automatically when transitioning to background.
+     *
+     * @defaultValue `false`
+     */
+    readonly startsAutomatically?: boolean;
+}

package/lib/typescript/api/pip/barrel.d.ts

@@ -0,0 +1 @@
+export * from './PiPConfiguration';

package/lib/typescript/api/player/PlayerEventMap.d.ts

@@ -0,0 +1,158 @@
+import type { Event } from '../event/Event';
+import type { DurationChangeEvent, ErrorEvent, LoadedMetadataEvent, ProgressEvent, RateChangeEvent, ReadyStateChangeEvent, SegmentNotFoundEvent, TimeUpdateEvent, PresentationModeChangeEvent, VolumeChangeEvent } from '../event/PlayerEvent';
+import type { MediaTrackEvent, MediaTrackListEvent, TextTrackEvent, TextTrackListEvent } from '../event/TrackEvent';
+import type { AdEvent } from '../event/AdEvent';
+import type { CastEvent } from '../event/CastEvent';
+export declare enum PlayerEventType {
+    PLAY = "play",
+    CANPLAY = "canplay",
+    PLAYING = "playing",
+    SOURCE_CHANGE = "sourcechange",
+    LOAD_START = "loadstart",
+    LOADED_METADATA = "loadedmetadata",
+    LOADED_DATA = "loadeddata",
+    READYSTATE_CHANGE = "readystatechange",
+    ERROR = "error",
+    PROGRESS = "progress",
+    PAUSE = "pause",
+    SEEKING = "seeking",
+    SEEKED = "seeked",
+    ENDED = "ended",
+    TIME_UPDATE = "timeupdate",
+    DURATION_CHANGE = "durationchange",
+    RATE_CHANGE = "ratechange",
+    SEGMENT_NOT_FOUND = "segmentnotfound",
+    TEXT_TRACK_LIST = "texttracklist",
+    TEXT_TRACK = "texttrack",
+    MEDIA_TRACK_LIST = "mediatracklist",
+    MEDIA_TRACK = "mediatrack",
+    AD_EVENT = "adevent",
+    CAST_EVENT = "castevent",
+    VOLUME_CHANGE = "volumechange",
+    WAITING = "waiting",
+    PRESENTATIONMODE_CHANGE = "presentationmodechange",
+    DESTROY = "destroy"
+}
+/**
+ * The events dispatched by THEOplayer.
+ *
+ */
+export interface PlayerEventMap {
+    /**
+     * Dispatched when the player can resume playback of the media data.
+     */
+    [PlayerEventType.CANPLAY]: Event<PlayerEventType.CANPLAY>;
+    /**
+     * Dispatched when the player's internal paused state changes to `false`.
+     */
+    [PlayerEventType.PLAY]: Event<PlayerEventType.PLAY>;
+    /**
+     * Dispatched when playback is ready to start after having been paused or delayed due to lack of media data.
+     */
+    [PlayerEventType.PLAYING]: Event<PlayerEventType.PLAYING>;
+    /**
+     * Dispatched when the presentationMode of the player changes.
+     */
+    [PlayerEventType.PRESENTATIONMODE_CHANGE]: PresentationModeChangeEvent;
+    /**
+     * Dispatched when the player's source changes.
+     */
+    [PlayerEventType.SOURCE_CHANGE]: Event<PlayerEventType.SOURCE_CHANGE>;
+    /**
+     * Dispatched when the player starts loading the manifest.
+     */
+    [PlayerEventType.LOAD_START]: Event<PlayerEventType.LOAD_START>;
+    /**
+     * Dispatched when the player determines the metadata for its source.
+     */
+    [PlayerEventType.LOADED_METADATA]: LoadedMetadataEvent;
+    /**
+     * Dispatched when the player can render the media data at the current playback position for the first time.
+     */
+    [PlayerEventType.LOADED_DATA]: Event<PlayerEventType.LOADED_DATA>;
+    /**
+     * Dispatched when the player's readyState has changed.
+     */
+    [PlayerEventType.READYSTATE_CHANGE]: ReadyStateChangeEvent;
+    /**
+     * Dispatched when the player's volume changes.
+     */
+    [PlayerEventType.VOLUME_CHANGE]: VolumeChangeEvent;
+    /**
+     * Dispatched when an error occurs.
+     */
+    [PlayerEventType.ERROR]: ErrorEvent;
+    /**
+     * Dispatched each time the player has loaded media data.
+     */
+    [PlayerEventType.PROGRESS]: ProgressEvent;
+    /**
+     * Dispatched when the player's internal paused state changes to `true`.
+     */
+    [PlayerEventType.PAUSE]: Event<PlayerEventType.PAUSE>;
+    /**
+     * Dispatched when a seek operation starts and the player is seeking a new position.
+     */
+    [PlayerEventType.SEEKING]: Event<PlayerEventType.SEEKING>;
+    /**
+     * Dispatched when a seek operation completed and the current playback position has changed.
+     */
+    [PlayerEventType.SEEKED]: Event<PlayerEventType.SEEKED>;
+    /**
+     * Dispatched when playback has stopped because the end of the media was reached or because
+     * no further data is available.
+     */
+    [PlayerEventType.ENDED]: Event<PlayerEventType.ENDED>;
+    /**
+     * Dispatched when playback has stopped because the next frame is not available, but the
+     * player expects that frame to become available in due course.
+     */
+    [PlayerEventType.WAITING]: Event<PlayerEventType.WAITING>;
+    /**
+     * Dispatched each time the current playback position changed.
+     */
+    [PlayerEventType.TIME_UPDATE]: TimeUpdateEvent;
+    /**
+     * Dispatched when the player's duration attribute has been updated.
+     */
+    [PlayerEventType.DURATION_CHANGE]: DurationChangeEvent;
+    /**
+     * Dispatched when the player's playbackRate changes.
+     */
+    [PlayerEventType.RATE_CHANGE]: RateChangeEvent;
+    /**
+     * Dispatched when a segment can not be found.
+     *
+     * @remarks
+     * <br/> - Only dispatched on DASH streams.
+     */
+    [PlayerEventType.SEGMENT_NOT_FOUND]: SegmentNotFoundEvent;
+    /**
+     * Dispatched when a text track list event occurs.
+     */
+    [PlayerEventType.TEXT_TRACK_LIST]: TextTrackListEvent;
+    /**
+     * Dispatched when a text track event occurs.
+     */
+    [PlayerEventType.TEXT_TRACK]: TextTrackEvent;
+    /**
+     * Dispatched when a media track list event occurs.
+     */
+    [PlayerEventType.MEDIA_TRACK_LIST]: MediaTrackListEvent;
+    /**
+     * Dispatched when a media track event occurs.
+     */
+    [PlayerEventType.MEDIA_TRACK]: MediaTrackEvent;
+    /**
+     * Dispatched when an ad event occurs.
+     */
+    [PlayerEventType.AD_EVENT]: AdEvent;
+    /**
+     * Dispatched when a cast event occurs, either for Chromecast or Airplay.
+     */
+    [PlayerEventType.CAST_EVENT]: CastEvent;
+    /**
+     * Dispatched when the player will be destroyed.
+     */
+    [PlayerEventType.DESTROY]: Event<PlayerEventType.DESTROY>;
+}

package/lib/typescript/api/player/THEOplayer.d.ts

@@ -0,0 +1,154 @@
+import type { EventDispatcher } from '../event/EventDispatcher';
+import type { PlayerEventMap } from './PlayerEventMap';
+import type { ABRConfiguration } from '../abr/ABRConfiguration';
+import type { SourceDescription } from '../source/SourceDescription';
+import type { AdsAPI } from '../ads/AdsAPI';
+import type { CastAPI } from '../cast/CastAPI';
+import type { MediaTrack } from '../track/MediaTrack';
+import type { TextTrack } from '../track/TextTrack';
+import type { TimeRange } from '../timeranges/TimeRange';
+import type { TextTrackStyle } from '../track/TextTrackStyle';
+import type { PresentationMode } from '../presentation/PresentationMode';
+import type { PiPConfiguration } from '../pip/PiPConfiguration';
+import type { BackgroundAudioConfiguration } from '../backgroundAudio/BackgroundAudioConfiguration';
+export declare type PreloadType = 'none' | 'metadata' | 'auto' | '';
+export declare type NativeHandleType = unknown;
+/**
+ * The THEOplayer API.
+ */
+export interface THEOplayer extends EventDispatcher<PlayerEventMap> {
+    /**
+     * The player's adaptive bitrate (ABR) configuration.
+     *
+     * @remarks
+     * <br/> - This property is supported on Android & Web platforms only.
+     */
+    readonly abr: ABRConfiguration | undefined;
+    /**
+     * A source description that determines the current media resource.
+     */
+    source: SourceDescription | undefined;
+    /**
+     * Start or resume playback.
+     */
+    play(): void;
+    /**
+     * Pause playback.
+     */
+    pause(): void;
+    /**
+     * Whether the player is paused.
+     */
+    readonly paused: boolean;
+    /**
+     * Whether the player should immediately start playback after source change.
+     */
+    autoplay: boolean;
+    /**
+     * The preload setting of the player.
+     */
+    preload: PreloadType;
+    /**
+     * Returns a list of TimeRanges that represents the ranges of the media resource that are seekable by the player.
+     */
+    seekable: TimeRange[];
+    /**
+     * Returns a list of TimeRanges that represents the ranges of the media resource that are buffered by the player.
+     */
+    buffered: TimeRange[];
+    /**
+     * Used to set the playback rate of the media.
+     *
+     * @example
+     * <br/> - `playbackRate = 0.70` will slow down the playback rate of the media by 30%.
+     * <br/> - `playbackRate = 1.25` will speed up the playback rate of the media by 25%.
+     *
+     * @remarks
+     * <br/> - Playback rate is represented by a number where `1` is default playback speed.
+     * <br/> - Playback rate must be a positive number.
+     * <br/> - It is recommended that you limit the range to between 0.5 and 4.
+     */
+    playbackRate: number;
+    /**
+     * Used to set the volume of the audio.
+     *
+     * @remarks
+     * <br/> - Volume is represented by a floating point number between `0.0` and `1.0`.
+     */
+    volume: number;
+    /**
+     * Determines whether audio is muted.
+     */
+    muted: boolean;
+    /**
+     * Whether the player is seeking.
+     */
+    readonly seeking: boolean;
+    /**
+     * The PresentationMode of the player. Can be switched to: `picture-in-picture`, `fullscreen` or `inline`
+     */
+    presentationMode: PresentationMode;
+    /**
+     * List of audio tracks of the current source.
+     */
+    audioTracks: MediaTrack[];
+    /**
+     * List of video tracks of the current source.
+     */
+    videoTracks: MediaTrack[];
+    /**
+     * List of text tracks of the current source.
+     */
+    textTracks: TextTrack[];
+    /**
+     * Used to set the current selected text track by passing its `uid`, or `undefined` to select none.
+     */
+    selectedTextTrack: number | undefined;
+    /**
+     * The text track style API.
+     *
+     * @remarks
+     * Only available for Web.
+     */
+    readonly textTrackStyle: TextTrackStyle;
+    /**
+     * Used to set the current selected video track by passing its `uid`, or `undefined` to select none.
+     */
+    selectedVideoTrack: number | undefined;
+    /**
+     * Used to set the current selected video quality by passing its `uid`, or `undefined` to select none.
+     */
+    targetVideoQuality: number | number[] | undefined;
+    /**
+     * Used to set the current selected audio track by passing its `uid`, or `undefined` to select none.
+     */
+    selectedAudioTrack: number | undefined;
+    /**
+     * The current playback position of the media, in milliseconds.
+     */
+    currentTime: number;
+    /**
+     * The active configuration for PiP.
+     */
+    pipConfiguration: PiPConfiguration;
+    /**
+     * The active configuration for PiP.
+     */
+    backgroundAudioConfiguration: BackgroundAudioConfiguration;
+    /**
+     * The duration of the media, in milliseconds.
+     */
+    readonly duration: number;
+    /**
+     * The API for advertisements.
+     */
+    readonly ads: AdsAPI;
+    /**
+     * The API for casting devices.
+     */
+    readonly cast: CastAPI;
+    /**
+     * Native player handle.
+     */
+    readonly nativeHandle: NativeHandleType;
+}

package/lib/typescript/api/player/barrel.d.ts

@@ -0,0 +1,2 @@
+export * from './THEOplayer';
+export * from './PlayerEventMap';

package/lib/typescript/api/presentation/PresentationMode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The presentation mode of the player, represented by a value from the following list:
+ * <br/> - `'inline'`: The player is shown in its original location on the page.
+ * <br/> - `'fullscreen'`: The player fills the entire screen.
+ * <br/> - `'picture-in-picture'`: The player is shown on top of the page (see {@link PiPConfiguration} for more options).
+ *
+ * @public
+ */
+export declare enum PresentationMode {
+    fullscreen = "fullscreen",
+    inline = "inline",
+    pip = "picture-in-picture"
+}

package/lib/typescript/api/presentation/barrel.d.ts

@@ -0,0 +1 @@
+export * from './PresentationMode';

package/lib/typescript/api/source/ads/Ads.d.ts

@@ -0,0 +1,99 @@
+/**
+ * The type of ad source:
+ * <br/> - `'vast'`: The source is a VAST resource.
+ * <br/> - `'vmap'`: The source is a VMAP resource.
+ * <br/> - `'adrule'`: The source is a Ad Rule resource.
+ *
+ * @remarks
+ * <br/> - An ad rule is a simplified VMAP alternative only available in the Google IMA integration.
+ *
+ * @public
+ */
+export declare type AdSourceType = 'vast' | 'vmap' | 'adrule';
+/**
+ * Describes the source of the ad.
+ *
+ * @public
+ */
+export interface AdSource {
+    /**
+     * The URL of the ad resource.
+     */
+    src: string;
+    /**
+     * The type of ad resource.
+     *
+     * @defaultValue 'vmap' when set through {@link SourceConfiguration.ads} without a time offset, otherwise 'vast'.
+     */
+    type?: AdSourceType;
+}
+/**
+ * Describes an ad break request.
+ *
+ * @public
+ */
+export interface AdDescription {
+    /**
+     * The integration of the ad break.
+     *
+     * @defaultValue `'theo'`
+     */
+    integration?: AdIntegrationKind;
+    /**
+     * Whether the ad replaces playback of the content.
+     *
+     * @remarks
+     * <br/> - When the ad ends, the content will resume at the ad break's offset plus its duration.
+     *
+     * @defaultValue
+     * <br/> - `true` for live content,
+     * <br/> - `false` for VOD content
+     */
+    replaceContent?: boolean;
+    /**
+     * A source which contains the location of ad resources to be scheduled.
+     *
+     * @remarks
+     * <br/> - Important: This should *not* be an array of sources.
+     * <br/> - VPAID support is limited to the `'google-ima'` integration.
+     * <br/> - Not specifying this property should only happen when using a third party ad integration that uses an other system of specifying which ads to schedule
+     */
+    sources?: string | AdSource;
+    /**
+     * Offset after which the ad break will start.
+     *
+     * Possible formats:
+     * <br/> - A number for the offset in seconds.
+     * <br/> - `'start'` for a preroll.
+     * <br/> - `'end'` for a postroll.
+     * <br/> - `'HH:MM:SS.mmm'` for a timestamp in the playback window.
+     * <br/> - A percentage string (XX%) for a proportion of the content duration.
+     *
+     * @remarks
+     * <br/> - A timestamp which is not in the playback window will result in the ad break not being started.
+     * <br/> - VMAP resources will ignore this value as they contain an internal offset.
+     * <br/> - Since 2.18, numbers are supported for the Google IMA integration, since 2.21 other formats as well.
+     *
+     * @defaultValue `'start'`
+     *
+     */
+    timeOffset?: string | number;
+}
+/**
+ * The integration of an ad break, represented by a value from the following list:
+ * <br/> - `'theo'`: Default ad playback.
+ * <br/> - `'google-ima'`: {@link https://developers.google.com/interactive-media-ads/docs/sdks/html5|Google IMA} pre-integrated ad playback.
+ * <br/> - `'spotx'`: {@link https://developer.spotxchange.com/|SpotX} pre-integrated ad playback.
+ * <br/> - `'freewheel'`: {@link https://vi.freewheel.tv/|FreeWheel} pre-integrated ad playback.
+ *
+ * @remarks
+ * <br/> - An empty string defaults to `'theo'`.
+ *
+ * @public
+ */
+export declare enum AdIntegrationKind {
+    freewheel = "freewheel",
+    google_ima = "google-ima",
+    spotx = "spotx",
+    theo = "theo"
+}

package/lib/typescript/api/source/ads/FreeWheelAdDescription.d.ts

@@ -0,0 +1,85 @@
+import type { AdDescription, AdIntegrationKind } from "./Ads";
+/**
+ * The possible ad unit types, represented by a value from the following list:
+ * <br/> - `'preroll'`: The linear ad will play before the content started.
+ * <br/> - `'midroll'`: The linear ad will play at a time offset during the content.
+ * <br/> - `'postroll'`: The linear ad will play after the content ended.
+ * <br/> - `'overlay'`: The non-linear ad.
+ *
+ * @public
+ */
+export declare type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
+/**
+ * Represents a FreeWheel cue.
+ *
+ * @public
+ */
+export interface FreeWheelCue {
+    /**
+     * The ad unit type.
+     */
+    adUnit: FreeWheelAdUnitType;
+    /**
+     * Offset after which the ad break will start, in seconds.
+     */
+    timeOffset: number;
+}
+/**
+ * Describes a FreeWheel ad break request.
+ *
+ * @remarks
+ * <br/> - Available since v2.42.0.
+ *
+ * @public
+ */
+export interface FreeWheelAdDescription extends AdDescription {
+    /**
+     * The integration of this ad break.
+     */
+    integration: AdIntegrationKind.freewheel;
+    /**
+     * The FreeWheel ad server URL.
+     */
+    adServerUrl: string;
+    /**
+     * The duration of the asset, in seconds.
+     *
+     * @remarks
+     * <br/> - Optional for live assets.
+     */
+    assetDuration?: number;
+    /**
+     * The identifier of the asset.
+     *
+     * @remarks
+     * <br/> - Generated by FreeWheel CMS when an asset is uploaded.
+     */
+    assetId?: string;
+    /**
+     * The network identifier which is associated with a FreeWheel customer.
+     */
+    networkId: number;
+    /**
+     * The server side configuration profile.
+     *
+     * @remarks
+     * <br/> - Used to indicate desired player capabilities.
+     */
+    profile: string;
+    /**
+     * The identifier of the video player's location.
+     */
+    siteSectionId?: string;
+    /**
+     * List of cue points.
+     *
+     * @remarks
+     * <br/> - Not available in all FreeWheel modes.
+     */
+    cuePoints?: FreeWheelCue[];
+    /**
+     * A record of query string parameters added to the FreeWheel ad break request.
+     * Each entry contains the parameter name with associated value.
+     */
+    customData?: Record<string, string>;
+}

package/lib/typescript/api/source/ads/IMAAdDescription.d.ts

@@ -0,0 +1,25 @@
+import type { AdDescription, AdIntegrationKind, AdSource } from "./Ads";
+/**
+ * Describes a Google IMA ad break request.
+ *
+ * @public
+ */
+export interface IMAAdDescription extends AdDescription {
+    /**
+     * The integration of this ad break.
+     */
+    integration: AdIntegrationKind.google_ima;
+    /**
+     * The source of the ad
+     *
+     * @remarks
+     * <br/> - VAST, VMAP and VPAID are supported.
+     */
+    sources: string | AdSource;
+    /**
+     * Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).
+     */
+    omidAccessModeRules?: {
+        [key: number]: string;
+    };
+}

package/lib/typescript/api/track/MediaTrack.d.ts

@@ -0,0 +1,50 @@
+import type { Track } from './Track';
+import type { Quality } from './Quality';
+export declare type MediaTrackKind = 'main' | 'alternative';
+/**
+ * Represents a media track (audio or video) of a media resource.
+ *
+ * @public
+ */
+export interface MediaTrack extends Track {
+    /**
+     * The identifier of the media track.
+     *
+     * @remarks
+     * <br/> - This identifier can be used to distinguish between related tracks, e.g. tracks in the same list.
+     */
+    readonly id: string;
+    /**
+     * A unique identifier of the media track.
+     *
+     * @remarks
+     * <br/> - This identifier is unique across tracks of a THEOplayer instance and can be used to distinguish between tracks.
+     * <br/> - This identifier is a randomly generated number.
+     */
+    readonly uid: number;
+    /**
+     * The kind of the media track, represented by a value from the following list:
+     * <br/> - `'main'`: The track is the default track for playback
+     * <br/> - `'alternative'`: The track is not the default track for playback
+     */
+    readonly kind: MediaTrackKind;
+    /**
+     * The label of the media track.
+     */
+    readonly label: string;
+    /**
+     * The language of the media track.
+     */
+    readonly language: string;
+    /**
+     * The active quality of the media track, i.e. the quality that is currently being played.
+     */
+    readonly activeQuality: Quality | undefined;
+    /**
+     * The qualities of the media track.
+     */
+    readonly qualities: Quality[];
+}
+export declare function findMediaTrackByUid(mediaTracks: MediaTrack[], uid: number | undefined): MediaTrack | undefined;
+export declare function findQualityByUid(mediaTrack: MediaTrack, uid: number | undefined): Quality | undefined;
+export declare function findQualitiesByUid(mediaTrack: MediaTrack | undefined, uid: number | number[] | undefined): Quality[] | undefined;