usc-player-new
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

usc-player-new 新版播放器

注意: 此版本播放器需要在HTTPS环境下使用

Features

  • 📢 HTTPS免插件
  • 📝 支持两种使用场景
  • 🚀 快速, 低延时
  • 🧬 断线自动重连

安装和使用说明

  1. 脚本方式引入, 播放器对象实例 new UscPlayerNew.Player()

<script src="/path/to/usc-player-new.iife.js"></script>
function newPlayer() {
  const box = document.createElement('div')
  document.querySelector('body').appendChild(box)
  const player = new UscPlayerNew.Player(box)
  player.play(url, code)
}
newPlayer()
  1. es方式引用 播放器对象实例 new Player()

安装npm包

pnpm install usc-player-new

引入播放器 使用script标签需要注意 type="module"

import { Player } from 'usc-player-new'
// 使用方式与上面脚本方式引入相似
// const player = new UscPlayerNew.Player(box)
// 替换为
const player = new Player(box)

播放器属性

  • box 容器 播放器初始化参数, 一般使用div标签即可
  • canvas 播放器画布 用以渲染视频
  • audio 视频是否有声音 默认值 false 触发事件后为true
  • muted 视频是否静音 默认值 true
  • filled 视频是否填充容器 默认值 false
  • recording 视频是否在手动录制中 默认值 false
  • recordFilename 录制的文件名 用于下载录制文件
  • retry 视频重试次数 默认值 3

播放器方法

1. player.mute()

参数true/false 启用静音/打开声音 无参数为切换

2. player.play(url, code)

url: 播放地址 (ws或wss协议) code: 播放码流

3. player.stop()

当前关闭播放器

4. player.fill()

参数true/false 填充容器/原始分辨率 无参数为切换

5. player.capture(filename)

可选参数 filename 默认值为时间戳 截图 分辨率为当前画面的渲染分辨率

6. player.refresh()

在播放状态下, 刷新当前播放器

7. player.record(filename)

可选参数 filename 默认值为时间戳 在播放状态下, 开始录制

8. player.recordEnd()

在录制状态下, 停止录制 录制文件下载接口: api/video/downloadTemp 详情搜索接口文档

播放器事件

1. player.on('error', (err) => {})

播放失败 err: { code reason } 错误码code 加载错误码 错误原因reason 错误信息 触发error后,播放器会尝试重新播放

2. player.on('stop', (err) => {})

播放停止 与error事件的区别: stop事件后播放停止

3. player.on('audio')

声音事件 播放后获取视频声音后触发

4. player.on('data')

开始播放 播放后开始渲染后触发

License

MIT License.

Package Sidebar

Install

npm i usc-player-new

Weekly Downloads

1

Version

1.3.1

License

none

Unpacked Size

52.7 kB

Total Files

6

Last publish

Collaborators

  • outlove