接口功能介绍
本接口用于开启镜头转动,如水平、垂直、缩放(变焦)等。
接口约束
- 需要支持云台的gb28181设备或ehome设备,保持设备在线。
2. 请求参数Pan,Tilt和Zoom至少填写一个,请求参数Pan和Tilt可同时调用,请求参数Zoom需单独调用,Pan和Tilt参数置为0或不填。
请求参数说明:
String类型的参数,传""等同于不传。
Integer类型的参数,传0等同于不传。
Boolean类型的参数,传false等同于不传。
URI
PUT /v2/devices/*/ptz/startMove
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
DeviceId | 是 | String | 设备ID。 | 752657499261403136 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Pan | 否 | Integer | 水平转动速度参数,正值表示向右水平转动。取值:-255~255。 | 255 | |
Tilt | 否 | Integer | 垂直转动速度参数,正值表示向上垂直转动。取值:-255~255。 | 255 | |
Zoom | 否 | Integer | 缩放(变焦)速度参数,正值表示放大。取值:-15~15。 | 15 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码。 | 200 | |
error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
message | String | 响应信息。 | 请求成功 | |
requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
DeviceId | String | 设备ID。 | 752657499261403136 | |
RequestId | String | 请求ID。 | 03358728f6f04098921db63c06afee25 |
枚举参数
无
请求示例
请求url
PUT '/v2/devices/752657499261403136/ptz/startMove'
请求头header
无
请求体body
{"Pan": 85}
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "03358728f6f04098921db63c06afee25","returnObj": {"DeviceId": "752657499261403136","RequestId": "03358728f6f04098921db63c06afee25"}}
状态码
请参考 状态码
错误码
请参考 错误码