ezuikit-flv 1.0.2 → 1.0.3-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ezuikit-flv",
-  "version": "1.0.2",
+  "version": "1.0.3-alpha.2",
   "main": "./index.js",
   "types": "./types",
   "author": "Ezviz-OpenBiz",
@@ -17,7 +17,7 @@
     "@ezuikit/player-base": "0.1.0-alpha.1",
     "@ezuikit/utils-collect": "0.1.0-beta.1",
     "@ezuikit/utils-logger": "1.0.1",
-    "browser-tool": "^1.0.5",
+    "browser-tool": "1.0.5",
     "eventemitter3": "^5.0.1",
     "recordrtc": "5.6.2",
     "screenfull": "5.1.0"

package/types/constant/index.d.ts

@@ -25,7 +25,7 @@ export namespace DEFAULT_PLAYER_OPTIONS {
     export let loadingTimeoutReplayTimes: number;
     export let heartTimeoutReplayTimes: number;
     export let keepScreenOn: boolean;
-    export let isNotMute: boolean;
+    export let isMute: boolean;
     export let hasAudio: boolean;
     export let volume: number;
     export let hasVideo: boolean;
@@ -93,8 +93,10 @@ export namespace EVENTS {
     export let mute: string;
     export let load: string;
     export let loading: string;
+    export let loaded: string;
     export let videoInfo: string;
     export let timeUpdate: string;
+    export let timeUpdateOSD: string;
     export let audioInfo: string;
     export let log: string;
     export let error: string;
@@ -127,6 +129,13 @@ export namespace EVENTS {
     export let videoTimeUpdate: string;
     export let videoSyncAudio: string;
     export let playToRenderTimes: string;
+    export let localVideoRecords: string;
+    export let getDefinitionListResult: string;
+    export let definitionChange: string;
+    export let definitionListChange: string;
+    export let playbackRateListChange: string;
+    export let playbackRateChange: string;
+    export let decoderLoaded: string;
 }
 export namespace FLV_EVENTS {
     import load_1 = EVENTS.load;
@@ -266,3 +275,7 @@ export namespace FETCH_ERROR {
     let abortError2: string;
     let abort: string;
 }
+/**
+ * 开放平台https接口
+ */
+export const HTTP_ENV_DOMAIN: "https://open.ys7.com/";

package/types/index.d.ts

@@ -2,16 +2,14 @@ export default EzuikitFlv;
 /**
  * @classdesc EzuikitFlv.js 播放flv直播流， 支持播放h264/h265的直播视频流
  * @example
- * ```js
  * const flv = new EzuikitFlv({
  *  id: "EleId",
  *  url: "https://open.ys7.com/v3/openlive/E71992743_1_1.flv"
  * })
- * ```
  */
 declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
     /**
-     * @description ERROR
+     * @description EzuikitFlv error events
      * @static
      * @member
      * @example
@@ -33,6 +31,17 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
         wasmDecodeError: string;
         webglAlignmentError: string;
     };
+    static QUALITY_ENUM: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+    };
+    /** 旋转角度 */
+    static ROTATE: number[];
     /** */
     static TIMEOUT: {
         loadingTimeout: string;
@@ -44,6 +53,7 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @returns {FlvOptions}
      */
     private static _setOptions;
+    /** 版本号 EzuikitFlv.version */
     static version: string;
     /**
      * @description 静态方法 判断是否支持播放地址
@@ -54,9 +64,7 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @static
      *
      * @example
-     * ```js
      * EzuikitFlv.supportType({url: "https://open.ys7.com/v3/openlive/E71992743_1_1.flv",  type:'flv'})
-     * ```
      */
     static supportType(options: {
         url?: string | undefined;
@@ -68,11 +76,81 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      */
     constructor(options: FlvOptions);
     event: EventEmitter<string | symbol, any>;
+    urlInfo: {};
+    seekTime: number;
     _opt: FlvOptions;
     $container: any;
     _loadingTimeoutReplayTimes: number;
     _heartTimeoutReplayTimes: number;
     events: Events;
+    _videoInfo: {};
+    definitionList: any[];
+    definition: {};
+    /**
+     * @private
+     */
+    private _playbackRate;
+    playbackRateList: number[];
+    playbackRecords: any[];
+    /**
+     * https 接口调用 仅针对萤石设备
+     * @since @1.0.3
+     * @private
+     */
+    private _httpServices;
+    /**
+     * @description 自定义设置清晰度列表， 仅对萤石设备预览生效, 需要第一次 definitionListChange 事件监听后调用, 不然会被接口覆盖
+     * @param {VideoLevel} list
+     * @since 1.0.3
+     * @returns {void}
+     */
+    setDefinitionList(list: VideoLevel): void;
+    /**
+     * @description 切换清晰度，仅对萤石设备预览生效
+     * @param {VideoLevel} definition 清晰
+     * @since 1.0.3
+     * @returns {void}
+     */
+    switchDefinition(definition: VideoLevel): void;
+    /**
+     * @description 自定义设置倍速列表, 仅对萤石设备回放生效
+     * @param {Array<number>} list
+     * @since 1.0.3
+     * @returns {void}
+     */
+    setPlaybackRateList(list: Array<number>): void;
+    set playbackRate(rate: number);
+    get playbackRate(): number;
+    /**
+     * @description 切换倍速，仅对萤石设备回放生效
+     * @param {number} rate
+     * @since 1.0.3
+     * @returns {void}
+     */
+    switchPlaybackRate(rate: number): void;
+    /**
+     * @description 获取回放地址
+     * @private
+     * @returns {Promise<number>} // 0 成功  1 失败
+     */
+    private _getNewPlaybackPlayUrl;
+    /**
+     * @description 跳转到指定时间 仅对萤石设备回放生效
+     * @param {stirng} time seekTime  YYYYMMDDhhmmss
+     */
+    seek(seekTime: any): Promise<void>;
+    /**
+     * @description 是否是回放
+     * @param {string} url
+     * @private
+     * @since @1.0.3
+     * @returns {boolean}
+     */
+    private _isEzvizPlayback;
+    /**
+     * 当前是否在播放中
+     */
+    get playing(): any;
     /**
      * @description 销毁
      * @example
@@ -176,14 +254,6 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * flv.pause()
      */
     pause(): Promise<unknown>;
-    /**
-     * @description 关闭视频,不释放底层资源
-     * @private
-     * @returns {void}
-     * @example
-     * flv.close()
-     */
-    private close;
     /**
      * @description 清理画布为黑色背景
      * @private
@@ -213,6 +283,7 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @param {number=} width  宽
      * @param {number=} height  高
      * @example
+     *
      * flv.resize()
      */
     resize(width?: number | undefined, height?: number | undefined): void;
@@ -226,8 +297,8 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
     private setBufferTime;
     /**
      * @description 设置旋转角度，支持，0(默认), 90, 180, 270 四个值。
+     * @param {number} deg 旋转角度取值 EzuikitFlv.ROTATE
      * @returns {Promise}
-     * @param {number} deg
      * @example
      * flv.setRotate(90) // 旋转90度
      */
@@ -251,12 +322,27 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @param {Boolean} flag
      */
     private _setFullscreen;
+    /**
+     * 当前容器全屏中
+     * @returns {boolean}
+     */
+    get fullscreening(): boolean;
+    /**
+     * 当前视频的信息, 推荐使用监听 videoInfo 事件
+     * @returns {Object}
+     */
+    get videoInfo(): any;
+    /**
+     * 当前播放时间（从0 开始 单位秒）
+     * @returns {number}
+     */
+    get currentTime(): number;
     /**
      * @description 全屏播放视频(不支持移动端)
      * @returns {Promise}
+     * @deprecated
      * @example
      * flv.fullScreen() // 全屏
-     *
      */
     fullScreen(): Promise<any>;
     /**
@@ -264,12 +350,12 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @returns {Promise}
      * @example
      * flv.fullscreen() // 全屏
-     *
      */
     fullscreen(): Promise<any>;
     /**
      * @description 退出全屏播放视频
      * @returns {Promise}
+     * @deprecated
      * @example
      * flv.cancelFullScreen() // 退出全屏
      */
@@ -278,15 +364,23 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
      * @description 取消全屏播放视频
      * @returns {Promise}
      * @example
-     * flv.exitFullscreen() // 全屏
+     * flv.exitFullscreen() // 退出全屏
      */
     exitFullscreen(): Promise<any>;
     /**
-     * @description 退出全屏播放视频
-     * @private
-     * @returns {Promise}
+     * @description 截图，调用后弹出下载框保存截图
+     * @param {string=} filename 保存的文件名, 默认 时间戳
+     * @param {string=} format 截图的格式，可选png或jpeg或者webp ,默认 png
+     * @param {number=} quality 当格式是jpeg或者webp时，压缩质量，取值0 ~ 1 ,默认 0.92
+     * @param {("download" | "base64" | "blob")} type  download,base64,blob, 默认download
+     *
+     * @returns {string | Blob | undefined}
+     * @since 1.0.3
+     * @example
+     * flv.screenshot()
+     * flv.screenshot("filename", "jpeg", 0.7, "download")
      */
-    private _exitFullscreen;
+    screenshot(filename?: string | undefined, format?: string | undefined, quality?: number | undefined, type?: ("download" | "base64" | "blob")): string | Blob | undefined;
     /**
      * @description 获取播放器的状态
      * @returns {PlayerState} 播放器的状态
@@ -297,11 +391,17 @@ declare class EzuikitFlv extends EventEmitter<string | symbol, any> {
     /**
      * @description 获取设置
      * @returns {object}
+     *
+     * @example
+     * player.getOptions()
      */
     getOptions(): object;
     /**
      * @description 获取版本
      * @returns {string}
+     *
+     * @example
+     * player.getVersion()
      */
     getVersion(): string;
 }

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

@@ -38,12 +38,21 @@ export default class BasePlayer extends Emitter {
     _audioTimestamp: number;
     events: Events;
     video: any;
+    _fullscreen: boolean;
     control: Control;
+    set fullscreen(value: any);
+    get fullscreen(): any;
+    set webFullscreen(value: any);
+    get webFullscreen(): any;
     /**
      *
      * @param options
      */
     updateOption(options: any): void;
+    /**
+     * @description 重置尺寸
+     */
+    resize(): void;
 }
 import Emitter from '../utils/emitter';
 import Debug from '../utils/debug';

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

@@ -30,8 +30,15 @@ export default class HardPlayer extends BasePlayer {
     _pause: boolean;
     _decodedFrames: number;
     constructor(container: HTMLElement, options: RequiredFlvOptions);
-    close(): Promise<unknown>;
+    close(): void;
     _createPlayer(options: RequiredFlvOptions): void;
+    /**
+     * @private
+     */
+    _removeFlvEvents(): void;
+    /**
+     * @private
+     */
     _flvEvents(): void;
     getOption(): RequiredFlvOptions;
     emitError(errorType: string, message?: string): void;
@@ -40,10 +47,6 @@ export default class HardPlayer extends BasePlayer {
      */
     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: boolean);
@@ -81,14 +84,17 @@ export default class HardPlayer extends BasePlayer {
     /**
      * @description 播放
      * @param url
-     * @param options
+     * @param {object} options
      * @returns {Promise}
      */
-    play(): Promise<unknown>;
-    _play(): Promise<void>;
+    play(options?: {
+        url?: string;
+    }): Promise<unknown>;
+    _play(options?: {
+        url?: string;
+    }): Promise<void>;
     _close(): Promise<unknown>;
     pause(): Promise<unknown>;
     resumeAudioAfterPause(): void;
     mute(flag: boolean): void;
-    resize(): void;
 }

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

@@ -1,6 +1,6 @@
 import CommonLoader from '../commonLoader';
-import { ScreenshotFormat } from '../interface';
-import HardPlayer from '.';
+import { type ScreenshotFormat } from '../interface';
+import type HardPlayer from '.';
 export default class VideoLoader extends CommonLoader {
     _delayPlay: boolean;
     $canvasElement: HTMLCanvasElement;
@@ -25,4 +25,5 @@ export default class VideoLoader extends CommonLoader {
     resize(): void;
     _resizeElement($Element: HTMLVideoElement | HTMLImageElement): void;
     isPlaying(): boolean;
+    get currentTime(): number;
 }

package/types/player/index.d.ts

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

package/types/player/interface.d.ts

@@ -13,13 +13,14 @@ export type TFlvOptions = {
     loadingTimeout: number;
     loadingTimeoutReplay: boolean;
     keepScreenOn: boolean;
-    isNotMute: boolean;
+    isMute: boolean;
     useMSE: boolean;
     autoWasm: boolean;
     wasmDecodeErrorReplay: boolean;
     useWebFullScreen: boolean;
     width: number;
     height: number;
+    isLive: boolean;
 };
 export type RequiredFlvOptions = Required<TFlvOptions> & {
     url: string;

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

@@ -13,6 +13,7 @@ export default class CanvasVideoLoader extends CommonLoader {
         height: string;
         encType: string;
     };
+    _currentTime: number;
     _contextmenuEvent: (e: any) => void;
     _initContextGl(): void;
     _initContext2D(): void;
@@ -23,5 +24,9 @@ export default class CanvasVideoLoader extends CommonLoader {
     render(msg: any): void;
     screenshot(filename: any, format: any, quality: any, type: any): string | File;
     resize(): void;
+    /**
+     * 当前播放pts （单位秒）
+     */
+    get currentTime(): number;
 }
 import CommonLoader from '../commonLoader';

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

@@ -1,3 +1,6 @@
+/**
+ * @description 软解
+ */
 export default class SoftPlayer extends BasePlayer {
     constructor(container: any, options: any);
     audio: Audio;
@@ -9,10 +12,6 @@ export default class SoftPlayer extends BasePlayer {
     set volume(value: number);
     get volume(): number;
     destroy(): void;
-    set fullscreen(value: any);
-    get fullscreen(): any;
-    set webFullscreen(value: any);
-    get webFullscreen(): any;
     set loaded(value: boolean);
     get loaded(): boolean;
     set playing(value: boolean);
@@ -29,7 +28,7 @@ export default class SoftPlayer extends BasePlayer {
      *
      * @returns {Promise<unknown>}
      */
-    init(): Promise<unknown>;
+    _init(): Promise<unknown>;
     /**
      *
      * @param url
@@ -53,10 +52,6 @@ export default class SoftPlayer extends BasePlayer {
      * @param {boolean} flag
      */
     mute(flag: boolean): void;
-    /**
-     * @description 重置尺寸
-     */
-    resize(): void;
     _onlyMseOrWcsVideo(): any;
     /**
      * 心跳检查

package/types/services/HttpUtil.d.ts

@@ -0,0 +1,19 @@
+export default HttpUtil;
+declare class HttpUtil {
+    static defaults: {
+        baseURL: string;
+        accessToken: string;
+        deviceSerial: string;
+        channelNo: string;
+    };
+    /**
+     *
+     * @param {string} url 请求地址
+     */
+    static get(url: string, options?: {}): Promise<Response>;
+    /**
+     *
+     * @param {string} url 请求地址
+     */
+    static post(url: string, options?: {}): Promise<Response>;
+}

package/types/services/api.d.ts

@@ -0,0 +1,7 @@
+export default API;
+declare namespace API {
+    let getLocalVideoUnifyQuery: string;
+    let getVideoQuality: string;
+    let setVideoLevel: string;
+    let getAddress: string;
+}

package/types/services/getAddress.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @description 获取播放地址 https://open.ys7.com/help/1414
+ * @param {Obejct} params
+ * @param {number=} params.expireTime 过期时长，单位秒；针对hls/rtmp/flv设置有效期，相对时间；30秒-720天
+ * @param {number=} params.type  地址的类型，1-预览，2-本地录像回放，3-云存储录像回放，非必选，默认为1；回放仅支持rtmp、ezopen、flv协议
+ * @param {number=} params.quality  视频清晰度，1-高清（主码流）、2-流畅（子码流）
+ * @param {string=} params.startTime 本地录像/云存储录像回放开始时间,云存储开始结束时间必须在同一天，示例：2019-12-01 00:00:00
+ * @param {string=} params.stopTime  本地录像/云存储录像回放结束时间,云存储开始结束时间必须在同一天，示例：2019-12-01 23:59:59
+ * @param {number=} params.playbackSpeed  回放倍速。倍速为 -1（ 支持的最大倍速）、0.5、1、2、4、8、16； 仅支持protocol为4-flv 且 type为2-本地录像回放（ 部分设备可能不支持16倍速） 或者 3-云存储录像回放
+ *
+ */
+export function getAddressService(params?: Obejct): Promise<any>;
+export function getPlaybackAddressService(params?: {}): Promise<any>;
+/**
+ * @description 获取直播地址
+ * @param {{quality: 1 | 2, expireTime: number}} params
+ * @returns
+ */
+export function getLiveAddressService(params?: {
+    quality: 1 | 2;
+    expireTime: number;
+}): Promise<any>;

package/types/services/getLocalVideoUnifyQuery.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description 获取查询设备本地录像 (开始结束时间必须在同一天) https://open.ys7.com/help/3922
+ * @param {Obejct} params
+ * @param {string | number} params.startTime 开始时间 （毫秒）
+ * @param {string | number} params.endTime 结束时间（毫秒）
+ * @param {(string | number)=} params.pageSize 每页个数 默认200, 最大200, 超出自动遍历下一页
+ *
+ * @returns {Array<{"startTime": number,"endTime": number,"type": string, "size":number }>}
+ */
+export function getLocalVideoUnifyQueryService(player: any, params: Obejct): Array<{
+    "startTime": number;
+    "endTime": number;
+    "type": string;
+    "size": number;
+}>;

package/types/services/getVideoQuality.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @description 获取设备视频质量查询接口 https://open.ys7.com/help/3922
+ *
+ * @returns {Array<{"streamTypeIn": 1 | 2,"videoLevel":  0 | 1 | 2 | 3 | 4 | 5 |6, name: string }>}
+ */
+export function getVideoQualityService(player: any): Array<{
+    "streamTypeIn": 1 | 2;
+    "videoLevel": 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    name: string;
+}>;
+/**
+ * videoLevel 清晰度枚举
+ */
+export const QUALITY_ENUM: {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+    6: string;
+};
+export const DEFAULT_QUALITY: {
+    /**
+     * 0: 流畅
+     * 1: 标清
+     * 2: 高清
+     * 3: 超清
+     * 4: 极清
+     * 5: 3K
+     * 6: 4K
+     */
+    videoLevel: number;
+    name: string;
+    streamTypeIn: number;
+    /** 用来区分清晰度是否是默认值还是接口返回的 */
+    type: string;
+}[];

package/types/services/setVideoLevel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @description 获取设备视频质量查询接口 https://open.ys7.com/help/3922
+ * @param {string | number} videoLevel 设备视频清晰度等级 0-流畅 1-均衡 2-高清 3-超清 4 5 6
+ */
+export function setVideoLevelService(player: any, videoLevel: string | number): Promise<any>;

package/types/stream/index.d.ts

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