ezuikit-flv 1.0.0-alpha.1 → 1.0.2-alpha.1

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "ezuikit-flv",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.2-alpha.1",
   "main": "./index.js",
   "types": "./types",
+  "author": "Ezviz-OpenBiz",
   "files": [
     "CHANGELOG.md",
     "decoder.js",
@@ -11,5 +12,9 @@
     "package.json",
     "README.md",
     "types"
-  ]
-}
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/types/flv-mse/flv.min.d.ts

@@ -1,3 +1,2 @@
 declare const _exports: any;
 export = _exports;
-export const mpegts: any;

package/types/index.d.ts

@@ -2,7 +2,12 @@ export default EzuikitFlv;
 /**
  * @classdesc EzuikitFlv.js 播放flv直播流， 支持播放h264/h265的直播视频流
  * @example
- * const flv = new EzuikitFlv({container: "EleId"})
+ * ```js
+ * const flv = new EzuikitFlv({
+ *  container: "EleId",
+ *  url: "https://open.ys7.com/v3/openlive/E71992743_1_1.flv"
+ * })
+ * ```
  */
 declare class EzuikitFlv extends Emitter {
     /**
@@ -18,13 +23,7 @@ declare class EzuikitFlv extends Emitter {
         websocketError: string;
         webcodecsH265NotSupport: string;
         webcodecsDecodeError: string;
-        webcodecsWidthOrHeightChange: string; /**
-         * @description 设置音量
-         * @param {number} value 音量 0～1
-         * @returns {void}
-         * @example
-         * flv.setVolume(0.5)
-         */
+        webcodecsWidthOrHeightChange: string;
         mediaSourceH265NotSupport: string;
         mediaSourceFull: string;
         mseSourceBufferError: string;
@@ -39,6 +38,24 @@ declare class EzuikitFlv extends Emitter {
         loadingTimeout: string;
         delayTimeout: string;
     };
+    static version: string;
+    /**
+     * @description 静态方法 判断是否支持播放地址
+     * @param {Object} options
+     * @param {string=} options.url
+     * @param {type=} options.type
+     * @returns {boolean}
+     * @static
+     *
+     * @example
+     * ```js
+     * EzuikitFlv.supportType({url: "https://open.ys7.com/v3/openlive/E71992743_1_1.flv",  type:'flv'})
+     * ```
+     */
+    static supportType(options: {
+        url?: string | undefined;
+        type?: type | undefined;
+    }): boolean;
     /**
      * @constructor
      * @param {FlvOptions} options
@@ -162,12 +179,12 @@ declare class EzuikitFlv extends Emitter {
     private clearView;
     /**
      * @description 播放
-     * @param {object=} options
+     * @param {FlvOptions=} options
      * @returns {Promise}
      * @example
      * flv.play()
      */
-    play(options?: object | undefined): Promise<any>;
+    play(options?: FlvOptions): Promise<any>;
     /**
      * @description 播放
      * @private
@@ -184,7 +201,7 @@ declare class EzuikitFlv extends Emitter {
      */
     private resize;
     /**
-     * @description 设置最大缓冲时长，单位秒，播放器会自动消除延迟。
+     * @description 设置最大缓冲时长，单位秒，播放器会自动消除延迟。软解
      * @private
      * @param {number} time  大缓冲时长 s
      * @example

package/types/player/base-player.d.ts

@@ -39,6 +39,11 @@ export default class BasePlayer extends Emitter {
     events: Events;
     video: any;
     control: Control;
+    /**
+     *
+     * @param options
+     */
+    updateOption(options: any): void;
 }
 import Emitter from '../utils/emitter';
 import Debug from '../utils/debug';

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

@@ -1,9 +1,7 @@
-import { PlayerInterface } from '../interface';
-import Debug from '../../utils/debug';
+import { type PlayerInterface, type RequiredFlvOptions } from '../interface';
 import Events from '../../utils/events';
 import Video from './videoLoader';
-import Control from '../../control';
-import { RequiredFlvOptions } from '../interface';
+import type Control from '../../control';
 import BasePlayer from '../base-player';
 /**
  * @class
@@ -22,7 +20,6 @@ export default class HardPlayer extends BasePlayer implements PlayerInterface {
     _times: any;
     $container: HTMLElement;
     _opt: RequiredFlvOptions;
-    debug: Debug;
     _hasLoaded: boolean;
     _checkHeartTimeout: number;
     _stats: any;
@@ -30,6 +27,8 @@ export default class HardPlayer extends BasePlayer implements PlayerInterface {
     control: Control;
     width: number;
     height: number;
+    _pause: boolean;
+    _decodedFrames: number;
     constructor(container: HTMLElement, options: RequiredFlvOptions);
     close(): Promise<unknown>;
     _createPlayer(options: RequiredFlvOptions): void;

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

@@ -13,6 +13,7 @@ export default class CanvasVideoLoader extends CommonLoader {
         height: string;
         encType: string;
     };
+    _contextmenuEvent: (e: any) => void;
     _initContextGl(): void;
     _initContext2D(): void;
     _initCanvasRender(): void;

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

@@ -7,29 +7,24 @@ export default class SoftPlayer extends BasePlayer {
     _lastVolume: any;
     keepScreenOn: NoSleep;
     destroy(): void;
-    set fullscreen(arg: any);
+    set fullscreen(value: any);
     get fullscreen(): any;
-    set webFullscreen(arg: any);
+    set webFullscreen(value: any);
     get webFullscreen(): any;
-    set loaded(arg: boolean);
+    set loaded(value: boolean);
     get loaded(): boolean;
-    set playing(arg: boolean);
+    set playing(value: boolean);
     get playing(): boolean;
-    set loading(arg: boolean);
+    set loading(value: boolean);
     get loading(): boolean;
-    set volume(arg: any);
+    set volume(value: any);
     get volume(): any;
     get lastVolume(): any;
-    set audioTimestamp(arg: number);
+    set audioTimestamp(value: number);
     get audioTimestamp(): number;
-    set videoTimestamp(arg: number);
+    set videoTimestamp(value: number);
     get videoTimestamp(): number;
     get isDebug(): boolean;
-    /**
-     *
-     * @param options
-     */
-    updateOption(options: any): void;
     /**
      *
      * @returns {Promise<unknown>}
@@ -45,7 +40,7 @@ export default class SoftPlayer extends BasePlayer {
      *
      */
     close(): Promise<any>;
-    resumeAudioAfterPause(): void;
+    _resumeAudioAfterPause(): void;
     _close(): Promise<any>;
     /**
      *
@@ -55,9 +50,9 @@ export default class SoftPlayer extends BasePlayer {
     pause(flag?: boolean): Promise<unknown>;
     /**
      * @description 静音
-     * @param flag
+     * @param {boolean} flag
      */
-    mute(flag: any): void;
+    mute(flag: boolean): void;
     /**
      * @description 重置尺寸
      */

package/types/typedefs.d.ts

@@ -6,7 +6,6 @@
  * @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
@@ -19,13 +18,11 @@
  * @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 播放器的状态
+ * @description 播放器的状态 (getState() api)
  * @typedef PlayerState
  *
  * @property {boolean} playing 是否正在播放
@@ -50,10 +47,6 @@ export type FlvOptions = {
      * 解码库worker地址 默认 `decoder.js`, wasm 文件要和decoder在同一个文件夹中
      */
     decoder?: string | undefined;
-    /**
-     * 是否不使用离屏模式（提升渲染能力）
-     */
-    forceNoOffscreen?: boolean | undefined;
     /**
      * 是否有音频，如果设置false，则不对音频数据解码，提升性能。
      */
@@ -102,14 +95,6 @@ export type FlvOptions = {
      * 在使用MSE或者Webcodecs 播放H265的时候，是否自动降级到wasm模式。默认 true
      */
     autoWasm?: boolean | undefined;
-    /**
-     * 是否开启解码失败重新播放。默认 true
-     */
-    wasmDecodeErrorReplay?: boolean | undefined;
-    /**
-     * 是否使用web全屏(旋转90度)（只会在移动端生效）。默认 false
-     */
-    useWebFullScreen?: boolean | undefined;
 };
 export type PlayerState = {
     /**

package/types/utils/debug.d.ts

@@ -1,6 +1,7 @@
 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;
+    master: any;
+    log(name: any, ...args: any[]): void;
+    warn(name: any, ...args: any[]): void;
+    error(name: any, ...args: any[]): void;
 }

package/types/utils/monitor.d.ts

@@ -1,22 +1,13 @@
 export default Monitor;
+/**
+ * /pages/viewpage.action?pageId=663566571
+ */
 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
-     */
+    static initMonitor(ignoreMonitor: any): void;
     /**
      *
-     * @param {'click' | 'error' | 'api' } type
-     * @param {ReportData} obj
+     * @param {1 | 2 | 3 | 50 | 51 |  100} type 1： 初始化  2： 播放成功  3： 播放异常  50: api 调用  51：错误回调  100： 接口上报
+     * @param {ReportData} logInfo
      */
-    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;
+    static report(action: any, logInfo?: ReportData): void;
 }

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

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