@gcorevideo/player 2.18.3 → 2.19.1

package/dist/player.d.ts

@@ -1,646 +0,0 @@
-/**
- * Video player for the Gcore streaming platform
- *
- * @remarks
- * This package provides a video player for the Gcore streaming platform.
- * It is built on top of the Clappr library and provides a framework for building custom integrations.
- *
- * @packageDocumentation
- */
-
-import { Logger } from '@gcorevideo/utils';
-import { LogTracer } from '@gcorevideo/utils';
-import { reportError as reportError_2 } from '@gcorevideo/utils';
-import { SentryTracer } from '@gcorevideo/utils';
-import { setTracer } from '@gcorevideo/utils';
-import { trace } from '@gcorevideo/utils';
-
-/**
- * Dimensions of the player container DOM element.
- * @beta
- */
-export declare type ContainerSize = {
-    width: number;
-    height: number;
-};
-
-/**
- * A plain JS object that must conform to the DASH.js settings schema.
- * @beta
- * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}
- */
-export declare type DashSettings = Record<string, unknown>;
-
-/**
- * Levels of severity of errors. Non-fatal errors usually can be ignored.
- * @beta
- */
-export declare type ErrorLevel = 'FATAL' | 'WARN' | 'INFO';
-
-/**
- * An ISO 639-1 language code.
- * @example `pt`
- * @beta
- */
-export declare type LangTag = string;
-
-export { Logger }
-
-export { LogTracer }
-
-/**
- * Media delivery protocol
- * @beta
- */
-export declare type MediaTransport = 'dash' | 'hls';
-
-/**
- * An error occurred during the playback.
- * @beta
- */
-export declare interface PlaybackError {
-    /**
-     * Error code.
-     */
-    code: PlaybackErrorCode;
-    /**
-     * Detailed description of the error.
-     */
-    description: string;
-    /**
-     * Level of severity of the error.
-     */
-    level: ErrorLevel;
-    /**
-     * Error message. Non-fatal usually can be ignored.
-     */
-    message: string;
-    /**
-     * Exact component that originated the error.
-     * @example
-     * - 'core'
-     * - 'dash'
-     * - 'media_control'
-     */
-    origin: string;
-    /**
-     * Component subsystem of the error origin
-     */
-    scope: PlayerComponentType;
-}
-
-/**
- * Codes of errors occurring within the playback component.
- * @beta
- */
-export declare enum PlaybackErrorCode {
-    /**
-     * An unknown or uncategorised error.
-     */
-    Generic = 0,
-    /**
-     * The media source is not available. Typically a network error.
-     */
-    MediaSourceUnavailable = 1,
-    /**
-     * The media source is not accessible due to some protection policy.
-     */
-    MediaSourceAccessDenied = 3
-}
-
-/**
- * Module to perform the playback.
- * @beta
- */
-export declare type PlaybackModule = 'dash' | 'hls' | 'html5_video';
-
-/**
- * Type of a stream playback
- * @beta
- */
-export declare type PlaybackType = 'live' | 'vod';
-
-/**
- * The main component to use in the application code.
- * @beta
- * @remarks
- * The Player object provides very basic API to control playback.
- * To build a sophisticated UI, use the plugins framework to tap into the Clappr core.
- * {@link https://github.com/clappr/clappr/wiki/Architecture}
- */
-export declare class Player {
-    private config;
-    private emitter;
-    private player;
-    private ready;
-    private rootNode;
-    private tuneInTimerId;
-    private tunedIn;
-    constructor(config: PlayerConfig);
-    /**
-     * Adds a listener to a player event
-     * @param event - event type, see {@link PlayerEvent}
-     * @param handler - a callback function to handle the event
-     */
-    on<E extends PlayerEvent>(event: E, handler: PlayerEventHandler<E>): void;
-    /**
-     * Removes a previously added event listener
-     * @param event - See {@link PlayerEvent}
-     * @param handler - a callback attached earlier to that event type
-     */
-    off<E extends PlayerEvent>(event: E, handler: PlayerEventHandler<E>): void;
-    /**
-     * Configures the player.
-     *
-     * @param config - complete or partial configuration
-     * @remarks
-     * Can be called multiple times.
-     * Each consequent call extends the previous configuration with only the new keys overridden.
-     *
-     * After a reconfiguration, if something significant has changed, it might make sense reinitialize the player (i.e, a `.destroy()` followed by an `.init()` call).
-     */
-    configure(config: Partial<PlayerConfig>): void;
-    /**
-     * Initializes the player at the given container element.
-     * @param playerElement - DOM element to host the player
-     * @remarks
-     * The player will be initialized and attached to the given element.
-     *
-     * All the core plugins will be initialized at this point.
-     *
-     * If no sources were configured, it will trigger an error.
-     *
-     * The player container will be initialized and then all the registered UI plugins.
-     *
-     * If the `autoPlay` option is set, then it will trigger playback immediately.
-     *
-     * It is an error to call this method twice. If you need to attache player to another DOM element,
-     * first call {@link Player.destroy} and then {@link Player.attachTo}.
-     *
-     * @example
-     * ```ts
-     * const player = new Player({
-     *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
-     * })
-     * document.addEventListener('DOMContentLoaded', () => {
-     *   player.attachTo(document.getElementById('video-container'))
-     * })
-     * ```
-     */
-    attachTo(playerElement: HTMLElement): void;
-    /**
-     * Destroys the player, releasing all resources and unmounting its UI from the DOM.
-     */
-    destroy(): void;
-    /**
-     * Current playback (time since the beginning of the stream), if appropriate.
-     *
-     * @returns Time in seconds
-     * @remarks
-     * For live streams, it returns the current time within the current segment.
-     */
-    getCurrentTime(): number;
-    /**
-     * Duration of the current media in seconds, if appropriate.
-     *
-     * @returns Time in seconds
-     * @remarks
-     * For live streams, it returns the duration of the current segment.
-     */
-    getDuration(): number;
-    /**
-     * Indicates whether DVR is enabled.
-     */
-    isDvrEnabled(): boolean;
-    /**
-     * Indicates whether DVR is in use.
-     * @remarks
-     * DVR mode, if it is enabled, is triggered we a user seeks behind the live edge.
-     */
-    isDvrInUse(): boolean;
-    /**
-     * Indicates muted state of the video.
-     * @remarks
-     * Note that muted state is independent from the volume level.
-     * See {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/muted}
-     */
-    isMuted(): boolean;
-    /**
-     * Indicates the playing state.
-     */
-    isPlaying(): boolean;
-    /**
-     * Mutes the sound of the video.
-     */
-    mute(): void;
-    /**
-     * Unmutes the video sound.
-     */
-    unmute(): void;
-    /**
-     * Pauses playback.
-     */
-    pause(): void;
-    /**
-     * Starts playback.
-     */
-    play(): void;
-    /**
-     * Resizes the player container element and everything within it.
-     * @param newSize - new size of the player
-     * @remarks
-     * Use this method when the player itself does not detect properly the change in size of its container element.
-     * It can be a case for orientation change on some mobile devices.
-     */
-    resize(newSize: ContainerSize): void;
-    /**
-     * Seeks to the given time.
-     * @param time - time to seek to in seconds (since the beginning of the stream)
-     */
-    seek(time: number): void;
-    /**
-     * Gets the current volume of the media content being played.
-     * @returns a number between 0 and 1
-     */
-    getVolume(): number;
-    /**
-     * Sets the current volume of the media content being played.
-     * @param volume - a number between 0 and 1
-     */
-    setVolume(volume: number): void;
-    /**
-     * Stops playback.
-     */
-    stop(): void;
-    /**
-     * Registers a plugin.
-     * @param plugin - a plugin class
-     * @remarks
-     * Use this method to extend the player with custom behavior.
-     * The plugin class must inherit from one of the Clappr UIPlugin, UIContainerPlugin or CorePlugin classes.
-     * A core plugin will be initialized and attached to the player when the player is initialized.
-     * A UI plugin will be initialized and attached to the player container is initialized.
-     *
-     * @see {@link https://github.com/clappr/clappr/wiki/Architecture}
-     * @example
-     * ```ts
-     * import MyPlugin from './MyPlugin.js'
-     *
-     * Player.registerPlugin(MyPlugin)
-     * ```
-     */
-    static registerPlugin(plugin: PlayerPlugin): void;
-    /**
-     * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
-     * @param plugin - a plugin class
-     */
-    static unregisterPlugin(plugin: PlayerPlugin): void;
-    private setConfig;
-    private initPlayer;
-    private tuneIn;
-    private safeTriggerEvent;
-    private events;
-    private buildCoreOptions;
-    private configurePlaybacks;
-    private buildMediaSourcesList;
-    private bindContainerEventListeners;
-    private bindSizeManagementListeners;
-}
-
-/**
- * Subsystems of a player component.
- * @beta
- */
-export declare type PlayerComponentType = 'container' | 'core' | 'playback';
-
-/**
- * Configuration options for the player
- *
- * @remarks
- *  You can specify multiple sources, each in two forms: just a plain URL or a full object with `source` and `mimeType` fields {@link PlayerMediaSource}.
- *  The player will pick the first viable media source according to the source availability, and either the transport preference or standard transport selection order.
- *
- * `priorityTransport` is used to specify the preferred transport protocol
- * when multiple sources are available.
- * It will first try to use the transport specified if it's supported (by a playback engine) and the source is available.
- * Otherwise it will try the other transports in the regular order (dash, hls, mpegts).
- *
- * The `autoPlay` option should be used together with the {@link PlayerConfig.mute | mute} to avoid issues with the browsers' autoplay policies.
- *
- * Note that the `playbackType` is specified explicitly in the examle below, but a playback engine might be able to detect the type of the stream automatically.
- *
- * A plugin options can be specified in the configuration object under a unique key, typically corresponding to the plugin name.
- * The plugin object will have access to the internal normalized configuration object that contains all the custom options.
- * in the examle below, the `poster` field is the `Poster` plugin configuration options.
- *
- * @example
- * ```ts
- * {
- *   autoPlay: true,
- *   mute: true,
- *   playbackType: 'live',
- *   priorityTransport: 'dash',
- *   sources: [{
- *     source: 'https://example.com/myownair66.mpd',
- *     mimeType: 'application/dash+xml',
- *   }, {
- *     source: 'https://example.com/myownair66.m3u8',
- *     mimeType: 'application/x-mpegURL',
- *   }],
- *   poster: {
- *     url: settings.poster,
- *   },
- * }
- * ```
- * @beta
- */
-export declare interface PlayerConfig extends Record<string, unknown> {
-    /**
-     * Start playback automatically when the player is ready
-     * @defaultValue false
-     */
-    autoPlay?: boolean;
-    /**
-     * Configuration settings for the DASH playback engine
-     * @defaultValue \{\}
-     * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html}
-     */
-    dash?: DashSettings;
-    /**
-     * Controls the debug output level
-     * @defaultValue 'none'
-     */
-    debug?: PlayerDebugSettings;
-    /**
-     * A language code for the player UI, for example, `es`. Must reference a key in the {@link PlayerConfig.strings | strings} record.
-     * @defaultValue 'en'
-     */
-    language?: string;
-    /**
-     * Repeat playback when the media ends.
-     * Is used with the `vod` {@link PlayerConfig.playbackType | playbackType}
-     * @defaultValue false
-     */
-    loop?: boolean;
-    /**
-     * Mute the audio output in order to comply with browsers' autoplay policy.
-     * @defaultValue false
-     */
-    mute?: boolean;
-    /**
-     * The type of playback (live stream or video on demand).
-     *
-     * @defaultValue 'vod'
-     */
-    playbackType?: PlaybackType;
-    /**
-     * Preferred transport protocol when multiple sources are available.
-     * @defaultValue 'dash'
-     */
-    priorityTransport?: TransportPreference;
-    /**
-     * List of media sources, at least one is required.
-     */
-    sources: PlayerMediaSource[];
-    /**
-     * Localization strings for the player UI.
-     */
-    strings?: TranslationSettings;
-}
-
-/**
- * @remarks `true` is equivalent to `'all'`, `false` is equivalent to `'none'`
- * @beta
- */
-export declare type PlayerDebugSettings = PlayerDebugTag | boolean;
-
-/**
- * Debug output category selector
- * @beta
- */
-export declare type PlayerDebugTag = 'all' | 'clappr' | 'dash' | 'hls' | 'none';
-
-/**
- * A top-level event on the player object
- * @beta
- */
-export declare enum PlayerEvent {
-    /**
-     * Playback has reached the end of the media.
-     */
-    Ended = "ended",
-    /**
-     * An error occurred.
-     * Parameters: {@link PlaybackError}
-     */
-    Error = "error",
-    /**
-     * The player has switched to or from the fullscreen mode.
-     * Parameters:`boolean` isFullscreen
-     */
-    Fullscreen = "fullscreen",
-    /**
-     * The player is ready to use.
-     */
-    Ready = "ready",
-    /**
-     * Playback has started.
-     */
-    Play = "play",
-    /**
-     * Playback has been paused.
-     */
-    Pause = "pause",
-    /**
-     * The player's container has been resized.
-     * Parameters: {@link ContainerSize}
-     */
-    Resize = "resize",
-    /**
-     * The player is seeking to a new position.
-     */
-    Seek = "seek",
-    /**
-     * Playback has been stopped.
-     */
-    Stop = "stop",
-    /**
-     * The current playback time has changed.
-     * Parameters: {@link TimePosition}
-     */
-    TimeUpdate = "timeupdate",
-    /**
-     * The volume has changed.
-     * Parameters: `number` volume in the range 0..1
-     */
-    VolumeUpdate = "volumeupdate"
-}
-
-/**
- * Type of a listener callback function for a player event.
- * See the description of the event parameters in {@link PlayerEvent}.
- * @beta
- */
-export declare type PlayerEventHandler<E extends PlayerEvent> = (...args: PlayerEventParams<E>) => void;
-
-/**
- * @beta
- */
-export declare type PlayerEventParams<E extends PlayerEvent> = E extends PlayerEvent.Seek ? [number] : E extends PlayerEvent.VolumeUpdate ? [number] : E extends PlayerEvent.TimeUpdate ? [TimePosition] : E extends PlayerEvent.Resize ? [{
-    width: number;
-    height: number;
-}] : E extends PlayerEvent.Fullscreen ? [boolean] : E extends PlayerEvent.Error ? [PlaybackError] : [];
-
-/**
- * A media source to fetch the media data from
- * @beta
- */
-export declare type PlayerMediaSource = string | PlayerMediaSourceDesc;
-
-/**
- * Describes a media source with its MIME type and URL.
- *
- * @remarks
- * When the MIME type is provided, it helps the player determine the appropriate playback engine.
- * If omitted, the player will attempt to detect the type from the source URL extension.
- * @beta
- */
-export declare interface PlayerMediaSourceDesc {
-    /**
-     * The MIME type of the media source (e.g. `"video/mp4"`, `"application/x-mpegURL"`).
-     * Necessary if the type cannot be detected from file extension of the source URL.
-     */
-    mimeType?: string;
-    /**
-     * URL of the media source
-     */
-    source: string;
-}
-
-/**
- * @beta
- * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}
- */
-export declare type PlayerPlugin = {
-    new (...args: any[]): unknown;
-    name: string;
-};
-
-/**
- * A level of quality within a media source.
- * @beta
- */
-export declare interface QualityLevel {
-    /**
-     * Zero-based index of the quality level.
-     */
-    level: number;
-    /**
-     * Width of the video, pixels.
-     */
-    width: number;
-    /**
-     * Height of the video, pixels.
-     */
-    height: number;
-    /**
-     * Bitrate of the video, bps.
-     */
-    bitrate: number;
-}
-
-export { reportError_2 as reportError }
-
-export { SentryTracer }
-
-export { setTracer }
-
-/**
- * Current playback time and total duration of the media.
- * @beta
- */
-export declare interface TimePosition {
-    /**
-     * Current playback time, 0..duration, seconds.
-     */
-    current: TimeValue;
-    /**
-     * Total duration of the media, seconds.
-     */
-    total: TimeValue;
-}
-
-/**
- * For the plugin development
- * @beta
- */
-export declare type TimeProgress = TimePosition & {
-    start: number;
-};
-
-/**
- * For the plugin development
- * @beta
- */
-export declare type TimeUpdate = TimePosition & {
-    firstFragDateTime: number;
-};
-
-/**
- * Playback time in seconds since the beginning of the stream (or a segment for the live streams)
- * @beta
- */
-export declare type TimeValue = number;
-
-export { trace }
-
-/**
- * @beta
- */
-export declare type TranslationKey = string;
-
-/**
- * Localization strings for the player UI.
- * @remarks
- * The keys are language codes, and the values are objects with keys being the translation keys and values being the translations.
- *
- * This dictionary is used to localize the player UI, including the error messages and is shared across all the player components (including the plugins).
- *
- * @example
- * ```
- * {
- *   en: {
- *     play: 'Play',
- *     ...
- *   },
- *   es: {
- *     play: 'Reproducir',
- *     ...
- *   },
- *   ...
- * }
- * ```
- *
- * @beta
- */
-export declare type TranslationSettings = Partial<Record<LangTag, Record<TranslationKey, string>>>;
-
-/**
- * Preferred media delivery protocol
- * @beta
- */
-export declare type TransportPreference = MediaTransport;
-
-/**
- * Version information about the gplayer and its main dependencies
- * @returns Version information about the gplayer and its main dependencies
- * @beta
- */
-export declare function version(): {
-    gplayer: string;
-    clappr: string;
-    dashjs: string;
-    hlsjs: string;
-};
-
-export { }

package/lib/backend.d.ts

@@ -1,3 +0,0 @@
-import { StreamMediaSource, StreamMediaSourceDto } from "./types";
-export declare function fromStreamMediaSourceDto(s: StreamMediaSourceDto): StreamMediaSource;
-//# sourceMappingURL=backend.d.ts.map

package/lib/backend.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAElE,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,oBAAoB,GAAG,iBAAiB,CASnF"}

package/lib/backend.js

@@ -1,10 +0,0 @@
-export function fromStreamMediaSourceDto(s) {
-    return ({
-        ...s,
-        hlsCmafUrl: s.hls_cmaf_url ?? null,
-        hlsMpegtsUrl: s.hls_mpegts_url ?? null,
-        priorityTransport: s.priority_transport,
-        sourceDash: s.source_dash,
-        vtt: s.vtt,
-    });
-}

package/lib/constants.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=constants.d.ts.map

package/lib/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":""}

package/lib/constants.js

@@ -1 +0,0 @@
-"use strict";