ezuikit-flv 1.0.1 → 1.0.2-alpha.2

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "ezuikit-flv",
-  "version": "1.0.1",
+  "version": "1.0.2-alpha.2",
   "main": "./index.js",
   "types": "./types",
+  "author": "Ezviz-OpenBiz",
   "files": [
     "CHANGELOG.md",
     "decoder.js",
@@ -11,10 +12,5 @@
     "package.json",
     "README.md",
     "types"
-  ],
-  "bugs": {
-    "url": "https://github.com/Ezviz-OpenBiz/EZUIKit-flv/issues"
-  },
-  "repository": "git@github.com:Ezviz-OpenBiz/EZUIKit-flv.git",
-  "homepage": "https://ezviz-openbiz.github.io/EZUIKit-flv/"
+  ]
 }

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

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

package/types/index.d.ts

@@ -2,7 +2,12 @@ export default EzuikitFlv;
 /**
  * @classdesc EzuikitFlv.js 播放flv直播流， 支持播放h264/h265的直播视频流
  * @example
- * const player = new EzuikitFlv({container: "EleId", url: "flv stream url"})
+ * ```js
+ * const flv = new EzuikitFlv({
+ *  container: "EleId",
+ *  url: "https://open.ys7.com/v3/openlive/E71992743_1_1.flv"
+ * })
+ * ```
  */
 declare class EzuikitFlv extends Emitter {
     /**
@@ -15,11 +20,12 @@ declare class EzuikitFlv extends Emitter {
     static ERROR: {
         playError: string;
         fetchError: string;
-        websocketError: string; /**
-         * @description 开启声音 默认音量 0.5
+        websocketError: string;
+        /**
+         * @description 关闭声音
          * @returns {void}
          * @example
-         * player.openSound() //
+         * flv.closeSound()
          */
         webcodecsH265NotSupport: string;
         webcodecsDecodeError: string;
@@ -38,6 +44,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
@@ -51,7 +75,7 @@ declare class EzuikitFlv extends Emitter {
     /**
      * @description 销毁
      * @example
-     * player.destroy()
+     * flv.destroy()
      */
     destroy(): void;
     player: Player;
@@ -79,21 +103,21 @@ declare class EzuikitFlv extends Emitter {
      * @param {boolean} value true: 开启， false: 关闭
      * @returns {void}
      * @example
-     * player.setDebug(false)
+     * flv.setDebug(false)
      */
     setDebug(value: boolean): void;
     /**
      * @description 关闭声音
      * @returns {void}
      * @example
-     * player.closeSound()
+     * flv.closeSound()
      */
     closeSound(): void;
     /**
      * @description 开启声音 默认音量 0.5
      * @returns {void}
      * @example
-     * player.openSound() //
+     * flv.openSound() //
      */
     openSound(): void;
     /**
@@ -101,23 +125,30 @@ declare class EzuikitFlv extends Emitter {
      * @param {number} value 音量 0～1
      * @returns {void}
      * @example
-     * player.setVolume(0.5)
+     * flv.setVolume(0.5)
      */
     setVolume(value: number): void;
     /**
      * @description 获取音量， 音量 0～1
      * @returns {number}
      * @example
-     * player.getVolume()
+     * flv.getVolume()
      */
     getVolume(): number;
+    /**
+     * @description 音频回复
+     * @returns {void}
+     * @example
+     * flv.audioResume()
+     */
+    audioResume(): void;
     /**
      * @description 设置超时时长, 单位秒 在连接成功之前和播放中途,如果超过设定时长无数据返回,则回调timeout事件
      * @private
      * @param {number} time 设置超时时长, 单位秒
      * @returns {void}
      * @example
-     * player.setTimeout(3)
+     * flv.setTimeout(3)
      */
     private setTimeout;
     /**
@@ -126,14 +157,14 @@ declare class EzuikitFlv extends Emitter {
      * @param {0 | 1 | 2} type 0: 完全填充canvas区域; 1: 等比缩放, 最大边填充 ; 2: 等比缩放后,最小边填充，完全填充canvas区域,画面不被拉伸,没有黑边,但画面显示不全
      * @returns {Promise}
      * @example
-     * player.setScaleMode(1)
+     * flv.setScaleMode(1)
      */
     private setScaleMode;
     /**
      * @description 暂停
      * @returns {Promise<unknown>}
      * @example
-     * player.pause()
+     * flv.pause()
      */
     pause(): Promise<unknown>;
     /**
@@ -141,7 +172,7 @@ declare class EzuikitFlv extends Emitter {
      * @private
      * @returns {void}
      * @example
-     * player.close()
+     * flv.close()
      */
     private close;
     /**
@@ -149,7 +180,7 @@ declare class EzuikitFlv extends Emitter {
      * @private
      * @returns {void}
      * @example
-     * player.clearView()
+     * flv.clearView()
      */
     private clearView;
     /**
@@ -157,7 +188,7 @@ declare class EzuikitFlv extends Emitter {
      * @param {FlvOptions=} options
      * @returns {Promise}
      * @example
-     * player.play()
+     * flv.play()
      */
     play(options?: FlvOptions): Promise<any>;
     /**
@@ -172,7 +203,7 @@ declare class EzuikitFlv extends Emitter {
      * @description 重新调整视图大小
      * @private
      * @example
-     * player.resize()
+     * flv.resize()
      */
     private resize;
     /**
@@ -180,17 +211,17 @@ declare class EzuikitFlv extends Emitter {
      * @private
      * @param {number} time  大缓冲时长 s
      * @example
-     * player.setBufferTime(3)
+     * flv.setBufferTime(3)
      */
     private setBufferTime;
     /**
      * @description 设置旋转角度，支持，0(默认), 90, 180, 270 四个值。
-     * @param {0 | 90 | 180 | 270} deg 旋转角度
      * @returns {Promise}
+     * @param {number} deg
      * @example
-     * player.setRotate(90) // 旋转90度
+     * flv.setRotate(90) // 旋转90度
      */
-    setRotate(deg: 0 | 90 | 180 | 270): Promise<any>;
+    setRotate(deg: number): Promise<any>;
     /**
      * @description 返回是否加载完毕
      * @private
@@ -201,7 +232,7 @@ declare class EzuikitFlv extends Emitter {
      * @description 开启屏幕常亮，在手机浏览器上
      * @returns {void}
      * @example
-     * player.setKeepScreenOn()
+     * flv.setKeepScreenOn()
      */
     setKeepScreenOn(): void;
     /**
@@ -213,27 +244,25 @@ declare class EzuikitFlv extends Emitter {
     /**
      * @description 全屏播放视频
      * @example
-     * player.fullScreen() // 全屏
+     * flv.fullScreen() // 全屏
      */
     fullScreen(): void;
     /**
      * @description 取消全屏播放视频
      * @example
-     * player.cancelFullScreen() // 全屏
+     * flv.cancelFullScreen() // 全屏
      */
     cancelFullScreen(): void;
     /**
      * @description 获取播放器的状态
      * @returns {PlayerState} 播放器的状态
      * @example
-     * player.getState()
+     * flv.getState()
      */
     getState(): PlayerState;
     /**
      * @description 获取版本
      * @returns {string}
-     * @example
-     * player.getVersion()
      */
     getVersion(): string;
 }

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

@@ -1,8 +1,7 @@
-import { PlayerInterface } from '../interface';
+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

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

@@ -7,22 +7,22 @@ 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;
     /**

package/types/typedefs.d.ts

@@ -4,6 +4,7 @@
  * @typedef FlvOptions
  *
  * @property {string | HTMLElement} container 渲染容器
+ * @property {string } id 渲染容器id 优先级比 container 高
  * @property {number=} videoBuffer 设置最大缓冲时长，单位秒，播放器会自动消除延迟。
  * @property {string=} decoder 解码库worker地址 默认 `decoder.js`, wasm 文件要和decoder在同一个文件夹中
  * @property {boolean=} hasAudio 是否有音频，如果设置false，则不对音频数据解码，提升性能。
@@ -39,6 +40,10 @@ export type FlvOptions = {
      * 渲染容器
      */
     container: string | HTMLElement;
+    /**
+     * 渲染容器id 优先级比 container 高
+     */
+    id: string;
     /**
      * 设置最大缓冲时长，单位秒，播放器会自动消除延迟。
      */

package/types/utils/monitor.d.ts

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