# hk

**Repository Path**: ahcolyn/hk

## Basic Information

- **Project Name**: hk
- **Description**: 一款快速开发海康WEB视频的插件框架
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2021-08-13
- **Last Updated**: 2022-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

hk.js
无门槛 零配置 快速上手

基于海康威视 安防平台 视频WEB插件 V1.5.1

在线文档：https://www.wolai.com/sG2cFf2ruAVUG5tMgVaAw?theme=light

有问题咨询QQ:2339139097

# Demo

1. 安装编译工具  npm install -g browserify

2. 打包源代码     browserify ./src/main.js -o ./test/hk.js 

3. 运行到浏览器  test/index.html



查看文档之前 请先下载海康官方文档：[https://open.hikvision.com/download/5c67f1e2f05948198c909700?type=10](https://open.hikvision.com/download/5c67f1e2f05948198c909700?type=10) 

hk.js基于海康视频WEB插件 V1.5.1 


快速创建一个播放器


```
hk({
    id:"play",
    info:{
        appkey: "平台提供的 APPKey",
        ip: "平台（Nginx）IP 地址",
        port: 平台端口,
        secret: "平台提供的 APPSecret",
        layout:"1x1"
    },
    callback(event){
        console.log(event)
    }
}).then(res=>{
    res.play(监控点编号)
})
```

选项
- id
标签元素ID

- info
打开海康文档 3.12.2初始化 参数于此一致

| 名称              | 类型     | 是否必填 | 描述                  |
|-----------------|--------|------|---------------------|
| appkey          | string | 否    | 平台提供的 APPKey        |
| secret          | string | 否    | 平台提供的 APPSecret     |
| ip              | string | 否    | 平台（Nginx）IP 地址      |
| enableHTTPS     |  int   | 否    | 是否启用 HTTPS 协议与平 台交互 |
| port            |  int   | 否    | 平台端口                |
| playMode        |  int   | 否    | 初始播放模式              |
| encryptedFields | string | 否    | 加密字段                |
| snapDir         | string | 否    | 抓图存储路径              |
| layout          | string | 否    | playMode 指定模式的布局    |
| videoDir        | string | 否    | 紧急录像或录像剪辑存储路径    |
| showToolbar     | int    | 否    | 是否显示工具栏    |
| showSmart       | int    | 否    | 是否显示智能信息    |
| buttonIDs       | string | 否    | 工具条按钮字符串，多个之间以“,”分割    |
| reconnectTimes  | int    | 否    | 重连次数    |
| reconnectDuration|int    | 否    | 重连间隔时间    |
| language        | string | 否    | 配置多语言模式    |
| toolBarButtonIDs| string | 否    | 工具栏按钮字符串，多个之间以“,”分割    |

## callback
设置回调方法
##### port
##### buttonIDs 

# 方法
## play
> 播放监控点
##### 参数: code 或者 [{config}] 
##### 返回：Promise


```
//单个监控点播放
control.play('监控点编号')
//多个监控点播放
control.play([
  {
    cameraIndexCode:"",
    wndId:"",
    authUuid:"",
    streamMode:"",
    transMode :"",
    gpuMode:"",
    wndId:"",
    ezvizDirect:""
  }
])

//参数详情打开海康文档
//找到文档 3.12.13 根据监控点编号批量视频预览 参数于obj.argument.list 下一致 
```
##  playBack
> 回放监控点
##### 参数:  [{config}] 
##### 返回：Promise

```
//多个监控点播放
control.playBack([
  {
    cameraIndexCode:"",
    startTimeStamp:""
    endTimeStamp:""
  }
])

//参数详情打开海康文档
//找到文档 3.12.14 根据监控点编号批量录像回放 参数于obj.argument.list 下一致 
```

## stop
##### 停止播放
##### 参数: [{wndId}]

## setLayout
##### 设置布局
> 可选值有“1x1”、“2x2”、
> “3x3”、“4x4”、“5x5”、“1x2”、“1+2”、
> “1+5”、“1+7”、“1+8”、“1+9”、“1+12”、
> “1+16”、“4+9”、“1+1+12”、“3+4”、
> “1x4”、“4x6”

##  getLayout
##### 获取布局

##  show
##### 显示播放器


## hide
##### 隐藏播放器


##  destroy
##### 销毁播放器


##  adaptive
##### 自适应


##  setAuthInfo
##### 设置接口认证信息参数

```
control.setAuthInfo([
  {
    appkey:"",
    secret:"",
    ...
  }
])
//参数详情打开海康文档
//找到文档 3.12.16 设置接口认证信息参数 参数于obj.argument.list 下一致 
```