# vap-sdk

> vap-sdk

Latest version **1.0.1** (published 2021-05-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install vap-sdk
pnpm add vap-sdk
yarn add vap-sdk
bun add vap-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-05-14 |
| First published | 2021-05-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 3.3 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | vzenith |
| Maintainers | vzenith |
| Keywords | vap-sdk |

## Links

- npm: https://www.npmjs.com/package/vap-sdk
- Repository: http://192.168.1.16/grp_icloud/vap-sdk-js
- npm.io page: https://npm.io/package/vap-sdk

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [build](https://npm.io/package/build.md) ^0.1.4
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [crypto](https://npm.io/package/crypto.md) ^1.0.1
- [details](https://npm.io/package/details.md) ^1.0.0
- [video.js](https://npm.io/package/video.js.md) ^7.10.2
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.2.2
- [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0

## Recent versions

- 1.0.1 (latest) — 2021-05-14
- 1.0.0 — 2021-05-11

## README

# vap-sdk开发说明

## 一、版本说明

**功能描述**：该版本支持vzflv的硬解和软件方式播放本地及远程视频

**兼容性**：支持pc端浏览器Chrome、Edge

## 安装vap-sdk

```js
// 使用 npm 安装
$ npm install vap-sdk
// 使用 yarn 安装
$ yarn add vap-sdk
```

## 示例

###  参数说明

| 参数             | 描述                                                                    | 是否必传 | 类型   |
| ---------------- | ---------------------------------------------------------------------- | -------- | ------ |
| accessKey.id     | 用户创建的AccessKey  ID                                                 | 是       | string |
| accessKey.secret | 用户创建的AccessKey  Secret                                             | 是       | string |
| endpoint         | 臻云极致地址，默认地址为：https://open.vzicloud.com                       | 否       | string |
| sn               | 设备sn编码，有ip则播放本地视频，没有ip有sn则播放远程视频                    | 是       | string |
| type             | 视频格式（vzflv）                                                        | 是       | string |
| dom              | 播放容器，dom元素的id                                                    | 是       | string |
| ip               | 设备ip，有ip则播放本地视频，没有ip有sn则播放远程视频                        | 是       | string |
| decodeType       | 解码方式（auto、soft）单个视频推荐soft软解，多个视频推荐auto硬解，默认：auto | 是       | string |

**引入vap-sdk**

```javascript
import vapjs from 'vap-sdk'
```

**初始化** 

```js
let config = {
	accessKey: {
		id: 'AccessKey  ID',
		secret: 'AccessKey  Secret'
	},
	endpoint: 'https://open.vzicloud.com'
}

vapjs.init(config)
```

**播放/停止**

```javascript
// 创建播放实例
let player = vapjs.createPlayer({
	type: 'vzflv',
	sn: 'sn',
	dom: 'video'
})
// 播放
player.start()
// 停止
player.stop()
```

#### 代码示例

```js
<template>
  <div>
    <div id='video'></div>
    <button @click="handleClickStart">start</button>
    <button @click="handleClickStop">stop</button>
  </div>
</template>
<script>
import vapjs from 'vap-sdk'
export default {
  name: 'video',
  data () {
    return {
      player: ''
    }
  },
  mounted () {
    let config = {
      accessKey: {
        id: 'AccessKey ID',
        secret: 'AccessKey Secret'
      },
      endpoint: 'https://open.vzicloud.com'
    }
    vapjs.init(config)
    this.player = vapjs.createPlayer({
      type: 'vzflv',
      sn: 'sn',
      dom: 'video'
    })
    //页面销毁时请务必调用stop停止播放
    this.$once('hook:beforeDestroy', () => {
      if (this.player) {
        this.player.stop()
      }
    })
  },
  methods: {
    handleClickStart () {
      // 开始播放
      this.player.start()
    },
    handleClickStop () {
      // 停止播放
      this.player.stop()
    }
  }
}
</script>
```

---
_Source: https://npm.io/package/vap-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._