文档首页/ 行业视频管理服务 IVM/ API参考/ 云台控制/ 云台控制
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

云台控制

功能介绍

云台控制，支持好望、国标设备云台八向转动、点动，变焦，光圈，聚焦等能力

点动模式：只要调用一次云台移动相关命令（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），不需要调用STOP命令后会自动停止

转动模式：调用云台移动相关命令后（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），设备会一直不停转动，一直到发送STOP命令后才会停止

因华为SDC本身限制，云台控制指令短时间内无法接收过多，否则导致崩溃或连续转动，连续命令触发间隔应≥300ms

URI

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin

表1 路径参数

参数

是否必选

参数类型

描述

channel_id

是

String

通道ID：

好望设备：取值范围[0,999]

国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

device_id

是

String

设备ID：

好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken，从获取用户北向接口认证AccessToken中获取
表3 请求Body参数

参数

是否必选

参数类型

描述

direction

是

String

方向：枚举类型

枚举值：

  • LEFT 左转

  • UP 上转

  • RIGHT 右转

  • DOWN 下转

  • UPPER_LEFT 左上转动（设备10.0以上版本支持）
  • UPPER_RIGHT 右上转动（设备10.0以上版本支持）
  • LOWER_LEFT 左下转动（设备10.0以上版本支持）
  • LOWER_RIGHT 右下转动（设备10.0以上版本支持）
  • STOP 停止八向转动及变焦，其中停止变焦不支持直连摄像机（除E系列）
  • IN 变焦放大
  • OUT 变焦缩小
  • ZOOM_STOP 变焦停止，所有云台设备都支持
  • FOCUS_FAR 聚焦变远
  • FOCUS_NEAR 聚焦变近
  • AUTO_FOCUS 自动聚焦（设备10.0以上版本支持）
  • IRIS_OPEN 光圈变大
  • IRIS_CLOSE 光圈变小
  • FI_STOP 光圈和聚焦停止

control_lock

是

String

设备操作token不能为空（从获取云台控制权接口获取），token获取后只要进行云台控制操作就能够进行续签，不需要一直获取云台控制权

speed

否

Integer

速度，取值范围[1,10]，非必填，默认是10

mode

否

String

点动模式：默认方式，注：好望摄像机以华为协议接入的时候，变焦和聚焦时，需手动单击停止，否则会一直放大或者缩小。以onvif协议接入时，变焦和聚焦后则会自动停止

转动模式：枚举类型，非必填，国标设备只能使用转动模式，直连摄像机（除E系列）聚焦和变焦功能只能使用转动模式

枚举值：

  • POINT 点动模式
  • NON_POINT 转动模式

heartbeat_mode

否

String

心跳模式：枚举类型，默认为关，只有E系列摄像机有用，心跳模式能够帮助E系列摄像机一直维持转动

枚举值：

  • OPEN 开启心跳模式
  • CLOSE 关闭心跳模式

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

device_id

String

设备ID，设备唯一标识符

channel_id

String

通道ID

请求示例

开始点动转动

POST /v1/2562572829***/devices/952352LWXT***/channels/0/ptz/angle-spin

{
  "direction" : "UP",
  "control_lock" : "***"
}

响应示例

状态码： 200

OK

{
  "device_id" : "952352LWXT***",
  "channel_id" : "0"
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 云台控制

相关文档