1.0.5 • Published 12 months ago
y-video v1.0.5
y-video 说明
2024-7-30 增加海康插件组件封装
海康插件组件
- HikPluginPlayer 使用
import {HikPluginPlayer, PlatformProp} from 'y-video'
const player = () => {
const [platformInfo, setPlatformInfo] = useState<PlatformProp>({
host: '192.168.1.1',
port: 1443,
appkey: '23232332',
appsecret: 'dcskndsn2323sdasa',
layout: '1x1'
})
const [playProps, setPlayProps] = useState<PlayArgumentProps>([])
return <div style={{'width': '600px', 'height': '400px'}}>
<HikPluginPlayer platform={platformInfo} onInit={(player) => {
player.showWnd() // 在初始化的过程中进行了隐藏操作,需要先调用showWnd方法显示窗口
player.play(playProps) // 视频预览
}} />
</div>
}
- HikPluginPlayer 海康插件组件 组件参数:
参数名 | 参数说明 | 类型 | 默认值 |
---|---|---|---|
platform | 海康平台基本信息 | Object | 具体信息查看PlatformProp |
onInit | 初始化成功回调 | Function | (player: HikPlugin) => void |
onError | 失败回调 | Function | (error: callbackProp) => void |
downloadUrl | 插件下载地址, 可选 | string | '' |
showCallback | 是否展示海康插件的回调信息 | boolean | false |
PlatformProp 类型:
参数名 | 参数说明 | 类型 | 默认值 |
---|---|---|---|
appkey | 海康平台appKey | string | '' |
appsecret | 海康平台appSecret | string | '' |
layout | 视频预览布局,可选 | string | '1x1' |
host | 海康平台ip | string | '' |
port | 海康平台端口 | string | '' |
海康插件实例方法:
|方法名 | 参数说明 | 描述 | 默认值 |
---|---|---|---|
play | PlayArgumentProps,播放参数对象 | 海康插件播放实时预览 | - |
getPlayer | - | 获取播放实例 | - |
getInitOptions | - | 获取播放参数 | - |
resizeWnd | width: number(宽),height: number(高), callback(回调) | 调整插件窗口大小 | - |
hideWnd | callback: (info: callbackProp) => void 回调参数 | 隐藏窗口 | - |
showWnd | callback: (info: callbackProp) => void 回调参数 | 显示窗口 | - |
destroyWnd | callback: (info: callbackProp) => void 回调参数 | 销毁插件 | - |
大华插件组件
- DhPluginPlayer 使用
import {DhPluginPlayer, PlatformProps, DhPlayArgumentProps} from 'y-video'
const player = () => {
const [platformInfo] = useState<PlatformProps>({
host: '192.168.1.1',
port: '443',
username: 'system',
password: '123456',
division: 1
})
const [playProps] = useState<<DhPlayArgumentProps>[]>([{
channelId: '100010$1$0$6',
channelName: '活发围墙周界',
snum: 0,
streamType: 1,
deviceType: 6,
cameraType: '2',
capability: '0000000000000000100000000000000',
decodeMode: 0
}])
return <div style={{'width': '600px', 'height': '400px'}}>
<HikPluginPlayer platform={platformInfo} onInit={(player) => {
player.showWnd() // 在初始化的过程中进行了隐藏操作,需要先调用showWnd方法显示窗口
player.play(playProps) // 视频预览
}} />
</div>
}
- DhPluginPlayer插件参数 组件参数:
参数名 | 参数说明 | 类型 | 默认值 |
---|---|---|---|
platform | 大华平台基本信息(必填) | Object | 具体信息查看PlatformProps |
onInit | 初始化成功回调(必填) | Function | (player: DhPlugin) => void |
onError | 失败回调 | Function | (error: callbackProp) => void |
downloadUrl | 插件下载地址, 可选 | string | '' |
onChangeDivision | 插件布局变化回调 | Function | (division: number) => void |
PlatformProps参数:
参数名 | 参数说明 | 类型 | 默认值 |
---|---|---|---|
host | 大华平台ip(必填) | string | '' |
port | 大华平台端口(必填) | string | '' |
username | 大华平台用户名(必填) | string | '' |
password | 大华平台密码(必填) | string | '' |
division | 大华平台布局,可选 | number | 1 |
DhPlayArgumentProps预览参数:
参数名 | 参数说明 | 类型 | 默认值 |
---|---|---|---|
channelId | 大华平台通道号(必填) | string | '' |
channelName | 大华平台通道 | string | '' |
snum | 窗口序号 | number | 0 |
streamType | 主子码流标识 | number | 1 |
deviceType | 设备类型 | number | '' |
cameraType | 摄像机类型 | string | '' |
capability | 能力集 | string | '' |
decodeMode | 解码模式 | number | 2 |
插件实例方法:
方法名 | 参数说明 |
---|---|
play(playProps: DhPlayArgumentProps[]) | 播放参数 |
getPlayer() | 获取播放实例 |
getInitOptions() | 获取播放参数 |
init(callback: (player: callbackProp) => void) | 初始化方法 |
hideWnd() | 隐藏窗口 |
showWnd() | 显示窗口 |
destroyWnd() | 销毁窗口 |
setWndControlBtn(btns, snum) | 设置窗口控制按钮 |
更新说明
1.0.0 最初版,rollup构建 1.0.1 增加海康插件封装 1.0.2 修复插件无法显示问题 1.0.3 增加海康插件参数调整及文档说明 1.0.4 增加大华插件封装 1.0.5 修复大华插件播放参数报错问题