@besovideo/webrtc-player 0.8.98 → 0.9.1

package/README.md

@@ -418,6 +418,56 @@ const { instance } = Conference({
 install.open(type);
 ```
 
+
+**视频回放**
+
+```typescript
+import {PlayBack} from "@besovideo/webrtc-player";
+
+const { instance } = PlayBack({
+  // 必填 文件ID
+  fileID: string;
+  // 必填 文件名选填，控件下载文件时会使用这个，不填将是 【请填写Filename】
+  fileName?: string;
+  //必填 登录的token
+  token: string;
+  // 必填 设备ID 或者 NRUID， 填写PUID就是从设备回放文件，填写NRUID 就是从平台回放
+  puOption?: {
+      puId?: string;
+      nruId?: string;
+  },
+
+  // (可选) 内部访问平台接口的路径前缀 
+  apiPrefix?: string;
+  // (可选)  type 参数为 "ws-bvrtc" 时的播放控制 
+  bvrtcConfig?: {
+      // (可选) 是否使用webcodecs解码，用于h265解码硬件加速，兼容性没有软解好
+      enableWebcodes?: number,
+      // (可选) 设置解码实时性 范围 0-10, 0 -- 流畅性最大, 10 -- 实时性最大
+      realTimeLevel?: number,
+  },
+  //（可选） 控制 回放 是否 音频 或者 视频， 默认打开全部轨道
+  defaultMediaOption?: { audio: boolean, video: boolean },
+  // 必填 父容器传递个div就行了
+  container: HTMLDivElement; 
+
+  //（可选）语言 默认中文
+  locale?: "zh" | "en",
+  // 可选 默认 web 回放方式 "ws-bvrtc" (兼容性强，非原生) | "web"（原生，有些媒体文件播不了）
+  type?: "ws-bvrtc" | "web",
+  //（可选） 右键菜单的zindex 排序，有时候右键菜单 显示不出来
+  zIndexMenu?: number,
+
+  //（可选） 控制是否显示弹幕，默认显示
+  displayMode?: 'playback'
+})
+
+// 打开回放
+instance.open() 
+
+```
+
+
 **Vue 示例**
 
 ```vue
@@ -536,8 +586,8 @@ export default defineComponent({
       instance.open()
     </script>
 </html>
-```
 
+```
 ## 升级 Upgrade
 
 ```shell