byskplayer.js API

兼容性

byskplayer.js不支持IE浏览器，因byskplayer.js使用了ES6的特性，推荐使用Chrome浏览器

Demo

• 在线访问demo

• 下载demo

   

注意事项

• demo需要部署到web容器中运行, 如: 使用 nginx 部署, 然后使用http(s)在浏览器中访问

  • 在浏览器通过文件协议访问(即直接使用浏览器打开文件)的方式没有经过测试, 可能会有问题

• 如果 H265 视频使用 webgl 的方式播放:

  • bsjlib 目录需要部署到网站的根目录下, 因为 bsjlib 目录下的文件是通过绝对路径(如: /bsjlib/Decoder.worker.bee2ba95.js )访问的

  • 使用 Vue2 / Vue3 开发需要放到静态资源目录下(如: static, public 目录 )

    vue2 webpack 老项目开发环境需要添加代理 bsjlib 到 static/bsjlib 下

    打包需要将 static/bsjlib 拷贝到根目录下

  • 在 network 中, 如果 bsjlib/libbsjdecoder.wasm 文件出现 404, 请检测 bsjlib 是否放置到项目根目录, 或者检测服务器是否允许访问 wasm 文件, 如: nginx 添加 MIME 类型 application/wasm wasm

• byskplayer.js 是已经压缩过的了, 请不要重复打包压缩

在本地快速体验 Demo

需要提前安装 nodejs, 下载地址: https://nodejs.org/en/download/prebuilt-installer

• 在本地新建目录 player-demo, 然后下载 demo 到本地, 目录可以任意命名

• 将下载的 demo 解压到 player-demo 目录

• 在 player-demo 的位置打开命令行(cmd)

• 在命令行中执行 npx http-server -p 4409, 端口可设置

• 在浏览器中通过 http://localhost:4409/demo.html 快速访问 demo

使用其他 http服务器软件 也可实现上述的效果, 比如: nginx, iis 等, 请根据需要选择自己熟悉的方式

引入

• 下载直接引入：

  <script src='./byskplayer.js'></script>

• import byskplayer from './byskplayer.js'

  使用 Vue2 / Vue3 开发需要放到静态资源目录下(如: static, public 目录 )

  vue2 webpack 老项目需要添加代理

  xxxxxxxxxx
  // 在 `config/index.js` 配置代理
  // dev 开发环境通过代理 `/bsjlib` 访问 `static/bsjlib`
  proxyTable: {
      '/bsjlib': {
          target: `http://localhost:${ process.env.PORT || 8080 }`,
          pathRewrite: {
            '/bsjlib': '/static/bsjlib'
          }
        }
  }
  

  ​x
  // 在 `build/webpack.prod.conf.js` 中配置拷贝目录
  // 打包 线上生产环境通过将 `static/bsjlib` 目录拷贝到根目录下
  // copy bsjlib
  new CopyWebpackPlugin([{
    from: path.resolve(__dirname, '../static/bsjlib'),
    to: 'bsjlib',
    ignore: ['.*']
  }])
  
  // 或者收到将 bsjlib 目录拷贝的网站的根目录
  

通过 import 的方式引入, 需要保证 byskplayer.js 不会被压缩打包

如果遇到相关问题, 可以尝试通过配置 babel-loader 的 exclude 属性, 将 byskplayer.js 排除

接口

byskplayer.js通过在window对象上公开byskplayer类导出所有接口

构造函数：

• new byskplayer()

实例属性：

• player.version

• player.poster

• player.autoCloseTime

• player.real

• player.record

实例方法：

• player.destroy()

• player.setPlayerNum()

• player.allocate()

• player.real.open()

• player.real.close()

• player.real.openSpeak()

• player.real.closeSpeak()

• player.record.query()

• player.record.open()

• player.record.close()

• player.record.pause()

• player.record.play()

• player.ftp.downloadToServer()

• player.ftp.cancel()

• player.ftp.downloadFile()

• player.gaDownload.downloadFile()

• player.gaDownload.cancel()

new byskplayer()

xxxxxxxxxx
let player = new byskplayer(config): byskplayer;

根据config创建byskplayer实例

注意: 请先确认 container 元素已经渲染出来后, 再实例化 player

config

click

playstart

playend

status状态定义说明

xxxxxxxxxx
 * 0: 请求失败；
 * 1: 请求成功
 * -1: 设备备没有响应，网关返回设备响应超时
 * -2: 设备不在线
 * -3: 设备录像查询，当前有用户在查
 * -4: 设备回放有其他高级级别用户再看
 * -6: 设备欠压
 * -7: 设备休眠
 * -8: 设备唤醒中
 * -101: WebSocket未连接
 * -102: 请求超时

player.version

xxxxxxxxxx
let version = player.version

获取byskplayer.js版本（只读）

player.poster

xxxxxxxxxx
player.poster = 'https://www.exmaple.com/static/images/video_poster.png';

设置视频播放器预览图片（只写）

player.autoCloseTime

xxxxxxxxxx
player.autoCloseTime = 15;

设置自动关闭视频时间(分钟)，从给autoCloseTime赋值开始计时，为0则不自动关闭视频（只写）

player.real

xxxxxxxxxx
let real = player.real;

通过player.real控制实时视频播放，参见player.real.open和player.real.close方法

player.record

xxxxxxxxxx
let record = player.record;

通过player.record控制回放视频播放，参见player.record.query，player.record.open和player.record.close方法

player.destroy()

xxxxxxxxxx
player.destroy();

通过调用该方法销毁播放器，销毁后将不能再使用其它功能

player.setPlayerNum()

xxxxxxxxxx
player.setPlayerNum(num);

切换视频播放器显示的画面数，支持同时显示1至16个画面

player.allocate()

xxxxxxxxxx
player.allocate(num, start = 0);

申请需要播放视频的播放器Id，支持同时申请1至16个播放器

返回对象：

player.real.open()

请求播放实时视频

xxxxxxxxxx
player.real.open(tid, params, cb);

params

cb

player.real.close()

停止播放实时视频

xxxxxxxxxx
player.real.close(tid, params, cb);

params

cb

player.real.openSpeak()

打开对讲

xxxxxxxxxx
player.real.openSpeak(params, cb);

params

cb

player.real.closeSpeak()

关闭对讲

xxxxxxxxxx
player.real.closeSpeak(params, cb);

params

cb

player.record.query()

查询回放录像视频记录

xxxxxxxxxx
player.record.query(params, cb);

params

cb

recordfile

player.record.open()

请求播放回放视频

xxxxxxxxxx
player.record.open(ret.ids[0], params, cb, mds);

params

cb

mds

player.record.close()

停止播放回放视频

xxxxxxxxxx
player.record.close(tid, params, cb);

params

cb

player.record.pause()

暂停播放视频

xxxxxxxxxx
player.record.pause(params);

params

player.record.play()

暂停后继续播放视频

xxxxxxxxxx
player.record.play(params);

params

player.ftp.downloadToServer()

设备通过FTP下载到服务器（GF-1078设备）

xxxxxxxxxx
player.ftp.downloadToServer(params, cb);

params

cb

player.ftp.cancel()

取消设备FTP下载到服务器

xxxxxxxxxx
player.ftp.cancel(params, cb);

params

cb

player.ftp.downloadFile

gt下载到本体

xxxxxxxxxx
player.ftp.downloadFile(params, cb);

params

cb

player.gaDownload.downloadFile()

通过浏览器设备直接下载到本地（GA设备）

xxxxxxxxxx
player.gaDownload.downloadFile(params, cb);

params

cb

player.gaDownload.cancel()

取消下载到本地

xxxxxxxxxx
player.gaDownload.cancel(params, cb);

params

cb