@gcorevideo/player 2.28.3 → 2.28.4

package/lib/plugins/statistics/Statistics.js

@@ -1,172 +0,0 @@
-// An example implementation of client side performancestatistics
-import { ContainerPlugin, Events, Playback } from '@clappr/core';
-import { reportError, trace } from '@gcorevideo/utils';
-import assert from 'assert';
-import { CLAPPR_VERSION } from '../../build.js';
-// const CUSTOM_EVENTS_CONTAINER_START = 'container:start'
-const WATCH_CUTOFF = 5;
-const HEATMAP_INTERVAL = 10;
-const T = 'plugins.statistics';
-/**
- * Collects and reports the performance statistics.
- * @beta
- * @example
- * ```ts
- * import { Statistics } from '@gcorevideo/player'
- *
- * Player.registerPlugin(Statistics)
- *
- * const player = new Player({
- *   statistics: {
- *     send: (data) => {
- *        fetch('/stats', {
- *          method: 'POST',
- *          body: JSON.stringify(data),
- *          headers: { 'content-type': 'application/json' },
- *        })
- *     }
- *   },
- *   ...
- * })
- * ```
- */
-export class Statistics extends ContainerPlugin {
-    /**
-     * The name of the plugin.
-     */
-    get name() {
-        return 'statistics';
-    }
-    /**
-     * The supported version of the plugin.
-     */
-    get supportedVersion() {
-        return { min: CLAPPR_VERSION };
-    }
-    started = false;
-    timeStart = 0;
-    heatmapSent = false;
-    heatmapLastTime = 0;
-    watchSent = false;
-    bufTracking = false;
-    lags = 0;
-    /**
-     * The time when buffering last started.
-     */
-    bufLastStarted = 0;
-    /**
-     * The accumulated buffering duration.
-     */
-    bufAccDuration = 0;
-    constructor(container) {
-        super(container);
-        assert(this.options.statistics &&
-            typeof this.options.statistics.send === 'function', 'Statistics plugin requires statistics options');
-    }
-    /**
-     * @internal
-     */
-    bindEvents() {
-        // TODO remove this
-        // this.listenToOnce(
-        //   this.container,
-        //   CUSTOM_EVENTS_CONTAINER_START,
-        //   this.onStart,
-        // )
-        this.listenToOnce(this.container, Events.CONTAINER_READY, this.onReady);
-        this.listenTo(this.container, Events.CONTAINER_STATE_BUFFERING, this.onBuffering);
-        this.listenTo(this.container, Events.CONTAINER_STATE_BUFFERFULL, this.onBufferFull);
-        this.listenTo(this.container.playback, Events.PLAYBACK_TIMEUPDATE, this.onTimeUpdateLive);
-        this.listenTo(this.container.playback, Events.PLAYBACK_LEVEL_SWITCH_START, this.startLevelSwitch);
-        this.listenTo(this.container.playback, Events.PLAYBACK_LEVEL_SWITCH_END, this.endLevelSwitch);
-    }
-    startLevelSwitch() {
-        this.bufTracking = false;
-    }
-    endLevelSwitch() {
-        this.bufTracking = true;
-    }
-    onBuffering() {
-        if (this.bufTracking) {
-            this.bufLastStarted = performance.now();
-        }
-    }
-    onBufferFull() {
-        if (this.bufTracking && this.bufLastStarted) {
-            this.bufAccDuration += performance.now() - this.bufLastStarted;
-            this.lags++;
-        }
-        this.bufTracking = true;
-    }
-    onReady() {
-        this.sendInit();
-        trace(`${T} onReady`, {
-            autoPlay: this.options.autoPlay,
-        });
-        if (this.options.autoPlay) {
-            this.onStart();
-        }
-        else {
-            this.listenToOnce(this.container.playback, Events.PLAYBACK_PLAY_INTENT, this.onStart);
-        }
-    }
-    sendInit() {
-        this.sendMessage('init');
-    }
-    sendMessage(state) {
-        this.send(state, {
-        // embed_url: this.options.referer,
-        // user_agent: Browser.userAgent
-        });
-    }
-    send(event, data = {}) {
-        ;
-        this.options.statistics.send({
-            event,
-            type: this.container.getPlaybackType(),
-            ...data,
-        });
-    }
-    sendHeatmap(time) {
-        const res = {
-            buffering: Math.round(this.bufAccDuration),
-            lags: this.lags,
-        };
-        this.bufAccDuration = 0;
-        this.lags = 0;
-        if (this.container.getPlaybackType() === Playback.VOD) {
-            res.timestamp = time;
-        }
-        this.send('heatmap', res);
-        this.heatmapSent = true;
-        this.heatmapLastTime = time;
-    }
-    onTimeUpdateLive({ current }) {
-        // TODO check the `current` values for the live streams
-        if (!this.timeStart) {
-            this.timeStart = current;
-        }
-        try {
-            const elapsed = current - this.timeStart;
-            const heatmapElapsed = current - this.heatmapLastTime;
-            // TODO check if the heatmap is only needed for the live streams
-            if (!this.heatmapSent || heatmapElapsed >= HEATMAP_INTERVAL) {
-                this.sendHeatmap(current);
-            }
-            if (!this.watchSent && elapsed >= WATCH_CUTOFF) {
-                this.watchSent = true;
-                this.sendMessage('watch');
-            }
-        }
-        catch (error) {
-            reportError(error);
-        }
-    }
-    onStart() {
-        if (this.started) {
-            return;
-        }
-        this.started = true;
-        this.sendMessage('start');
-    }
-}

package/lib/plugins/subtitles/Subtitles.d.ts

@@ -1,115 +0,0 @@
-import { UICorePlugin } from '@clappr/core';
-import '../../../assets/subtitles/style.scss';
-export type ClosedCaptionsPluginSettings = {
-    /**
-     * Initially selected subtitles language
-     */
-    language?: string;
-};
-/**
- * @deprecated Use {@link ClosedCaptionsPluginSettings} instead.
- */
-export type SubtitlesPluginSettings = ClosedCaptionsPluginSettings;
-/**
- * `PLUGIN` that provides a UI to select the subtitles when available.
- * @beta
- *
- * @remarks
- * Depends on:
- *
- * - {@link MediaControl}
- *
- * Configuration options -  {@link ClosedCaptionsPluginSettings}
- * @example
- * ```ts
- * import { ClosedCaptions } from '@gcorevideo/player'
- *
- * Player.registerPlugin(ClosedCaptions)
- *
- * new Player({
- *   ...
- *   cc: {
- *     language: 'en',
- *   },
- * })
- * ```
- */
-export declare class Subtitles extends UICorePlugin {
-    private isPreselectedApplied;
-    private isShowing;
-    private track;
-    private tracks;
-    private $line;
-    /**
-     * @internal
-     */
-    get name(): string;
-    /**
-     * @internal
-     */
-    get supportedVersion(): {
-        min: string;
-    };
-    /**
-     * @internal
-     */
-    static get version(): string;
-    private static readonly template;
-    private static readonly templateString;
-    /**
-     * @internal
-     */
-    get attributes(): {
-        class: string;
-    };
-    /**
-     * @internal
-     */
-    get events(): {
-        'click [data-cc-select]': string;
-        'click [data-cc-button]': string;
-    };
-    private get preselectedLanguage();
-    /**
-     * @internal
-     */
-    bindEvents(): void;
-    private onCoreReady;
-    private onContainerChanged;
-    private onSubtitleAvailable;
-    private onSubtitleChanged;
-    private applyTracks;
-    private onStartAd;
-    private onFinishAd;
-    private playerResize;
-    /**
-     * Hides the subtitles menu and the subtitles.
-     */
-    hide(): void;
-    /**
-     * Shows the subtitles menu and the subtitles.
-     */
-    show(): void;
-    private shouldRender;
-    private resizeFont;
-    /**
-     * @internal
-     */
-    render(): this;
-    private findById;
-    private selectItem;
-    private onItemSelect;
-    private applyPreselectedSubtitles;
-    private hideMenu;
-    private toggleMenu;
-    private itemElement;
-    private allItemElements;
-    private selectSubtitles;
-    private getSubtitleText;
-    private setSubtitleText;
-    private clearSubtitleText;
-    private updateSelection;
-    private highlightCurrentSubtitles;
-    private renderIcon;
-}
-//# sourceMappingURL=Subtitles.d.ts.map

package/lib/plugins/subtitles/Subtitles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Subtitles.d.ts","sourceRoot":"","sources":["../../../src/plugins/subtitles/Subtitles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAwB,MAAM,cAAc,CAAA;AAOzE,OAAO,sCAAsC,CAAA;AAe7C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC,OAAO,CAAC,oBAAoB,CAAQ;IAEpC,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,KAAK,CAA6B;IAE1C,OAAO,CAAC,MAAM,CAAsB;IAEpC,OAAO,CAAC,KAAK,CAA2B;IAExC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IAEzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAuB;IAE7D;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED,OAAO,KAAK,mBAAmB,GAE9B;IAED;;OAEG;IACM,UAAU;IAUnB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,kBAAkB;IAwC1B,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,iBAAiB;IA+BzB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,IAAI;IAWJ;;OAEG;IACH,IAAI;IAiBJ,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,UAAU;IAUlB;;OAEG;IACM,MAAM;IA0Bf,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAC,UAAU;CAKnB"}

package/lib/plugins/subtitles/Subtitles.js

@@ -1,345 +0,0 @@
-import { Events, UICorePlugin, Browser, template, $ } from '@clappr/core';
-import { reportError, trace } from '@gcorevideo/utils';
-import assert from 'assert';
-import { CLAPPR_VERSION } from '../../build.js';
-import '../../../assets/subtitles/style.scss';
-import subtitlesOffIcon from '../../../assets/icons/new/subtitles-off.svg';
-import subtitlesOnIcon from '../../../assets/icons/new/subtitles-on.svg';
-import comboboxHTML from '../../../assets/subtitles/combobox.ejs';
-import stringHTML from '../../../assets/subtitles/string.ejs';
-import { isFullscreen } from '../utils.js';
-const VERSION = '2.19.14';
-const LOCAL_STORAGE_CC_ID = 'gplayer.plugins.cc.selected';
-const T = 'plugins.cc';
-/**
- * `PLUGIN` that provides a UI to select the subtitles when available.
- * @beta
- *
- * @remarks
- * Depends on:
- *
- * - {@link MediaControl}
- *
- * Configuration options -  {@link ClosedCaptionsPluginSettings}
- * @example
- * ```ts
- * import { ClosedCaptions } from '@gcorevideo/player'
- *
- * Player.registerPlugin(ClosedCaptions)
- *
- * new Player({
- *   ...
- *   cc: {
- *     language: 'en',
- *   },
- * })
- * ```
- */
-export class Subtitles extends UICorePlugin {
-    isPreselectedApplied = false;
-    isShowing = false;
-    track = null;
-    tracks = [];
-    $line = null;
-    /**
-     * @internal
-     */
-    get name() {
-        return 'subtitles'; // TODO rename to 'cc'
-    }
-    /**
-     * @internal
-     */
-    get supportedVersion() {
-        return { min: CLAPPR_VERSION };
-    }
-    /**
-     * @internal
-     */
-    static get version() {
-        return VERSION;
-    }
-    static template = template(comboboxHTML);
-    static templateString = template(stringHTML);
-    /**
-     * @internal
-     */
-    get attributes() {
-        return {
-            class: 'media-control-cc',
-        };
-    }
-    /**
-     * @internal
-     */
-    get events() {
-        return {
-            'click [data-cc-select]': 'onItemSelect',
-            'click [data-cc-button]': 'toggleMenu',
-        };
-    }
-    get preselectedLanguage() {
-        return this.core.options.cc?.language ?? this.core.options.subtitles?.language ?? '';
-    }
-    /**
-     * @internal
-     */
-    bindEvents() {
-        this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
-        this.listenTo(this.core, Events.CORE_RESIZE, this.playerResize);
-        this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.onContainerChanged);
-    }
-    onCoreReady() {
-        trace(`${T} onCoreReady`);
-        const mediaControl = this.core.getPlugin('media_control');
-        assert(mediaControl, 'media_control plugin is required');
-        this.listenTo(mediaControl, Events.MEDIACONTROL_RENDERED, this.render);
-        this.listenTo(mediaControl, Events.MEDIACONTROL_HIDE, this.hideMenu);
-    }
-    onContainerChanged() {
-        trace(`${T} onContainerChanged`);
-        this.listenTo(this.core.activeContainer, Events.CONTAINER_FULLSCREEN, this.playerResize);
-        this.listenTo(this.core.activeContainer, 'container:advertisement:start', this.onStartAd);
-        this.listenTo(this.core.activePlayback, Events.PLAYBACK_SUBTITLE_AVAILABLE, this.onSubtitleAvailable);
-        this.listenTo(this.core.activePlayback, Events.PLAYBACK_SUBTITLE_CHANGED, this.onSubtitleChanged);
-        // fix for iOS
-        const video = this.core.activePlayback.el;
-        assert(video, 'video element is required');
-        video.addEventListener('webkitbeginfullscreen', () => {
-            if (Browser.isiOS) {
-                video.classList.add('ios-fullscreen');
-            }
-        });
-        video.addEventListener('webkitendfullscreen', () => {
-            if (Browser.isiOS) {
-                video.classList.remove('ios-fullscreen');
-            }
-        });
-    }
-    onSubtitleAvailable() {
-        trace(`${T} onSubtitleAvailable`);
-        this.applyTracks();
-    }
-    onSubtitleChanged({ id }) {
-        trace(`${T} onSubtitleChanged`, { id });
-        if (id === -1) {
-            this.clearSubtitleText();
-        }
-        for (const track of this.tracks) {
-            if (track.id === id) {
-                track.track.mode = 'showing';
-                this.setSubtitleText(this.getSubtitleText(track.track));
-                track.track.oncuechange = (e) => {
-                    try {
-                        if (track.track.activeCues?.length) {
-                            const html = track.track.activeCues[0].getCueAsHTML();
-                            this.setSubtitleText(html);
-                        }
-                        else {
-                            this.clearSubtitleText();
-                        }
-                    }
-                    catch (error) {
-                        reportError(error);
-                    }
-                };
-            }
-            else {
-                track.track.oncuechange = null;
-                track.track.mode = 'hidden';
-            }
-        }
-    }
-    applyTracks() {
-        try {
-            this.tracks = this.core.activePlayback.closedCaptionsTracks;
-            this.applyPreselectedSubtitles();
-            this.render();
-        }
-        catch (error) {
-            reportError(error);
-        }
-    }
-    onStartAd() {
-        if (this.isShowing && this.core.activeContainer) {
-            this.hide();
-            this.listenTo(this.core.activeContainer, 'container:advertisement:finish', this.onFinishAd);
-        }
-    }
-    onFinishAd() {
-        this.show();
-        this.stopListening(this.core.activeContainer, 'container:advertisement:finish', this.onFinishAd);
-    }
-    playerResize() {
-        trace(`${T} playerResize`);
-        const shouldShow = this.core.activeContainer &&
-            isFullscreen(this.core.activeContainer.el) &&
-            this.track &&
-            this.track.track.mode &&
-            Browser.isiOS &&
-            this.isShowing;
-        if (shouldShow) {
-            this.show();
-        }
-        try {
-            this.resizeFont();
-        }
-        catch (error) {
-            reportError(error);
-        }
-    }
-    /**
-     * Hides the subtitles menu and the subtitles.
-     */
-    hide() {
-        this.isShowing = false;
-        this.renderIcon();
-        this.$line.hide();
-        if (this.tracks) {
-            for (const t of this.tracks) {
-                t.track.mode = 'hidden';
-            }
-        }
-    }
-    /**
-     * Shows the subtitles menu and the subtitles.
-     */
-    show() {
-        this.isShowing = true;
-        this.renderIcon();
-        if (this.core.activeContainer &&
-            isFullscreen(this.core.activeContainer.el) &&
-            this.track &&
-            this.track.track.mode &&
-            Browser.isiOS) {
-            this.$line.hide();
-            this.track.track.mode = 'showing';
-        }
-        else {
-            this.$line.show();
-        }
-    }
-    shouldRender() {
-        return this.tracks?.length > 0;
-    }
-    resizeFont() {
-        if (!this.$line) {
-            return;
-        }
-        const skinWidth = this.core.activeContainer.$el.width();
-        this.$line.find('p').css('font-size', skinWidth * 0.03);
-    }
-    /**
-     * @internal
-     */
-    render() {
-        if (!this.core.activeContainer) {
-            return this;
-        }
-        if (!this.shouldRender()) {
-            return this;
-        }
-        const mediaControl = this.core.getPlugin('media_control');
-        this.$el.html(Subtitles.template({ tracks: this.tracks }));
-        this.core.activeContainer.$el.find('#cc-line').remove();
-        this.$line = $(Subtitles.templateString());
-        this.resizeFont();
-        this.core.activeContainer.$el.append(this.$line);
-        mediaControl.putElement('cc', this.el);
-        this.updateSelection();
-        this.renderIcon();
-        return this;
-    }
-    findById(id) {
-        return this.tracks.find((track) => track.id === id) ?? null;
-    }
-    selectItem(item) {
-        this.clearSubtitleText();
-        this.track = item;
-        this.hideMenu();
-        this.updateSelection();
-    }
-    onItemSelect(event) {
-        const id = event.target.dataset.ccSelect ?? '-1';
-        trace(`${T} onItemSelect`, { id });
-        localStorage.setItem(LOCAL_STORAGE_CC_ID, id);
-        this.selectItem(this.findById(Number(id)));
-        return false;
-    }
-    applyPreselectedSubtitles() {
-        if (!this.isPreselectedApplied) {
-            this.isPreselectedApplied = true;
-            if (!this.preselectedLanguage) {
-                return;
-            }
-            setTimeout(() => {
-                this.selectItem(this.tracks.find((t) => t.track.language === this.preselectedLanguage) ?? null);
-            }, 300); // TODO why delay?
-        }
-    }
-    hideMenu() {
-        ;
-        this.$('[data-cc] ul').hide();
-    }
-    toggleMenu() {
-        trace(`${T} toggleMenu`);
-        this.$('[data-cc] ul').toggle();
-    }
-    itemElement(id) {
-        return this.$(`ul li a[data-cc-select="${id}"]`).parent();
-    }
-    allItemElements() {
-        return this.$('[data-cc] li');
-    }
-    selectSubtitles() {
-        const trackId = this.track ? this.track.id : -1;
-        this.core.activePlayback.closedCaptionsTrackId = trackId;
-    }
-    getSubtitleText(track) {
-        const currentTime = this.core.activePlayback?.getCurrentTime() ?? 0;
-        const cues = track.cues;
-        const lines = [];
-        if (cues && cues.length) {
-            for (const cue of cues) {
-                if (currentTime >= cue.startTime && currentTime <= cue.endTime) {
-                    lines.push(cue.getCueAsHTML().textContent);
-                }
-            }
-        }
-        return lines.join('\n');
-    }
-    setSubtitleText(text) {
-        this.$line.find('p').html(text);
-    }
-    clearSubtitleText() {
-        this.setSubtitleText('');
-    }
-    updateSelection() {
-        if (!this.track) {
-            this.hide();
-        }
-        else {
-            this.show();
-        }
-        this.selectSubtitles();
-        this.highlightCurrentSubtitles();
-    }
-    highlightCurrentSubtitles() {
-        this.allItemElements()
-            .removeClass('current')
-            .find('a')
-            .removeClass('gcore-skin-active');
-        trace(`${T} highlightCurrentSubtitles`, {
-            track: this.track?.id,
-        });
-        const currentLevelElement = this.itemElement(this.track ? this.track.id : -1);
-        currentLevelElement
-            .addClass('current')
-            .find('a')
-            .addClass('gcore-skin-active');
-    }
-    renderIcon() {
-        const icon = this.isShowing ? subtitlesOnIcon : subtitlesOffIcon;
-        this.$el.find('span.cc-text').html(icon);
-    }
-}

package/lib/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.9"
-    }
-  ]
-}

package/lib/utils/fullscreen.d.ts

@@ -1,3 +0,0 @@
-import { Utils } from '@clappr/core';
-export declare const fullscreenEnabled: typeof Utils.Fullscreen.fullscreenEnabled;
-//# sourceMappingURL=fullscreen.d.ts.map

package/lib/utils/fullscreen.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fullscreen.d.ts","sourceRoot":"","sources":["../../src/utils/fullscreen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AAEpC,eAAO,MAAM,iBAAiB,2CAAqC,CAAA"}

package/lib/utils/fullscreen.js

@@ -1,2 +0,0 @@
-import { Utils } from '@clappr/core';
-export const fullscreenEnabled = Utils.Fullscreen.fullscreenEnabled;