@havue/solutions 1.1.1 → 1.2.0

package/ws-video-manager/dist/ws-video-manager.umd.js

@@ -7315,29 +7315,32 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     // private divID = ''
     constructor(options = {}) {
       super();
-      /** video元素 */
+      /** video元素 | videw element */
       __publicField(this, "_videoEl");
-      /** mp4box 实例 */
+      /** mp4box file */
       __publicField(this, "_mp4box", MP4Box.createFile());
-      /** mp4box onFragment获取的视频数据buffer数组 */
+      /**
+       * mp4box onFragment获取的视频数据buffer数组
+       * mp4box onFragment gets a buffer array of audio and video data
+       */
       __publicField(this, "_audioBufsQueue", []);
       __publicField(this, "_videoBufsQueue", []);
-      /** MediaSource 实例 */
+      /** MediaSource instance */
       __publicField(this, "_mediaSource");
-      /** SourceBuffer 实例 */
+      /** SourceBuffer instance */
       __publicField(this, "_audioSourceBuffer");
       __publicField(this, "_videoSourceBuffer");
       __publicField(this, "_audioTrackId");
       __publicField(this, "_videoTrackId");
-      /** 用于MediaSource的mimeType */
+      /** 用于MediaSource的mimeType | mime type of the video */
       __publicField(this, "_mimeType", "");
       __publicField(this, "_audioMimeType", "");
       __publicField(this, "_videoMimeType", "");
-      /** 是否暂停播放 */
+      /** 是否暂停播放 | Pause or not */
       __publicField(this, "_paused", false);
       __publicField(this, "_options");
       __publicField(this, "_cacheAnimationID");
-      /** fmp4初始化片段是否已经添加 */
+      /** fmp4初始化片段是否已经添加 | fmp4 Initializes whether the fragment has been added */
       __publicField(this, "_isAudioInitSegmentAdded", false);
       __publicField(this, "_isVideoInitSegmentAdded", false);
       __publicField(this, "_offset", 0);
@@ -7370,14 +7373,14 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     get videoEl() {
       return this._videoEl;
     }
-    /** 更新实例配置 */
+    /** 更新实例配置 | Update configuration */
     updateOptions(option = {}) {
       Object.assign(this._options, {
         ...option
       });
     }
     /**
-     * 添加视频流buffer数据
+     * 添加视频流buffer数据 | Add video stream buffer data
      * @param buf
      */
     appendMediaBuffer(bufs) {
@@ -7392,8 +7395,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       return;
     }
     /**
-     * mp4box解析完成
-     * @param info mp4box解析信息
+     * mp4box解析完成 | handle Mp4box onReady
+     * @param info mp4box解析信息 | mp4box parses the information
      */
     _onMp4boxReady(info) {
       console.log("onMp4boxReady", info);
@@ -7470,7 +7473,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._cache(isVideo);
     }
     /**
-     * 初始化视频元素
+     * 初始化视频元素 | Initialize the video element
      */
     _setupVideo() {
       this._videoEl = document.createElement("video");
@@ -7526,13 +7529,14 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 是否支持Media Source Extention
+     * whether Media Source Extention is supported
      * @returns boolean
      */
     isSupportMSE() {
       return "MediaSource" in window;
     }
     /**
-     * 初始化MSE
+     * 初始化MSE | Init MSE
      * @returns
      */
     _setupMSE() {
@@ -7609,6 +7613,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 将_bufsQueue中的数据添加到SourceBuffer中
+     * Add the data from _bufsQueue to the SourceBuffer
      * @returns
      */
     _cache(isVideo = false) {
@@ -7652,6 +7657,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 刷新播放时间为最新
+     * Refresh the playback time to the latest
      */
     refresh() {
       if (this._videoEl && this._videoEl.buffered.length) {
@@ -7659,7 +7665,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         this._videoEl.currentTime = end;
       }
     }
-    /** 重置解析的视频mime type */
+    /** 重置解析的视频mime type | Reset the parsed video mime type */
     resetMimeType() {
       this.destroyMp4box();
       this.destroyMediaSource();
@@ -7710,7 +7716,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._mp4box = null;
     }
     /**
-     * 销毁
+     * 销毁 | Destroy
      */
     destroy() {
       if (this._videoEl) {
@@ -7761,7 +7767,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._ctx2d.fillRect(0, 0, this._canvas.width, this._canvas.height);
     }
     /**
-     * 初始化 webgl
+     * 初始化 webgl | Initialize webgl
      */
     initGl() {
       if (!this._canvas) return;
@@ -7803,7 +7809,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._glReady = true;
     }
     /**
-     * 创建着色器源码
+     * 创建着色器源码 | Create shader source code
      */
     createShaderSource(gl, type) {
       const vertexShaderSource = `
@@ -7830,7 +7836,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 创建着色器
+     * 创建着色器 | Create shaders
      */
     createShader(gl, type, source) {
       const shader = gl.createShader(type);
@@ -7848,7 +7854,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       return shader;
     }
     /**
-     * 创建着色器程序
+     * 创建着色器程序 | Create program
      */
     createProgram(gl, vertexShader, fragmentShader) {
       const program = gl.createProgram();
@@ -7867,7 +7873,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       return program;
     }
     /**
-     * 绘制
+     * 绘制 | draw
      */
     draw(video) {
       if (this._useGl) {
@@ -7906,7 +7912,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 销毁
+     * 销毁 | Destroy
      */
     destroy() {
       this._canvas = null;
@@ -7942,7 +7948,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   class WsVideoManager extends shared.EventBus {
     constructor(options) {
       super();
-      /** socket连接 渲染相关对应信息 */
+      /** socket相关信息map | map of socket information */
       __publicField(this, "_wsInfoMap", /* @__PURE__ */ new Map());
       __publicField(this, "_option", DEFAULT_OPTIONS);
       __publicField(this, "_reqAnimationID", null);
@@ -7975,8 +7981,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       render();
     }
     /**
-     * 添加socket实例
-     * @param url socket地址
+     * 添加socket连接 | Adding a socket connection
+     * @param url socket url
      * @returns
      */
     _addSocket(url, renderOptions) {
@@ -8005,9 +8011,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       socket.open();
     }
     /**
-     * 绑定render事件
-     * @param url 连接地址
-     * @param render Render实例
+     * 绑定render事件 | Binding the render event
+     * @param url 连接地址 | websocket url
+     * @param render Render instance
      */
     _bindRenderEvent(url, render) {
       render.on(RenderEventsEnum.AUDIO_STATE_CHANGE, (state) => {
@@ -8021,8 +8027,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       });
     }
     /**
-     * 销毁socket实例
-     * @param url socket地址
+     * Destroying the socket connect
+     * @param url socket url
      */
     _removeSocket(url) {
       const wsInfo = this._wsInfoMap.get(url);
@@ -8036,9 +8042,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 绑定socket事件
-     * @param url 连接地址
-     * @param socket WebSocketLoader实例
+     * 绑定socket事件 | Binding socket events
+     * @param url websocket url
+     * @param socket WebSocketLoader instance
      */
     _bindSocketEvent(socket, render, url) {
       socket.on("close", () => {
@@ -8068,8 +8074,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * url对应的 socket实例是否已存在
-     * @param url socket地址
+     * url对应的 socket实例是否已存在 | Whether the socket instance for the url already exists
+     * @param url websocket url
      * @returns boolean
      */
     _isSocketExist(url) {
@@ -8077,8 +8083,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 添加url对应socket，以及需要绘制的canvas元素
-     * @param canvas canvas元素
-     * @param url socket url地址
+     * Add the socket for the url and the canvas element to draw
+     * @param canvas canvas
+     * @param url websocket url
      */
     addCanvas(canvas, url, renderOptions) {
       this._addSocket(url, renderOptions);
@@ -8097,8 +8104,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 初始化canvas背景
-     * @param canvas canvas元素
+     * 初始化canvas背景 | Initialize the canvas background
+     * @param canvas canvas
      * @returns
      */
     // private _setupCanvas(canvas: HTMLCanvasElement) {
@@ -8110,8 +8117,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     //   ctx.fillRect(0, 0, canvas.width, canvas.height)
     // }
     /**
-     * 删除canvas元素
-     * @param canvas canvas元素
+     * 删除canvas元素 || Remove the canvas element
+     * @param canvas canvas
      */
     removeCanvas(canvas) {
       const entries = this._wsInfoMap.entries();
@@ -8130,8 +8137,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       });
     }
     /**
-     * 返回canvas是否已经添加过
-     * @param canvas canvas元素
+     * 获取canvas是否已经添加过 | Gets whether the canvas has already been added
+     * @param canvas canvas
      * @returns boolean
      */
     isCanvasExist(canvas) {
@@ -8140,13 +8147,13 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         return info.canvasMap.has(canvas);
       });
     }
-    /** 设置全部render静音状态 */
+    /** 设置全部render静音状态 | Mute all render */
     setAllVideoMutedState(muted) {
       this._wsInfoMap.forEach((wsInfo) => {
         wsInfo.render.muted = muted;
       });
     }
-    /** 更新单个render实例的配置 */
+    /** 更新单个render实例的配置 | Update the configuration of a single render instance */
     updateRenderOptions(url, options) {
       if (options) {
         const wsInfo = this._wsInfoMap.get(url);
@@ -8154,9 +8161,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 设置单个render静音状态
+     * 设置单个render静音状态 | Set a single render to be silent
      * @param url
-     * @param muted boolean 是否静音
+     * @param {boolean} muted  是否静音 | Muted or not
      */
     setOneMutedState(url, muted) {
       const wsInfo = this._wsInfoMap.get(url);
@@ -8167,7 +8174,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 获取url对应render video元素是否静音
-     * @param url socket地址
+     * Gets whether the render video element of the url is muted
+     * @param url websocket url
      */
     getOneMutedState(url) {
       const wsInfo = this._wsInfoMap.get(url);
@@ -8178,7 +8186,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 单个解除静音，其他未静音的变成静音，只播放一个
-     * @param url socket地址
+     * Unmute a single video and mute all other videos
+     * @param url websocket url
      */
     playOneAudio(url) {
       this.setAllVideoMutedState(true);
@@ -8186,6 +8195,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 设置单个render是否继续处理ws数据
+     * Sets whether a single render continues to process ws data
      * @param url
      */
     setOneVideoPausedState(url, paused) {
@@ -8195,15 +8205,16 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
       wsInfo.render.paused = paused;
     }
-    /** 设置全部render是否继续处理ws数据 */
+    /** 设置全部render是否继续处理ws数据 | Sets whether all render continues to process ws data */
     setAllVideoPausedState(paused) {
       this._wsInfoMap.forEach((wsInfo) => {
         wsInfo.render.paused = paused;
       });
     }
     /**
-     * 获取url对应render video元素是否继续播放
-     * @param url socket地址
+     * 获取url对应render video元素的播放状态
+     * Get the playback status of the render video element corresponding to the url
+     * @param url websocket url
      */
     getOneVideoPausedState(url) {
       const wsInfo = this._wsInfoMap.get(url);
@@ -8214,7 +8225,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 单个视频继续播放，其他暂停处理数据
-     * @param url socket地址
+     * A single video continues to play while others pause to process data
+     * @param url websocket url
      */
     playOneVideo(url) {
       this.setAllVideoPausedState(true);
@@ -8222,6 +8234,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /**
      * 刷新socket，以及播放时间
+     * Refresh the socket, and the playback time
      */
     refresh(url) {
       if (url) {
@@ -8242,7 +8255,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 销毁
+     * 销毁 | Destroy
      */
     destroy() {
       this._wsInfoMap.forEach((wsInfo) => {

package/ws-video-manager/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@havue/ws-video-manager",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Javascript class for websocket video manager",
   "keywords": [
     "havue",

package/ws-video-manager/src/loader/websocket-loader.ts

@@ -1,28 +1,31 @@
 // #region typedefine
-/** 心跳配置 */
+/** 心跳配置 | Heartbeat configuration */
 type HeartbeatConfigType = {
-  /** 只发送一次 */
+  /** 只发送一次 | Only send it once */
   once: boolean
-  /** 心跳消息 */
+  /** 心跳消息 | Heartbeat message */
   message: string
-  /** 时间间隔 */
+  /** 心跳间隔 | Interval of heartbeat */
   interval?: number
 }
 
-/** 重连配置 */
+/** 重连配置 | Reconnect configuration */
 type InterruptConfigType = {
-  /** 是否重连 */
+  /** 是否重连 | Reconnect or not */
   reconnect: boolean
-  /** 最大重连次数 */
+  /** 最大重连次数 | Maximum number of reconnections */
   maxReconnectTimes: number
-  /** 每次重连延时 */
+  /** 每次重连延时 | Delay per reconnection */
   delay: number
 }
 
 export type WebSocketOptionsType = {
-  /** WebSocket 子协议 WebSocket(url: string, protocols: string | string[]) */
+  /** WebSocket subprotocol: WebSocket(url: string, protocols: string | string[]) */
   protocols?: string | string[]
-  /** WebSocket 连接所传输二进制数据的类型 */
+  /**
+   * WebSocket 连接接收的二进制数据类型
+   *  the type of binary data being received over the WebSocket connection
+   */
   binaryType?: WebSocket['binaryType']
   heartbeat?: HeartbeatConfigType
   interrupt?: InterruptConfigType
@@ -121,6 +124,7 @@ class WebSocketLoader {
       }
 
       // 非手动关闭导致连接意外中断
+      // Non-manual shutdown results in unexpected connection interruption
       if (this._interruptConfig.reconnect && this._interruptReconnectTimes < this._interruptConfig.maxReconnectTimes) {
         this._interruptReconnectTimes++
 
@@ -157,7 +161,7 @@ class WebSocketLoader {
 
     const { message, interval, once } = this._heartbeatConfig
 
-    // 只发一次心跳
+    // 只发一次心跳 | Only one heartbeat
     if (once) {
       this.sendMessage(message)
       return