ezuikit-flv 1.0.0-alpha.0

package/types/player/events.d.ts

@@ -0,0 +1,2 @@
+declare function _default(player: any): void;
+export default _default;

package/types/player/hard-player/index.d.ts

@@ -0,0 +1,95 @@
+import { PlayerInterface } from '../interface';
+import Debug from '../../utils/debug';
+import Events from '../../utils/events';
+import Video from './videoLoader';
+import Control from '../../control';
+import { RequiredFlvOptions } from '../interface';
+import BasePlayer from '../base-player';
+/**
+ * @class
+ *
+ * @interface {PlayerInterface}
+ */
+export default class HardPlayer extends BasePlayer implements PlayerInterface {
+    player: any;
+    video: Video;
+    events: Events;
+    _playing: any;
+    _lastVolume: any;
+    _loading: any;
+    _audioTimestamp: any;
+    _videoTimestamp: any;
+    _times: any;
+    $container: HTMLElement;
+    _opt: RequiredFlvOptions;
+    debug: Debug;
+    _hasLoaded: boolean;
+    _checkHeartTimeout: number;
+    _stats: any;
+    _checkLoadingTimeout: number;
+    control: Control;
+    width: number;
+    height: number;
+    constructor(container: HTMLElement, options: RequiredFlvOptions);
+    close(): Promise<unknown>;
+    _createPlayer(options: RequiredFlvOptions): void;
+    _flvEvents(): void;
+    getOption(): RequiredFlvOptions;
+    emitError(errorType: string, message?: string): void;
+    /**
+     * @description 销毁实例
+     */
+    destroy(): void;
+    resetStats(): void;
+    set fullscreen(value: any);
+    get fullscreen(): any;
+    set webFullscreen(value: boolean);
+    get webFullscreen(): boolean;
+    set loaded(value: boolean);
+    get loaded(): boolean;
+    set playing(value: any);
+    get playing(): any;
+    get volume(): number;
+    set volume(value: number);
+    get lastVolume(): any;
+    set loading(value: any);
+    get loading(): any;
+    set audioTimestamp(value: any);
+    get audioTimestamp(): any;
+    set videoTimestamp(value: any);
+    get videoTimestamp(): any;
+    get isDebug(): boolean;
+    /**
+     * 心跳检查
+     */
+    checkHeart(): void;
+    clearCheckHeartTimeout(): void;
+    /**
+     * @description 心跳检查，如果渲染间隔暂停了多少时间之后，就会抛出异常
+     */
+    checkHeartTimeout(): void;
+    /**
+     * @description 检查等待时间 （loading 等待时间）
+     */
+    checkLoadingTimeout(): void;
+    handleRender(): void;
+    clearCheckLoadingTimeout(): void;
+    /**
+     *
+     * @param options
+     */
+    updateOption(options: Partial<RequiredFlvOptions>): void;
+    /**
+     * @description 播放
+     * @param url
+     * @param options
+     * @returns {Promise}
+     */
+    play(): Promise<unknown>;
+    _play(): Promise<void>;
+    _close(): Promise<unknown>;
+    pause(): Promise<unknown>;
+    resumeAudioAfterPause(): void;
+    mute(flag: boolean): void;
+    resize(): void;
+}

package/types/player/hard-player/videoLoader.d.ts

@@ -0,0 +1,28 @@
+import CommonLoader from '../commonLoader';
+import { ScreenshotFormat } from '../interface';
+import HardPlayer from '.';
+export default class VideoLoader extends CommonLoader {
+    _delayPlay: boolean;
+    $canvasElement: HTMLCanvasElement;
+    canvasContext: CanvasRenderingContext2D | null;
+    trackGenerator: any;
+    vwriter: any;
+    $videoElement: HTMLVideoElement;
+    player: HardPlayer;
+    $posterElement: HTMLImageElement;
+    constructor(player: HardPlayer);
+    destroy(): void;
+    fixChromeVideoFlashBug(): void;
+    play(): void;
+    _getVideoReadyState(): number;
+    _play(): void;
+    pause(isNow?: boolean): void;
+    clearView(): void;
+    screenshot(filename: string, format?: keyof ScreenshotFormat, quality?: number, type?: string): string | File;
+    initCanvasViewSize(): void;
+    _poster(): void;
+    render(msg: any): void;
+    resize(): void;
+    _resizeElement($Element: HTMLVideoElement | HTMLImageElement): void;
+    isPlaying(): boolean;
+}

package/types/player/index.d.ts

@@ -0,0 +1,7 @@
+export default class PlayerLoader {
+    static getLoaderFactory(useMSE: any): typeof SoftPlayer | typeof HardPalyer;
+    constructor(container: any, options: any);
+    _opt: any;
+}
+import SoftPlayer from './soft-player';
+import HardPalyer from './hard-player';

package/types/player/interface.d.ts

@@ -0,0 +1,98 @@
+import Debug from '../utils/debug';
+export type TFlvOptions = {
+    container: string | HTMLElement;
+    videoBuffer: number;
+    decoder?: string;
+    forceNoOffscreen?: boolean;
+    hasAudio?: boolean;
+    scaleMode: 0 | 1 | 2;
+    debug: boolean;
+    timeout: number;
+    heartTimeout: number;
+    heartTimeoutReplayTimes: number;
+    loadingTimeout: number;
+    loadingTimeoutReplay: boolean;
+    keepScreenOn: boolean;
+    isNotMute: boolean;
+    useMSE: boolean;
+    autoWasm: boolean;
+    wasmDecodeErrorReplay: boolean;
+    useWebFullScreen: boolean;
+};
+export type RequiredFlvOptions = Required<TFlvOptions> & {
+    url: string;
+    rotate?: 0 | 90 | 180 | 270;
+    hasControl: any;
+    openWebglAlignment?: boolean;
+};
+export type TPlayerTimes = {
+    playInitStart: number;
+    playStart: number;
+    streamStart: number;
+    streamResponse: number;
+    demuxStart: number;
+    decodeStart: number;
+    videoStart: number;
+    playTimestamp: number;
+    streamTimestamp: number;
+    streamResponseTimestamp: number;
+    demuxTimestamp: number;
+    decodeTimestamp: number;
+    videoTimestamp: number;
+    allTimestamp: number;
+};
+export type TPlayerStats = {
+    buf: number;
+    fps: number;
+    abps: number;
+    vbps: number;
+    ts: number;
+};
+export interface VideoInterface {
+    player: any;
+    destroy(): void;
+    initCanvasViewSize(): void;
+    render(msg: any): void;
+    screenshot(filename?: string, format?: string, quality?: number, type?: string): void;
+    clearView(): void;
+    resize(): void;
+}
+export interface PlayerInterface {
+    $container: any;
+    debug: Debug;
+    _opt: RequiredFlvOptions;
+    /**
+     * @description 播放
+     * @param url
+     * @param options
+     */
+    play(options?: TFlvOptions): Promise<unknown>;
+    /**
+     * @description 暂停
+     */
+    pause(flag?: boolean): Promise<unknown>;
+    /**
+     * @description 静音
+     * @param flag
+     */
+    mute(flag?: boolean): void;
+    /**
+     * @description resize
+     */
+    resize(): void;
+    /**
+     * @description 关闭
+     */
+    close(): Promise<unknown>;
+    /**
+     * @description 销毁实例
+     */
+    destroy(): void;
+}
+export type VideoInfo = {
+    width: string;
+    height: string;
+    encType: string;
+    encTypeCode?: 7 | 12 | '';
+};
+export type ScreenshotFormat = Record<'png' | 'jpeg' | 'webp', string>;

package/types/player/observer.d.ts

@@ -0,0 +1,2 @@
+declare function _default(player: any): void;
+export default _default;

package/types/player/property.d.ts

@@ -0,0 +1,2 @@
+declare function _default(player: any): void;
+export default _default;

package/types/player/soft-player/canvasLoader.d.ts

@@ -0,0 +1,26 @@
+export default class CanvasVideoLoader extends CommonLoader {
+    constructor(player: any);
+    player: any;
+    $videoElement: HTMLCanvasElement;
+    context2D: CanvasRenderingContext2D;
+    contextGl: any;
+    contextGlRender: (w: any, h: any, y: any, u: any, v: any) => void;
+    contextGlDestroy: () => void;
+    bitmaprenderer: ImageBitmapRenderingContext;
+    renderType: string;
+    videoInfo: {
+        width: string;
+        height: string;
+        encType: string;
+    };
+    _initContextGl(): void;
+    _initContext2D(): void;
+    _initCanvasRender(): void;
+    _supportOffscreen(): any;
+    _bindOffscreen(): void;
+    initCanvasViewSize(): void;
+    render(msg: any): void;
+    screenshot(filename: any, format: any, quality: any, type: any): string | File;
+    resize(): void;
+}
+import CommonLoader from '../commonLoader';

package/types/player/soft-player/index.d.ts

@@ -0,0 +1,96 @@
+export default class SoftPlayer extends BasePlayer {
+    constructor(container: any, options: any);
+    audio: Audio;
+    decoderWorker: DecoderWorker;
+    stream: Stream;
+    demux: Demux;
+    _lastVolume: any;
+    keepScreenOn: NoSleep;
+    destroy(): void;
+    set fullscreen(arg: any);
+    get fullscreen(): any;
+    set webFullscreen(arg: any);
+    get webFullscreen(): any;
+    set loaded(arg: boolean);
+    get loaded(): boolean;
+    set playing(arg: boolean);
+    get playing(): boolean;
+    set loading(arg: boolean);
+    get loading(): boolean;
+    set volume(arg: any);
+    get volume(): any;
+    get lastVolume(): any;
+    set audioTimestamp(arg: number);
+    get audioTimestamp(): number;
+    set videoTimestamp(arg: number);
+    get videoTimestamp(): number;
+    get isDebug(): boolean;
+    /**
+     *
+     * @param options
+     */
+    updateOption(options: any): void;
+    /**
+     *
+     * @returns {Promise<unknown>}
+     */
+    init(): Promise<unknown>;
+    /**
+     *
+     * @param url
+     * @returns {Promise<unknown>}
+     */
+    play(options: any): Promise<unknown>;
+    /**
+     *
+     */
+    close(): Promise<any>;
+    resumeAudioAfterPause(): void;
+    _close(): Promise<any>;
+    /**
+     *
+     * @param flag {boolean} 是否清除画面
+     * @returns {Promise<unknown>}
+     */
+    pause(flag?: boolean): Promise<unknown>;
+    /**
+     * @description 静音
+     * @param flag
+     */
+    mute(flag: any): void;
+    /**
+     * @description 重置尺寸
+     */
+    resize(): void;
+    _onlyMseOrWcsVideo(): any;
+    /**
+     * 心跳检查
+     */
+    checkHeart(): void;
+    /**
+     * @description 心跳检查，如果渲染间隔暂停了多少时间之后，就会抛出异常
+     */
+    checkHeartTimeout(): void;
+    checkStatsInterval(): void;
+    clearCheckHeartTimeout(): void;
+    /**
+     * @description 检查等待时间 （loading 等待时间）
+     */
+    checkLoadingTimeout(): void;
+    clearCheckLoadingTimeout(): void;
+    clearStatsInterval(): void;
+    handleRender(): void;
+    updateStats(options: any): void;
+    resetStats(): void;
+    enableWakeLock(): void;
+    releaseWakeLock(): void;
+    handlePlayToRenderTimes(): void;
+    getOption(): any;
+    emitError(errorType: any, message?: string): void;
+}
+import BasePlayer from '../base-player';
+import Audio from '../../audio';
+import DecoderWorker from '../../worker/index';
+import Stream from '../../stream';
+import Demux from '../../demux';
+import NoSleep from '../../utils/noSleep';

package/types/stream/fetchLoader.d.ts

@@ -0,0 +1,16 @@
+export default class FetchLoader extends Emitter {
+    constructor(player: any);
+    player: any;
+    playing: boolean;
+    abortController: AbortController;
+    streamRate: (size: any) => void;
+    destroy(): void;
+    /**
+     *
+     * @param url
+     * @param options
+     */
+    fetchStream(url: any, options?: {}): void;
+    abort(): void;
+}
+import Emitter from '../utils/emitter';

package/types/stream/index.d.ts

@@ -0,0 +1,6 @@
+export default class Stream {
+    static getLoaderFactory(protocol: any): typeof FetchLoader | typeof WebsocketLoader;
+    constructor(player: any);
+}
+import FetchLoader from './fetchLoader';
+import WebsocketLoader from './websocketLoader';

package/types/stream/websocketLoader.d.ts

@@ -0,0 +1,18 @@
+export default class WebsocketLoader extends Emitter {
+    constructor(player: any);
+    player: any;
+    socket: WebSocket;
+    socketStatus: string;
+    wsUrl: any;
+    streamRate: (size: any) => void;
+    destroy(): void;
+    _createWebSocket(): void;
+    _handleMessage(message: any): void;
+    /**
+     *
+     * @param url
+     * @param options
+     */
+    fetchStream(url: any, options: any): void;
+}
+import Emitter from '../utils/emitter';

package/types/typedefs.d.ts

@@ -0,0 +1,143 @@
+/**
+ *
+ * @description Flv 配置项
+ * @typedef FlvOptions
+ *
+ * @property {string | HTMLElement} container 渲染容器
+ * @property {number=} videoBuffer 设置最大缓冲时长，单位秒，播放器会自动消除延迟。
+ * @property {string=} decoder 解码库worker地址 默认 `decoder.js`, wasm 文件要和decoder在同一个文件夹中
+ * @property {boolean=} forceNoOffscreen 是否不使用离屏模式（提升渲染能力）
+ * @property {boolean=} hasAudio 是否有音频，如果设置false，则不对音频数据解码，提升性能。
+ * @property {(0 | 1 | 2)=} scaleMode 设置渲染模式， 默认 1, 取值 0 | 1 | 2。
+ * @property {boolean=} debug 是否开启控制台调试打印。默认 false
+ * @property {number=} timeout 设置超时时长, 单位秒, 在连接成功之前(loading)和播放中途(heart),如果超过设定时长无数据返回,则回调timeout事件。默认 10
+ * @property {number=} heartTimeout 设置超时时长, 单位秒， 播放中途,如果超过设定时长无数据返回,则回调timeout事件。默认 5
+ * @property {number=} heartTimeoutReplayTimes `heartTimeoutReplay` 重试次数。默认 3
+ * @property {number=} loadingTimeout 设置超时时长, 单位秒。默认 10
+ * @property {boolean=} loadingTimeoutReplay 是否开启loading超时之后自动再播放, 默认 true
+ * @property {boolean=} keepScreenOn 开启屏幕常亮，在手机浏览器上, canvas标签渲染视频并不会像video标签那样保持屏幕常。默认 false
+ * @property {boolean=} isNotMute 是否开启声音，默认是关闭声音播放的。默认 false
+ * @property {boolean=} useMSE 是否开启MediaSource硬解码。视频编码只支持H.264视频（Safari on iOS不支持）。默认 false
+ * @property {boolean=} autoWasm 在使用MSE或者Webcodecs 播放H265的时候，是否自动降级到wasm模式。默认 true
+ * @property {boolean=} wasmDecodeErrorReplay 是否开启解码失败重新播放。默认 true
+ * @property {boolean=} useWebFullScreen 是否使用web全屏(旋转90度)（只会在移动端生效）。默认 false
+ *
+ */
+/**
+ *
+ * @description 播放器的状态
+ * @typedef PlayerState
+ *
+ * @property {boolean} playing 是否正在播放
+ * @property {boolean} mute 是否静音
+ * @property {boolean} fullscreen 是否全屏
+ * @property {boolean} webFullscreen 是否web全屏
+ * @property {boolean} loaded 是否加载完成
+ * @property {string} volume 音量
+ * @property {boolean} isDebug 是否打印日志
+ */
+export const Types: {};
+export type FlvOptions = {
+    /**
+     * 渲染容器
+     */
+    container: string | HTMLElement;
+    /**
+     * 设置最大缓冲时长，单位秒，播放器会自动消除延迟。
+     */
+    videoBuffer?: number | undefined;
+    /**
+     * 解码库worker地址 默认 `decoder.js`, wasm 文件要和decoder在同一个文件夹中
+     */
+    decoder?: string | undefined;
+    /**
+     * 是否不使用离屏模式（提升渲染能力）
+     */
+    forceNoOffscreen?: boolean | undefined;
+    /**
+     * 是否有音频，如果设置false，则不对音频数据解码，提升性能。
+     */
+    hasAudio?: boolean | undefined;
+    /**
+     * 设置渲染模式， 默认 1, 取值 0 | 1 | 2。
+     */
+    scaleMode?: (0 | 1 | 2) | undefined;
+    /**
+     * 是否开启控制台调试打印。默认 false
+     */
+    debug?: boolean | undefined;
+    /**
+     * 设置超时时长, 单位秒, 在连接成功之前(loading)和播放中途(heart),如果超过设定时长无数据返回,则回调timeout事件。默认 10
+     */
+    timeout?: number | undefined;
+    /**
+     * 设置超时时长, 单位秒， 播放中途,如果超过设定时长无数据返回,则回调timeout事件。默认 5
+     */
+    heartTimeout?: number | undefined;
+    /**
+     * `heartTimeoutReplay` 重试次数。默认 3
+     */
+    heartTimeoutReplayTimes?: number | undefined;
+    /**
+     * 设置超时时长, 单位秒。默认 10
+     */
+    loadingTimeout?: number | undefined;
+    /**
+     * 是否开启loading超时之后自动再播放, 默认 true
+     */
+    loadingTimeoutReplay?: boolean | undefined;
+    /**
+     * 开启屏幕常亮，在手机浏览器上, canvas标签渲染视频并不会像video标签那样保持屏幕常。默认 false
+     */
+    keepScreenOn?: boolean | undefined;
+    /**
+     * 是否开启声音，默认是关闭声音播放的。默认 false
+     */
+    isNotMute?: boolean | undefined;
+    /**
+     * 是否开启MediaSource硬解码。视频编码只支持H.264视频（Safari on iOS不支持）。默认 false
+     */
+    useMSE?: boolean | undefined;
+    /**
+     * 在使用MSE或者Webcodecs 播放H265的时候，是否自动降级到wasm模式。默认 true
+     */
+    autoWasm?: boolean | undefined;
+    /**
+     * 是否开启解码失败重新播放。默认 true
+     */
+    wasmDecodeErrorReplay?: boolean | undefined;
+    /**
+     * 是否使用web全屏(旋转90度)（只会在移动端生效）。默认 false
+     */
+    useWebFullScreen?: boolean | undefined;
+};
+export type PlayerState = {
+    /**
+     * 是否正在播放
+     */
+    playing: boolean;
+    /**
+     * 是否静音
+     */
+    mute: boolean;
+    /**
+     * 是否全屏
+     */
+    fullscreen: boolean;
+    /**
+     * 是否web全屏
+     */
+    webFullscreen: boolean;
+    /**
+     * 是否加载完成
+     */
+    loaded: boolean;
+    /**
+     * 音量
+     */
+    volume: string;
+    /**
+     * 是否打印日志
+     */
+    isDebug: boolean;
+};

package/types/utils/codec-support.d.ts

@@ -0,0 +1,2 @@
+export function getQueryVC(): any;
+export function setVC(url: any): string;

package/types/utils/debug.d.ts

@@ -0,0 +1,6 @@
+export default class Debug {
+    constructor(master: any);
+    log: (name: any, ...args: any[]) => void;
+    warn: (name: any, ...args: any[]) => void;
+    error: (name: any, ...args: any[]) => void;
+}

package/types/utils/emitter.d.ts

@@ -0,0 +1,7 @@
+export default class Emitter {
+    on(name: any, fn: any, ctx: any): this;
+    e: {};
+    once(name: any, fn: any, ctx: any): this;
+    emit(name: any, ...data: any[]): this;
+    off(name: any, callback: any): this;
+}

package/types/utils/events.d.ts

@@ -0,0 +1,7 @@
+export default class Events {
+    constructor(master: any);
+    destroys: any[];
+    proxy(target: any, name: any, callback: any, option?: {}): any;
+    master: any;
+    destroy(): void;
+}

package/types/utils/file-save.d.ts

@@ -0,0 +1,2 @@
+export default saveAs;
+declare function saveAs(blob: any, name: any, opts: any, popup: any): void;

package/types/utils/index.d.ts

@@ -0,0 +1,70 @@
+export function noop(): void;
+export function supportOffscreen($canvas: any): boolean;
+export function supportOffscreenV2(): boolean;
+export function createContextGL($canvas: any): any;
+export function audioContextUnlock(context: any): void;
+export function dataURLToFile(dataURL?: string): File;
+export function downloadFile(file: any, fileName: any): void;
+export function downloadImg(content: any, fileName: any): void;
+export function checkFull(): boolean;
+export function now(): number;
+export function clamp(num: any, a: any, b: any): number;
+export function setStyle(element: any, key: any, value: any): any;
+export function getStyle(element: any, key: any, numberType?: boolean): string | number;
+export function getNowTime(): number;
+export function calculationRate(callback: any): (size: any) => void;
+export function downloadRecord(blob: any, name: any, suffix: any): void;
+export function isMobile(): boolean;
+export function isAndroid(): boolean;
+export function isIOS(): boolean;
+export function parseTime(time: any, cFormat: any, ...args: any[]): any;
+export function supportWCS(): boolean;
+export function toNumber(value: any): any;
+export function uuid16(): string;
+export function throttle(callback: any, delay: any): (...args2: any[]) => void;
+export function isDef(v: any): boolean;
+export function formatVideoDecoderConfigure(avcC: any): {
+    codec: string;
+    description: any;
+};
+export function isFullScreen(): any;
+export function bpsSize(value: any): string;
+export function fpsStatus(fps: any): number;
+export function createEmptyImageBitmap(width: any, height: any): Promise<ImageBitmap>;
+export function supportMSE(): boolean;
+export function supportMSEHevc(): boolean;
+export function supportMediaStreamTrack(): boolean;
+export function formatMp4VideoCodec(codec: any): string;
+export function saveBlobToFile(fileName: any, blob: any): void;
+export function isEmpty(value: any): boolean;
+export function isBoolean(value: any): boolean;
+export function isNotEmpty(value: any): boolean;
+export function initPlayTimes(): {
+    playInitStart: string;
+    playStart: string;
+    streamStart: string;
+    streamResponse: string;
+    demuxStart: string;
+    decodeStart: string;
+    videoStart: string;
+    playTimestamp: string;
+    streamTimestamp: string;
+    streamResponseTimestamp: string;
+    demuxTimestamp: string;
+    decodeTimestamp: string;
+    videoTimestamp: string;
+    allTimestamp: string;
+};
+export function createWatermark(options: any): () => void;
+export function formatTimeTips(time: any): string;
+export function getTarget(e: any): any;
+export function isWebglRenderSupport(width: any): boolean;
+export function isGreenYUV(arrayBuffer: any): boolean;
+export function getBrowser(): {
+    type: string;
+    version: number;
+};
+export function closeVideoFrame(videoFrame: any): void;
+export function removeElement(element: any): boolean;
+export const supportedWasm: boolean;
+export const env: "__ENV__";

package/types/utils/monitor.d.ts

@@ -0,0 +1,22 @@
+export default Monitor;
+declare class Monitor {
+    static vc: any;
+    static initMonitor(): void;
+    /**
+     * @typedef ReportData
+     * @property {string} event 事件名称 error |  play | pause | openSound | closeSound | fullScreen | cancelFullScreen | setDebug | setKeepScreenOn | setVolume | setRotate | getState | getVersion
+     * @property {*} value
+     */
+    /**
+     *
+     * @param {'click' | 'error' | 'api' } type
+     * @param {ReportData} obj
+     */
+    static report(type: 'click' | 'error' | 'api', obj: {
+        /**
+         * 事件名称 error |  play | pause | openSound | closeSound | fullScreen | cancelFullScreen | setDebug | setKeepScreenOn | setVolume | setRotate | getState | getVersion
+         */
+        event: string;
+        value: any;
+    }): void;
+}