react-native-theoplayer 1.8.2 → 2.0.0

package/lib/typescript/src/api/THEOplayerView.d.ts

@@ -1,217 +0,0 @@
-import type { SourceDescription } from './source/SourceDescription';
-import type { StyleProp, ViewStyle } from 'react-native';
-import type { DurationChangeEvent, ErrorEvent, LoadedMetadataEvent, ReadyStateChangeEvent, TimeUpdateEvent, ProgressEvent, SegmentNotFoundEvent } from './event/PlayerEvent';
-import type { MediaTrackEvent, MediaTrackListEvent, TextTrackEvent, TextTrackListEvent } from './event/TrackEvent';
-import type { PlayerConfiguration } from './config/PlayerConfiguration';
-import type { ABRConfiguration } from './abr/ABRConfiguration';
-import type { AdEvent } from './event/AdEvent';
-import type { AdsAPI } from './ads/AdsAPI';
-import type { CastAPI } from './cast/CastAPI';
-import type { CastEvent } from './event/CastEvent';
-export interface THEOplayerViewProps {
-    /**
-     * The player configuration with THEOplayer license.
-     */
-    config?: PlayerConfiguration;
-    /**
-     * The player's adaptive bitrate (ABR) configuration.
-     *
-     * @remarks
-     * <br/> - This property is supported on Android & Web platforms only.
-     */
-    abrConfig?: ABRConfiguration;
-    /**
-     * A source description that determines the current media resource.
-     */
-    source: SourceDescription;
-    /**
-     * Used to set the player's paused state.
-     *
-     * @remarks
-     * <br/> - If paused is initially set to `true`, play-out will start once the source is set.
-     */
-    paused?: boolean;
-    /**
-     * 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;
-    /**
-     * Determines whether the player is currently playing in fullscreen.
-     */
-    fullscreen?: boolean;
-    /**
-     * Used to set the current selected text track by passing its `uid`, or `null` to select none.
-     */
-    selectedTextTrack?: number | null;
-    /**
-     * Used to set the current selected video track by passing its `uid`, or `null` to select none.
-     */
-    selectedVideoTrack?: number | null;
-    /**
-     * Used to set the current selected video quality by passing its `uid`, or `null` to select none.
-     */
-    targetVideoQuality?: number | number[] | undefined;
-    /**
-     * Used to set the current selected audio track by passing its `uid`, or `null` to select none.
-     */
-    selectedAudioTrack?: number | null;
-    /**
-     * The style applied to the player view.
-     */
-    style?: StyleProp<ViewStyle>;
-    /**
-     * Invoked before the player goes to fullscreen.
-     */
-    onFullscreenPlayerWillPresent?: () => void;
-    /**
-     * Invoked after the player went to fullscreen.
-     */
-    onFullscreenPlayerDidPresent?: () => void;
-    /**
-     * Invoked before the player returns from fullscreen.
-     */
-    onFullscreenPlayerWillDismiss?: () => void;
-    /**
-     * Invoked after the player returned from fullscreen.
-     */
-    onFullscreenPlayerDidDismiss?: () => void;
-    /**
-     * Invoked when the player's buffering state has changed.
-     *
-     * @remarks
-     * <br/> - The `isBuffering` value is typically coupled to showing/hiding a loading indicator.
-     *
-     * @param isBuffering A value that indicates whether the player is buffering.
-     */
-    onBufferingStateChange?: (isBuffering: boolean) => void;
-    /**
-     * Invoked when the player receives a new source description.
-     */
-    onSourceChange?: () => void;
-    /**
-     * Invoked when the player starts loading the manifest.
-     */
-    onLoadStart?: () => void;
-    /**
-     * Invoked when the player has determined the duration and dimensions of the
-     * media resource, and the text and media tracks are ready.
-     */
-    onLoadedMetadata?: (event: LoadedMetadataEvent) => void;
-    /**
-     * Invoked when the player can render the media data at the current playback position for the first time.
-     */
-    onLoadedData?: () => void;
-    /**
-     * Invoked when the player's readyState has changed.
-     */
-    onReadyStateChange?: (event: ReadyStateChangeEvent) => void;
-    /**
-     * Invoked when an error occurs.
-     */
-    onError?: (event: ErrorEvent) => void;
-    /**
-     * Invoked each time the player has loaded media data.
-     */
-    onProgress?: (event: ProgressEvent) => void;
-    /**
-     * Invoked when the player's internal paused state changes to `false`.
-     */
-    onPlay?: () => void;
-    /**
-     * Invoked when playback is ready to start after having been paused or delayed due to
-     * lack of media data.
-     */
-    onPlaying?: () => void;
-    /**
-     * Invoked when the player's internal paused state changes to `true`.
-     */
-    onPause?: () => void;
-    /**
-     * Invoked when a seek operation starts and the player is seeking a new position.
-     */
-    onSeeking?: () => void;
-    /**
-     * Invoked when a seek operation completed and the current playback position has changed.
-     */
-    onSeeked?: () => void;
-    /**
-     * Invoked when playback has stopped because the end of the media was reached or because
-     * no further data is available.
-     */
-    onEnded?: () => void;
-    /**
-     * Invoked each time the current playback position changed.
-     */
-    onTimeUpdate?: (event: TimeUpdateEvent) => void;
-    /**
-     * Invoked when the player's duration attribute has been updated.
-     */
-    onDurationChange?: (event: DurationChangeEvent) => void;
-    /**
-     * Invoked when a segment can not be found.
-     *
-     * @remarks
-     * <br/> - Only dispatched on DASH streams.
-     */
-    onSegmentNotFound?: (event: SegmentNotFoundEvent) => void;
-    /**
-     * Invoked when a text track list event occurs.
-     */
-    onTextTrackListEvent?: (event: TextTrackListEvent) => void;
-    /**
-     * Invoked when a text track event occurs.
-     */
-    onTextTrackEvent?: (event: TextTrackEvent) => void;
-    /**
-     * Invoked when a media track list event occurs.
-     */
-    onMediaTrackListEvent?: (event: MediaTrackListEvent) => void;
-    /**
-     * Invoked when a media track event occurs.
-     */
-    onMediaTrackEvent?: (event: MediaTrackEvent) => void;
-    /**
-     * Invoked when an ad event occurs.
-     */
-    onAdEvent?: (event: AdEvent) => void;
-    /**
-     * Invoked when a cast event occurs, either for Chromecast or Airplay.
-     */
-    onCastEvent?: (event: CastEvent) => void;
-}
-export interface THEOplayerViewComponent {
-    /**
-     * Seek to a new position.
-     *
-     * @param seekTime - new time, in milliseconds.
-     */
-    seek: (seekTime: number) => void;
-    /**
-     * The API for advertisements.
-     */
-    ads: AdsAPI;
-    /**
-     * The API for casting devices.
-     */
-    cast: CastAPI;
-}

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

@@ -1,12 +0,0 @@
-export * from './abr/barrel';
-export * from './ads/barrel';
-export * from './cast/barrel';
-export * from './config/barrel';
-export * from './error/barrel';
-export * from './event/barrel';
-export * from './drm/barrel';
-export * from './source/barrel';
-export * from './timeranges/barrel';
-export * from './track/barrel';
-export * from './utils/barrel';
-export * from './THEOplayerView';

package/lib/typescript/src/api/cast/Airplay.d.ts

@@ -1,27 +0,0 @@
-/**
- * The Airplay API.
- *
- * @public
- */
-import type { CastState } from "./CastState";
-export interface Airplay {
-    /**
-     * Whether the player is connected with an airplay device.
-     */
-    casting(): Promise<boolean>;
-    /**
-     * The state of the casting process.
-     */
-    state(): Promise<CastState>;
-    /**
-     * Start a casting session with the player's source.
-     *
-     * @remarks
-     * <br/> - A native browser pop-up will prompt to choose an airplay device.
-     */
-    start(): void;
-    /**
-     * Stop the active casting session.
-     */
-    stop(): void;
-}

package/lib/typescript/src/api/cast/CastAPI.d.ts

@@ -1,25 +0,0 @@
-import type { Airplay } from "./Airplay";
-import type { Chromecast } from "./Chromecast";
-/**
- * The API for casting.
- */
-export interface CastAPI {
-    /**
-     * Whether the player is connected with a casting device.
-     */
-    casting(): Promise<boolean>;
-    /**
-     * The Chromecast API.
-     *
-     * @remarks
-     * <br/> - Only available when the feature or extension `'chromecast'` is enabled.
-     */
-    readonly chromecast?: Chromecast;
-    /**
-     * The Airplay API.
-     *
-     * @remarks
-     * <br/> - Only available when the feature or extension `'airplay'` is enabled.
-     */
-    readonly airplay?: Airplay;
-}

package/lib/typescript/src/api/cast/CastState.d.ts

@@ -1,10 +0,0 @@
-/**
- * The state of a casting process, represented by a value from the following list:
- * <br/> - `'unavailable'`: No available cast devices.
- * <br/> - `'available'`: Cast device available, but the player is not connected.
- * <br/> - `'connecting'`: Cast device available and the player is connecting.
- * <br/> - `'connected'`: Cast device available and the player is connected.
- *
- * @public
- */
-export declare type CastState = 'unavailable' | 'available' | 'connecting' | 'connected';

package/lib/typescript/src/api/cast/Chromecast.d.ts

@@ -1,39 +0,0 @@
-/**
- * The Airplay API.
- *
- * @public
- */
-import type { CastState } from "./CastState";
-export interface Chromecast {
-    /**
-     * Whether the player is connected with a chromecast device.
-     */
-    casting(): Promise<boolean>;
-    /**
-     * The state of the casting process.
-     */
-    state(): Promise<CastState>;
-    /**
-     * Start a casting session with the player's source.
-     *
-     * @remarks
-     * <br/> - A native browser pop-up will prompt to choose a chromecast device.
-     */
-    start(): void;
-    /**
-     * Stop the active casting session.
-     */
-    stop(): void;
-    /**
-     * Join an active casting session.
-     */
-    join(): void;
-    /**
-     * Leave the active casting session.
-     *
-     * @remarks
-     * <br/> - Does not stop the session when other devices are connected.
-     * <br/> - Use {@link stop} to fully stop the session.
-     */
-    leave(): void;
-}

package/lib/typescript/src/api/config/PlayerConfiguration.d.ts

@@ -1,24 +0,0 @@
-import type { AdsConfiguration } from '../ads/AdsConfiguration';
-import type { CastConfiguration } from '../cast/CastConfiguration';
-export interface PlayerConfiguration {
-    /**
-     * The ads configuration for the player.
-     */
-    ads?: AdsConfiguration;
-    /**
-     * The cast configuration for the player.
-     */
-    cast?: CastConfiguration;
-    /**
-     * The license for the player
-     */
-    readonly license?: string;
-    /**
-     * The url to fetch the license for the player
-     */
-    readonly licenseUrl?: string;
-    /**
-     * Sets whether the native player is chromeless (without UI).
-     */
-    readonly chromeless?: boolean;
-}

package/lib/typescript/src/api/event/AdEvent.d.ts

@@ -1,13 +0,0 @@
-import type { Ad, AdBreak } from 'react-native-theoplayer';
-export interface AdEvent {
-    /**
-     * Type of ad event.
-     */
-    type: AdEventType;
-    /**
-     * The ad or adbreak for which the event was dispatched.
-     */
-    ad: Ad | AdBreak;
-}
-export declare const AdEventNames: readonly ["addadbreak", "removeadbreak", "adloaded", "adbreakbegin", "adbreakend", "adbreakchange", "updateadbreak", "addad", "adbegin", "adend", "updatead", "adloaded", "adfirstquartile", "admidpoint", "adthirdquartile", "adskip", "adimpression", "aderror", "admetadata", "adbuffering"];
-export declare type AdEventType = typeof AdEventNames[number];

package/lib/typescript/src/api/event/CastEvent.d.ts

@@ -1,21 +0,0 @@
-import type { CastState, ChromecastError } from 'react-native-theoplayer';
-export declare const CastEventNames: readonly ["chromecaststatechange", "airplaystatechange", "chromecasterror"];
-export declare type CastEventType = typeof CastEventNames[number];
-export interface CastEvent {
-    /**
-     * Type of ad event.
-     */
-    readonly type: CastEventType;
-}
-export interface ChromecastChangeEvent extends CastEvent {
-    readonly type: 'chromecaststatechange';
-    readonly state: CastState;
-}
-export interface AirplayStateChangeEvent extends CastEvent {
-    readonly type: 'airplaystatechange';
-    readonly state: CastState;
-}
-export interface ChromecastErrorEvent extends CastEvent {
-    readonly type: 'chromecasterror';
-    readonly error: ChromecastError;
-}

package/lib/typescript/src/api/event/PlayerEvent.d.ts

@@ -1,56 +0,0 @@
-import type { MediaTrack, PlayerError, TextTrack } from 'react-native-theoplayer';
-import type { TimeRange } from '../timeranges/TimeRange';
-export interface ErrorEvent {
-    error: PlayerError;
-}
-export interface LoadedMetadataEvent {
-    textTracks: TextTrack[];
-    audioTracks: MediaTrack[];
-    videoTracks: MediaTrack[];
-    duration: number;
-    selectedTextTrack: number | undefined;
-    selectedVideoTrack: number | undefined;
-    selectedAudioTrack: number | undefined;
-}
-export interface TimeUpdateEvent {
-    /**
-     * The player's current time, in msecs.
-     */
-    readonly currentTime: number;
-    /**
-     * The player's current program date time, in msecs.
-     */
-    readonly currentProgramDateTime?: number;
-}
-export interface DurationChangeEvent {
-    /**
-     * The player's new duration, in msecs.
-     */
-    readonly duration: number;
-}
-export interface ReadyStateChangeEvent {
-    /**
-     * The player's new ready state.
-     */
-    readonly readyState: number;
-}
-export interface ProgressEvent {
-    /**
-     * The ranges of the media resource that are seekable by the player.
-     */
-    readonly seekable: TimeRange[];
-}
-export interface SegmentNotFoundEvent {
-    /**
-     * Start time of the segment.
-     */
-    readonly segmentStartTime: number;
-    /**
-     * Descriptive error message.
-     */
-    readonly error: string;
-    /**
-     * Number of times the segment was retried.
-     */
-    readonly retryCount: number;
-}

package/lib/typescript/src/api/event/TrackEvent.d.ts

@@ -1,92 +0,0 @@
-import type { TextTrack } from '../track/TextTrack';
-import type { TextTrackCue } from '../track/TextTrackCue';
-import type { MediaTrack } from '../track/MediaTrack';
-import type { Quality } from '../track/Quality';
-export declare enum TrackListEventType {
-    /**
-     * Dispatched when track has been added to the track list.
-     */
-    AddTrack = 0,
-    /**
-     * Dispatched when track has been removed from the track list.
-     */
-    RemoveTrack = 1,
-    /**
-     * Fired when a track has been changed.
-     */
-    ChangeTrack = 2
-}
-export interface TrackListEvent {
-    /**
-     * The type of track list event.
-     */
-    readonly type: TrackListEventType;
-}
-export interface TextTrackListEvent extends TrackListEvent {
-    /**
-     * The relevant text track.
-     */
-    readonly track: TextTrack;
-}
-export declare enum TextTrackEventType {
-    /**
-     * Dispatched when cue has been added to the text track.
-     */
-    AddCue = 0,
-    /**
-     * Dispatched when cue has been removed from the text track.
-     */
-    RemoveCue = 1
-}
-export interface TextTrackEvent {
-    /**
-     * The type of text track event.
-     */
-    readonly type: TextTrackEventType;
-    /**
-     * The text track's uid to which this cue belongs.
-     */
-    readonly trackUid: number;
-    /**
-     * The text track's cue.
-     */
-    readonly cue: TextTrackCue;
-}
-export declare enum MediaTrackType {
-    Audio = 0,
-    Video = 1
-}
-export interface MediaTrackListEvent extends TrackListEvent {
-    /**
-     * The relevant media track type, either {@link MediaTrackType.Audio} or {@link MediaTrackType.Video}.
-     */
-    readonly trackType: MediaTrackType;
-    /**
-     * The relevant media track.
-     */
-    readonly track: MediaTrack;
-}
-export declare enum MediaTrackEventType {
-    /**
-     * Dispatched when the media track's active quality changes.
-     */
-    ActiveQualityChanged = 0
-}
-export interface MediaTrackEvent {
-    /**
-     * The type of media track event.
-     */
-    readonly type: MediaTrackEventType;
-    /**
-     * The media track's type to which event belongs, either {@link MediaTrackType.Audio} or {@link MediaTrackType.Video}.
-     */
-    readonly trackType: MediaTrackType;
-    /**
-     * The media track's uid to which event belongs.
-     */
-    readonly trackUid: number;
-    /**
-     * The affected media track's qualities.
-     */
-    readonly qualities?: Quality | Quality[];
-}

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

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

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

@@ -1,94 +0,0 @@
-/**
- * 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 type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';