该SDK主要用于在浏览器上播放臻识设备的视频,特别说明:
- SDK支持通过局域网和臻云播放设备视频流
- 局域网播放视频支持
flv
、mjpeg
两种格式 - 臻云播放视频只支持
flv
格式,不支持mjpeg
格式 - SDK兼容旧版臻云(https://www.vzicar.com)和新版臻云(https://open.vzicloud.com)两个平台
- 支持PC端浏览器Chrome、Edge,不支持IE浏览器
有两种方式可以引入vzsdk.js
:
直接下载vzsdk.min.js并用<script>
标签引入,vzsdk
会被注册为一个全局变量。
<script src="vzsdk.min.js"></script>
安装
npm install vzsdk.js
引入
import vzsdk from 'vzsdk.js'
引入vzsdk.js
后,调用createClient(config)
函数创建Client
对象。
let config = {
endpoint: 'https://open.vzicloud.com',
accessKey: {
id: 'AccessKey ID',
secret: 'AccessKey Secret'
}
}
let client = vzsdk.createClient(config)
字段 | 类型 | 是否必传 | 描述 |
---|---|---|---|
endpoint | string | 是 | 臻云极致地址,旧版臻云为 https://www.vzicar.com,新版臻云为 https://open.vzicloud.com |
accessKey.id | string | 是 | 臻云极致的AccessKey ID |
accessKey.secret | string | 是 | 臻云极致的AccessKey Secret |
要播放视频,必须使用Client
对象调用createPlayer(options)
创建Player
对象。
var player = client.createPlayer({
type: 'flv',
sn: 'sn',
dom: 'video',
mode:'wan', //wan或者lan
ip:'ip',
port:'port',
https:false,
username:'username',
password:'password',
})
// 播放视频
player.start()
// 停止播放
player.stop()
createPlayer
接口的参数说明:
字段 | 类型 | 是否必传 | 描述 |
---|---|---|---|
type | string | 是 | 视频格式(flv、mjpeg、auto) |
dom | string | 是 | 视频播放容器dom元素的id |
mode | string | 是 | 播放方式,局域网播放(lan)还是臻云远程播放(wan) |
sn | string | 否(mode为wan时必传) | 设备序列号 |
ip | string | 否(mode为lan时必传) | 设备局域网IP |
port | string | 否 | 设备的HTTP端口,默认为80 |
https | boolean | 否 | 设备是否启用HTTPS,默认为false |
username | string | 否(设备视频启用认证时必传) | 设备登陆名称,默认为admin |
password | string | 否(设备视频启用认证时必传) | 设备登陆密码,默认为admin |
<template>
<div>
<div id='video'></div>
<button @click="handleClickStart">start</button>
<button @click="handleClickStop">stop</button>
</div>
</template>
<script>
import vzsdk from 'vzsdk.js'
export default {
name: 'demo',
data () {
return {
player: ''
}
},
mounted () {
let config = {
accessKey: {
id: 'AccessKey ID',
secret: 'AccessKey Secret'
},
endpoint: 'https://open.vzicloud.com'
}
let client = vzsdk.createClient(config)
this.player = client.createPlayer({
type: 'flv',
sn: 'sn',
dom: 'video',
mode:'wan',//wan或者lan
ip:'ip',
port:'port',
https:false,
username:'username',
password:'password',
})
},
methods: {
handleClickStart () {
// 开始播放
this.player.start()
},
handleClickStop () {
// 停止播放
this.player.stop()
}
}
}
</script>