@theoplayer/extended 4.2.0 → 4.3.1

package/THEOplayer.d.ts

@@ -2,7 +2,7 @@
  * THEOplayer
  * https://www.theoplayer.com
  *
- * Version: 2022.4.0 (4.2.0)
+ * Version: 2022.4.1 (4.3.1)
  */
 
 /**
@@ -24,7 +24,8 @@ export declare interface ABRConfiguration {
      * The amount which the player should buffer ahead of the current playback position, in seconds.
      *
      * @remarks
-     * <br/> - This duration has a maximum of 60 seconds.
+     * <br/> - Before v4.3.0: This duration has a maximum of 60 seconds.
+     * <br/> - After v4.3.0: This duration has no maximum.
      * <br/> - The player might reduce or ignore the configured amount because of device or performance constraints.
      *
      * @defaultValue `20`
@@ -363,6 +364,18 @@ export declare interface AddTrackEvent extends Event_2<'addtrack'> {
     readonly track: Track;
 }
 
+/**
+ * Fired when a new {@link View} has been added to the {@link MultiViewPlayer}.
+ *
+ * @public
+ */
+export declare interface AddViewEvent extends Event_2<'addview'> {
+    /**
+     * The view that has been added.
+     */
+    readonly view: View;
+}
+
 /**
  * The integration of an ad break, represented by a value from the following list:
  * <br/> - `'theo'`: Default ad playback.
@@ -1964,7 +1977,7 @@ export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap>
     /**
      * Returns a TimeRanges object that represents the ranges of the media resource that the player has buffered.
      */
-    buffered: TimeRanges;
+    readonly buffered: TimeRanges;
     /**
      * The clip API.
      */
@@ -3434,6 +3447,10 @@ export declare enum ErrorCode {
      * The license has expired.
      */
     LICENSE_EXPIRED = 2003,
+    /**
+     * The provided license does not contain the necessary feature.
+     */
+    LICENSE_INVALID_FEATURE = 2004,
     /**
      * The source provided is not valid.
      */
@@ -5544,6 +5561,18 @@ export declare interface LatencyManager {
     readonly configuration: LatencyConfiguration;
 }
 
+/**
+ * Fired when {@link MultiViewPlayer.layout} changes.
+ *
+ * @public
+ */
+export declare interface LayoutChangeEvent extends Event_2<'layoutchange'> {
+    /**
+     * The new layout of the player.
+     */
+    readonly layout: MultiViewPlayerLayout;
+}
+
 /**
  * A request for a license.
  * @public
@@ -6000,6 +6029,287 @@ export declare interface MoatConfiguration extends AnalyticsDescription {
     partnerCode: string;
 }
 
+/**
+ * The MultiViewPlayer API.
+ *
+ * @remarks
+ * <br/> - Available since v4.3.0
+ * <br/> - Only available with the feature `'multiviewplayer'`.
+ * <br/> - Only supported on modern browsers such as evergreen Chrome, Firefox and Safari. Not supported on Internet Explorer.
+ *
+ * @public
+ */
+export declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap> {
+    /**
+     * Returns all {@link View}s in their respective order.
+     */
+    readonly views: ReadonlyArray<View>;
+    /**
+     * The currently selected layout.
+     */
+    layout: MultiViewPlayerLayout;
+    /**
+     * Returns a TimeRanges object that represents the intersection of all buffered properties of the underlying players.
+     */
+    readonly buffered: TimeRanges;
+    /**
+     * The current playback position of the player currently at position zero.
+     */
+    currentTime: number;
+    /**
+     *  Whether the player should immediately start playback.
+     *
+     *  @remarks
+     *  <br/> - To autoplay with sound on certain platforms, {@link MultiViewPlayer.prepareWithUserAction} must be called at least once.
+     *  <br/> - To autoplay without sound, {@link PlayerConfiguration.mutedAutoplay} must be configured.
+     */
+    autoplay: boolean;
+    /**
+     * Returns the minimum of all duration properties of the underlying players.
+     */
+    readonly duration: number;
+    /**
+     * Whether any of the underlying players is ended.
+     */
+    readonly ended: boolean;
+    /**
+     * Returns the last error that occurred of the underlying players.
+     */
+    readonly errorObject: THEOplayerError | undefined;
+    /**
+     * Whether all the underlying players are muted.
+     */
+    muted: boolean;
+    /**
+     * Whether any of the underlying players is muted.
+     */
+    readonly paused: boolean;
+    /**
+     * Returns the playbackRate of the player at position zero.
+     */
+    playbackRate: number;
+    /**
+     * Returns the intersection of all played properties of the underlying players.
+     */
+    readonly played: TimeRanges;
+    /**
+     * Returns the minimum of all readyState properties of the underlying players.
+     */
+    readonly readyState: number;
+    /**
+     * Returns the intersection of all seekable properties of the underlying players.
+     */
+    readonly seekable: TimeRanges;
+    /**
+     * Whether any of the underlying players is seeking.
+     */
+    readonly seeking: boolean;
+    /**
+     * Returns the volume of the player at position zero.
+     */
+    volume: number;
+    /**
+     * Creates a new view.
+     *
+     * @param label - The name belonging to a view which is used in the multiview menu.
+     * @param source - The SourceDescription set on the view.
+     * @param description - A short description of the view which will be displayed on top.
+     *
+     * @remarks
+     * <br/> - If the given label clashes with an existing label, the existing view will be returned.
+     * <br/> - A player which is created is with position set to the length of {@link MultiViewPlayer.views}.
+     */
+    load(label: string, source: SourceDescription, description?: string): View;
+    /**
+     * Calls play() on all underlying players and starts in-sync playback.
+     */
+    play(): void;
+    /**
+     * Calls pause() on all underlying players.
+     */
+    pause(): void;
+    /**
+     * Stops playback and removes all views.
+     */
+    stop(): void;
+    /**
+     * Calls destroy() on all underlying players and removes all views.
+     */
+    destroy(): void;
+    /**
+     * Enables fullscreen mode on the element of the MultiViewPlayer.
+     */
+    requestFullscreen(options?: FullscreenOptions): void;
+    /**
+     * Disables fullscreen mode.
+     */
+    exitFullscreen(): void;
+    /**
+     * Calls prepareWithUserAction() on all underlying players.
+     */
+    prepareWithUserAction(): void;
+    /**
+     * {@inheritDoc EventDispatcher.addEventListener}
+     */
+    addEventListener<TType extends StringKeyOf<MultiViewPlayerEventMap>>(type: TType | readonly TType[], listener: EventListener_2<MultiViewPlayerEventMap[TType]>): void;
+    /**
+     * {@inheritDoc EventDispatcher.removeEventListener}
+     */
+    removeEventListener<TType extends StringKeyOf<MultiViewPlayerEventMap>>(type: TType | readonly TType[], listener: EventListener_2<MultiViewPlayerEventMap[TType]>): void;
+}
+
+/**
+ * The MultiViewPlayer API
+ *
+ * @public
+ */
+export declare interface MultiViewPlayerEventMap {
+    /**
+     * Fired when the first {@link View} enters {@link MultiViewPlayer.views} or all views are removed.
+     */
+    sourcechange: SourceChangeEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.paused} changes to `false`.
+     *
+     * @remarks
+     * <br/> - Either fired after the play() method has returned, or when the {@link MultiViewPlayer.autoplay} attribute has caused playback to begin.
+     */
+    play: PlayEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.paused} changes to `true`.
+     *
+     * @remarks
+     * <br/> - Fired after the `pause()` method has returned.
+     */
+    pause: PauseEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.seeking} changes to `true`, and the player has started seeking to a new position.
+     */
+    seeking: SeekingEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.seeking} changes to `false` after the current playback position was changed.
+     */
+    seeked: SeekedEvent;
+    /**
+     * Fired when the current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously.
+     */
+    timeupdate: TimeUpdateEvent;
+    /**
+     * Fired when playback has stopped because the end of the media resource was reached.
+     */
+    ended: EndedEvent;
+    /**
+     * Fired when playback is ready to start after having been paused or delayed due to lack of media data.
+     */
+    playing: PlayingEvent;
+    /**
+     * Fired when playback has stopped because the next frame is not available, but the player expects that frame to become available in due course.
+     */
+    waiting: WaitingEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.readyState} changes.
+     */
+    readystatechange: ReadyStateChangeEvent;
+    /**
+     * Fired when the player determines the duration and dimensions of the media resources for all {@link View}s.
+     *
+     * @remarks
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-readystate | HTML media - network state events}.
+     * <br/> - The {@link MultiViewPlayer.seekable | seekable range} should be available as soon as the {@link MultiViewPlayer.duration | duration} is known. However, certain browsers (e.g. Safari) do not make it available until the `loadeddata` event is fired.
+     */
+    loadedmetadata: LoadedMetadataEvent;
+    /**
+     * Fired when the player can render the media data at the current playback position for the first time.
+     *
+     * @remarks
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-readystate | HTML media - network state events}.
+     */
+    loadeddata: LoadedDataEvent;
+    /**
+     * Fired when the player can resume playback of the media data.
+     *
+     * @remarks
+     * <br/> - In comparison to `canplaythrough`, the player estimates that if playback were to be started now, the media resource could not be rendered at the current playback rate up to its end without having to stop for further buffering of content.
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-readystate | HTML media - network state events}.
+     */
+    canplay: CanPlayEvent;
+    /**
+     * Fired when the player can resume playback of the media data and buffering is unlikely.
+     *
+     * @remarks
+     * <br/> - In comparison to `canplay`, the player estimates that if playback were to be started now, the media resource could be rendered at the current playback rate all the way to its end without having to stop for further buffering.
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-readystate | HTML media - network state events}.
+     */
+    canplaythrough: CanPlayThroughEvent;
+    /**
+     * Fired when the player has started loading the manifest of all {@link View}s.
+     *
+     * @remarks
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-networkstate | HTML media - network state events}.
+     */
+    loadstart: Event_2<'loadstart'>;
+    /**
+     * Fired when the player loaded media data.
+     *
+     * @remarks
+     * <br/> - For DASH streams, the event is fired every 350ms or for every byte received whichever is least frequent.
+     * <br/> - See {@link https://html.spec.whatwg.org/multipage/media.html#mediaevents:dom-media-networkstate | HTML media - network state events}.
+     */
+    progress: ProgressEvent_2;
+    /**
+     * Fired when {@link MultiViewPlayer.duration} changes.
+     *
+     * @remarks
+     * <br/> - Fired after {@link MultiViewPlayer.readyState} has loaded metadata, or when the last segment is appended and there is a mismatch with the original duration.
+     */
+    durationchange: DurationChangeEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.volume} changes.
+     */
+    volumechange: VolumeChangeEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.playbackRate} changes.
+     */
+    ratechange: RateChangeEvent;
+    /**
+     * Fired when an error occurs.
+     */
+    error: ErrorEvent_2;
+    /**
+     * Fired when the player goes into or out of fullscreen.
+     */
+    fullscreenchange: Event_2<'fullscreenchange'>;
+    /**
+     * Fired when a {@link View} is added.
+     */
+    addview: AddViewEvent;
+    /**
+     * Fired when a {@link View} is removed.
+     */
+    removeview: RemoveViewEvent;
+    /**
+     * Fired when a view's {@link View.enabled | enabled} changes.
+     */
+    viewchange: ViewChangeEvent;
+    /**
+     * Fired when a {@link View} swapped positions in the list.
+     */
+    viewpositionchange: ViewPositionChangeEvent;
+    /**
+     * Fired when {@link MultiViewPlayer.layout} changes.
+     */
+    layoutchange: LayoutChangeEvent;
+}
+
+/**
+ * @public
+ */
+export declare enum MultiViewPlayerLayout {
+    GALLERY = "gallery",
+    OVERLAY = "overlay",
+    SPOTLIGHT = "spotlight"
+}
+
 /**
  * The muted autoplay policy of a player.
  * <br/> - `'none'`: Disallow muted autoplay. If the player is requested to autoplay while unmuted, and the platform does not support unmuted autoplay, the player will not start playback.
@@ -7003,6 +7313,18 @@ export declare interface RemoveTrackEvent extends Event_2<'removetrack'> {
     readonly track: Track;
 }
 
+/**
+ * Fired when a {@link View} has been removed from the {@link MultiViewPlayer}.
+ *
+ * @public
+ */
+export declare interface RemoveViewEvent extends Event_2<'removeview'> {
+    /**
+     * The view that has been removed.
+     */
+    readonly view: View;
+}
+
 /**
  * Represents a DASH representation.
  *
@@ -9100,6 +9422,13 @@ export declare interface UIConfiguration {
      * <br/> - Available since v2.90.0.
      */
     fullscreenOptions?: FullscreenOptions_2;
+    /**
+     * Actions that define the behavior of the player
+     *
+     * @remarks
+     * <br/> - Available since v4.3.0
+     */
+    userActions?: UserActions;
 }
 
 /**
@@ -9394,6 +9723,19 @@ export declare interface UpNextSource {
     duration?: string;
 }
 
+/**
+ * @public
+ */
+export declare interface UserActions {
+    /**
+     * Whether clicking the player element will play/pause the player.
+     *
+     * @defaultValue `true`
+     * @public
+     */
+    click?: boolean | ((event: any) => void);
+}
+
 /**
  * Utils that serve common use cases. For example encoding and decoding a base64 string to Uint8Array and vice versa.
  * @public
@@ -11061,6 +11403,108 @@ export declare interface VideoQuality extends Quality {
     readonly firstFrame: number;
 }
 
+/**
+ * The View API
+ *
+ * @public
+ */
+export declare interface View {
+    /**
+     * The label with which the view was created.
+     */
+    readonly label: string;
+    /**
+     * The position in {@link MultiViewPlayer.views}.
+     *
+     * @remarks
+     * <br/> - Only the position of an enabled view can be set to zero.
+     */
+    position: number;
+    /**
+     * Whether audio is muted.
+     */
+    muted: boolean;
+    /**
+     * Returns if the View can be resized.
+     *
+     * @remarks
+     * <br/> - Returns true if {@link MultiViewPlayer.layout} is set to {@link MultiViewPlayerLayout.OVERLAY} and the position is not equal to zero.
+     */
+    readonly canResize: boolean;
+    /**
+     * The horizontal offset in percentage.
+     *
+     * @remarks
+     * <br/> - It describes the offset of the top left corner of the view relative to the top left corner of the MultiViewPlayer.
+     * <br/> - Cannot be set if canResize is false.
+     */
+    x: number;
+    /**
+     * The vertical offset in percentage.
+     *
+     * @remarks
+     * <br/> - It describes the offset of the top left corner of the view relative to the top left corner of the MultiViewPlayer.
+     * <br/> - Cannot be set if canResize is false.
+     */
+    y: number;
+    /**
+     * The percentage relative to the total width of the containing MultiViewPlayer.
+     *
+     * @remarks
+     * <br/> - Cannot be set if canResize is false.
+     */
+    width: number;
+    /**
+     * The percentage relative to the total height of the containing MultiViewPlayer.
+     *
+     * @remarks
+     * <br/> - Cannot be set if canResize is false.
+     */
+    height: number;
+    /**
+     * Whether the view is visible or not.
+     *
+     * @remarks
+     * <br/> - The view at position zero is always enabled.
+     */
+    enabled: boolean;
+    /**
+     * Destroys the associated player and removes the view from the MultiViewPlayer.
+     *
+     * @remarks
+     * <br/> - The view at position zero cannot be removed.
+     */
+    remove(): void;
+}
+
+/**
+ * Fired when a view's {@link View.enabled | enabled} changes.
+ *
+ * @public
+ */
+export declare interface ViewChangeEvent extends Event_2<'viewchange'> {
+    /**
+     * The view that has been changed.
+     */
+    readonly view: View;
+}
+
+/**
+ * Fired when a {@link View} has swapped positions in the list.
+ *
+ * @public
+ */
+export declare interface ViewPositionChangeEvent extends Event_2<'viewpositionchange'> {
+    /**
+     * The position of the view whose position has changed.
+     */
+    readonly oldPosition: number;
+    /**
+     * The new position of the view
+     */
+    readonly newPosition: number;
+}
+
 /**
  * Describes the configuration of the Vimond DRM integration.
  *