0.3.0 • Published 2 years ago

ezuikit-wesine v0.3.0

Weekly downloads
4
License
ISC
Repository
github
Last release
2 years ago

EZUIKit-JavaScript-npm

轻应用npm版本,降低接入难度,适配自定义UI,适配主流框架

低延时预览,云存储回放,SD卡回放

功能API丰富,如:播放控制,音频控制,视频截图,实时获取视频OSDTime,视频录制,设备对讲,电子放大,全屏等

获取ezuikit-js

$ npm install ezuikit-js

引入ezuikit-js

import  EZUIKit from 'ezuikit-js';
如果你使用原生方法,可以通过标签引用
  <script src="./ezuikit.js"></script>

开始使用 - 初始化

基本使用

创建DOM

  <div id="video-container"></div>

播放器初始化

    var player = new EZUIKit.EZUIKitPlayer({
      id: 'video-container', // 视频容器ID
      accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
      url: 'ezopen://open.ys7.com/203751922/1.live',
    })

方法调用

示例: 停止播放

  1. player.stop();

  2. player.stop()
  .then(()=>{
    console.log("执行播放成功后其他动作");
  });

示例: 执行播放(自动播放为false,自定义触发播放/切换播放地址)

  player.play();
  // 切换播放地址场景(注意先执行stop方法停止上次取流)
  player.play({
   url: 'ezopen://open.ys7.com/203751922/1.rec?begin=202001000000&end=202001235959'
  });

切换地址播放(注意需要先执行stop方法停止上次取流)

  player.stop()
  .then(()=>{
    player.play('ezopen://open.ys7.com/{其他设备}/{其他通道}.live');
  });

  // 其他账号下设备
  
  player.stop()
  .then(()=>{
    player.play({url:'ezopen://open.ys7.com/{其他设备}/{其他通道}.live',accessToken: 'xxxx'});
  });
  
自定义主题切换播放地址
当template值为“theme”时,自定义主题地址切换需要同步主题中的按钮,回放控件等。
如果需要同步主题控件,需要调用以下方法切换播放地址
player.changePlayUrl(options)
  

options参数说明

参数名类型描述是否必选
typeString播放地址类型,"live":预览,"rec":回放;“cloud.rec”:云存储回放Y
accessTokenString授权过程获取的access_tokenY
deviceSerialString设备序列号,存在英文字母的设备序列号,字母需为大写Y
channelNoint通道号Y
hdboolean是否为高清 true-主码流(高清) false-子码流(标清)Y
validCodeString设备验证码(加密设备播放需要输入验证码)Y
beginStringtype类型为回放有效,开始时间 格式为“YYYYMMDDHHmmss”N
endStringtype类型为回放有效,结束时间 格式为 “YYYYMMDDHHmmss”N

使用说明

初始化

参数名类型描述是否必选
idString播放器容器DOM的idY
accessTokenString授权过程获取的access_tokenY
urlString视频ezopen协议播放地址Y
audioint是否默认开启声音 1:打开(默认) 0:关闭N
autoplayint是否自动播放 1:开启 0:关闭N
widthint视频宽度,默认值为容器容器DOM宽度N
heightint视频高度,默认值为容器容器DOM高度N
templatestring播放器模板,可以通过选定模板,使用内置的播放器样式,组件 simple:极简版;standard:标准版;security:安防版(预览回放);vioce:语音版;theme:自定义主题(v0.3.0版本及以上支持)
headerArraysimple:极简版 视频头部可选UI组件,可选值:capturePicture:截图,save:录像保存,zoom:电子放大N
footerArraysimple:极简版 视频底部部可选UI组件,可选值:talk:对讲,broadcast:语音播报,hd:高清标清切换,fullScreen:全屏N
pluginArray按需加载插件,可选值: talk:对讲N
handleSuccessfunction播放成功回调N
handleErrorfunction播放错误回调N
openSoundCallBackfunction开启声音回调N
closeSoundCallBackfunction关闭回调N
startSaveCallBackfunction开始录像回调N
stopSaveCallBackfunction结束录像回调N
capturePictureCallBackfunction截图回调N
fullScreenCallBackfunction全屏回调N
fullScreenChangeCallBackfunction全屏变化回调-全局(含ESC退出全屏等)N
getOSDTimeCallBackfunction获取OSD时间回调N

方法集合

方法名类型描述使用示例
stopfunction结束播放player.stop()
openSoundString开启声音player.openSound()
closeSoundString关闭声音player.closeSound()
startSaveint开始录像player.startSave()
stopSaveint结束录像player.stopSave()
capturePicturefunction视频截图player.capturePicture()
fullScreenfunction全屏(自动适配移动端pc端全屏)player.fullScreen()
cancelFullScreenfunction取消全屏player.cancelFullScreen()
getOSDTimefunction获取播放时间回调player.getOSDTime()
startTalkfunction开始对讲player.startTalk()
stopTalkfunction结束对讲player.stopTalk()

使用示例

如果使用原生js,可参考demos => base-demo

如果使用react,可参考demos => react-demo

如果使用vue,可参考demos => vue-demo

0.3.0

2 years ago

0.2.7

3 years ago

0.2.8

3 years ago

0.2.5

3 years ago

0.2.4

3 years ago