1.0.5 • Published 1 year ago

soc-hik-sdk v1.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

soc-ivs-sdk

介绍

基于浏览器客户端web播放器,插件安装在客户端pc上,插件直接接入华为IVS视屏云支持ivs3000,ivs3800,ivs1800.最大支持25路辅码流实时画面同时播放。同时支持云台控制、本地抓拍、云台抓拍、本地录像、设备收藏、窗格切换、全屏、录像查询、设备查询、录像回放支持快进、快退、倍速播放、暂停、恢复

软件架构

web js 插件以typescript 编写支持npm安装引入、cdn方式引入,不限于技术栈如vuejs、react、angularjs目前市面上主流MVVM框架结构

基于浏览器的客户端插件,exe形式进行安装。插件需要本地一些操作权限,为了更好使用该插件,安装时请以管理员身份运行安装。

安装

npm命令行,

npm install soc-ivs-sdk --save
or
yarn add soc-ivs-sdk --save

使用说明

入口文件样式引入

import 'soc-ivs-sdk/dist/style/index.css'

vue引入示例

<template>
  <div id="playerBox">
  </div>
</template>
<script>
import SocWebPlayerSDK, {
  SwpEvents,
  SwpImage,
  SwpPlaySteamType,
  SwpWindows
} from 'soc-ivs-sdk';
 export default {
  name: "Home",
  components: {},
  data() {
    return {
      player:null
    };
  },
   init() {
     this.player = new SocWebPlayerSDK({
      ip: '10.xx.xx.xxx',
      userName: 'username',
      password: 'password',
      port: 9900,
      target: document.querySelector('#playerBox') as HTMLElement,
      isIVS: true,
      wndBackgroundColor: '#202945',
      splitBorderColor: '#394567',
      primaryColor: '#407AEE',
      borderColor: '#2A3451',
      fontColor: '#8696b5',
      quality: 90,
      isFooter: true,
      frameRate: 120,
      toolBackColor: '#1A2137',
      backgroundColor: [32, 41, 69, 1],
      windows: SwpWindows.SIX,
      imageStreamFormat: SwpImage.JPEG,
      wndInfo: `<img src='/videologo.png' width="80" />`,
      isGzip: false,
      onEvents: (data: SwpEvents) => {
        console.info(data);
      }
    });
   }
};
</script>

SocWebPlayerSDK实例

名称构造参数默认值说明
SocWebPlayerSDKSwpConfigure初始化的基础参数信息
SwpConfigure 属性
名称类型默认值说明
ipstring视频云平台ip地址
userNamestring视频云平台用户名
passwordstring视频云平台密码
portnumber9900视频云平台端口号
windowsSwpWindows默认9窗格默认窗口数,支持1,4,6,9,12,16,25
targetHTMLElement插件承载的元素容器
qualitynumber100画面的质量数值越高质量越好,最大值为100,数值越低性能越好,图片质量较差。
isFooterbooleantrue是否显示底部控制栏
imageStreamFormatSwpImagejpeg帧画面格式,png和jpeg
serverUrlstring默认无播放器服务端地址,如设置该值,当前播放器为服务端转码播放。默认是客户端转码插件安装转码播放。
frameRatenumber120每秒推送的帧数最大25,数值越大性能要求越高,画面细节更多。
splitBorderColorstring窗口分割线颜色
backgroundColornumber[]转码客户端背景色,rgba如0,0,0,1黑色不透明
primaryColorstring播放器主题色
fontColorstring播放器字体颜色
toolBackColorstring播放器工具栏颜色
borderColorstring播放器边框颜色
timeOutnumber播放器请求超时时间
snapshotPathstringc:\soc\snapshot抓拍图片存储路径
videoPathstringc:\soc\video本地录像存储路径
downloadPathstringc:\soc\download录像下载存储路径
isGzipbooleanfalse是否开启gzip压缩
wndInfostring | HTMLElement空闲窗口显示内容
onErrorfunction(err: ErrorMessage) => void异常上报事件回调
onEventsfunction(data: SwpEvents) => void;播放器事件上报回调函数
onWindowActiveEventfunction(data: any) => void窗口激活事件

methods

名称参数类型默认值返回值说明
playSwpPlayOptionPromise实时画面/录像回放
batchPlay(SwpPlayOption[],callback)void批量播放实况/录像
changeWindowSwpWindowsvoid设置窗口数
closePlayerWindownumbervoid关闭指定窗口
clearPlayervoid清空所有窗口播放
queryVideoRecordSwpQueryDeviceOptionsvoid录像片段查询
destroyvoid播放器销毁
SwpWindows 枚举
枚举名称类型枚举说明
ONEnumber1窗格数
FOURnumber4窗格数
SIXnumber6窗格数
NINEnumber9窗格数
TWELVEnumber12窗格数
SIXTEENnumber16窗格数
TWENTY_FIVEnumber25窗格数
SwpPlayOption
名称类型默认值说明
cameraCodestring摄像机编码
cameraNamestring摄像机名称
streamTypeSwpPlaySteamType2码流类型
startTimestring录像回放必传开始时间utc(YYYYMMDDHHmmss)
endTimestring录像回放必传结束时间utc(YYYYMMDDHHmmss)
wndnumber默认不传入,自动获取空闲窗口指定窗口
playTimenumber默认不传入,指定距离开始时间的秒数进行播放播放时间

注意:录像存储的时间节点为utc(零时区的时间)与当前用户所在时区有时差,根据当前时区去换算成零时区的时间节点传入。

SwpQueryDeviceOptions
名称类型默认值说明
cameraDataCameraData[];摄像机信息支持多个
startTimenumber开始时间
endTimenumber结束时间
recordTypestring1告警录像 2计划录像 4 手动录像录像类型 如查告警录像和计划录像 1+2 则传入3
callBackfunction(e: CameraRecordData) => void;查询结果回调函数

版本更新

版本发行

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago