開啟鏡頭調節
更新時間 2024-09-11 16:11:31
最近更新時間: 2024-09-11 16:11:31
分享文章
接口功能介紹
本接口用于調節鏡頭聚焦或光圈。
接口約束
- 需要支持云臺的gb28181設備或ehome設備，保持設備在線。
2. 請求參數Focus和Iris至少填寫一個，且不能同時填寫。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
PUT /v2/devices/*/ptz/startAdjust
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 設備ID。 | 752657499261403136 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Focus | 否 | Integer | 聚焦速度參數，正值表示焦距變遠。取值: -255~255。 | 255 | |
| Iris | 否 | Integer | 光圈速度參數，正值表示光圈放大。取值: -255~255。 | 255 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| DeviceId | String | 設備ID。 | 752657499261403136 | |
| RequestId | String | 請求ID。 | 20be6a0c4b0f42a288fb563c561d0a4c |
枚舉參數
無
請求示例
請求url
PUT '/v2/devices/752657499261403136/ptz/startAdjust'
請求頭header
無
請求體body
{"Focus": 255}
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "20be6a0c4b0f42a288fb563c561d0a4c","returnObj": {"DeviceId": "752657499261403136","RequestId": "20be6a0c4b0f42a288fb563c561d0a4c"}}
狀態碼
請參考
錯誤碼
請參考
