云台控制--慢直播-火山引擎

文档中心

立即注册

导航

云台控制

最近更新时间：2025.02.14 16:29:36首次发布时间：2025.02.14 16:29:36

发送控制指令和参数，进行云台控制。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CloudControl&Version=2023-10-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query Parameters

参数	类型	是否必选	示例值	描述
Action	String	是	`CloudControl`	接口名称。当前 API 的名称为 `CloudControl`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。

Body

参数	类型	是否必选	示例值	描述
StreamID	String	是	`23355851-2d31-461c-9e44-968a0afb72f2`	设备通道流 ID，可通过调用 GetDevice 接口获取
Cmd	String	是	`left`	控制行为，参考以下控制行为和取值范围列表
Para	Integer	是	`2`	参数取值范围，参考以下控制行为和取值范围列表
Action	String	是	`PTZControl`	操控指令类型，可选枚举值包括： PTZControl FiControl PresetControl

控制行为和取值范围

Action（操控指令）	Cmd（控制行为）	Para（取值范围）
PTZControl	stop（停止）	无
	right（向右）	移动速度，取值范围 [0, 255]
	left（向左）	移动速度，取值范围 [0, 255]
	down（向下）	移动速度，取值范围 [0, 255]
	up（向上）	移动速度，取值范围 [0, 255]
	rightup（右上）	移动速度，取值范围 [0, 255]
	rightdown（右下）	移动速度，取值范围 [0, 255]
	leftup（左上）	移动速度，取值范围 [0, 255]
	leftdown（左下）	移动速度，取值范围 [0, 255]
	zoomin（缩小）	缩放速度，取值范围 [0, 15]
	zoomout（放大）	缩放速度，取值范围 [0, 15]
FiControl	stop（停止）	无
	focusfar（对焦）	取值范围 [0, 0~0xFF]
	focusnear（对焦）	取值范围 [0, 0~0xFF]
	irisin（光圈）	取值范围 [0, 0~0xFF]
	irisout（光圈）	取值范围 [0, 0~0xFF]
PresetControl	set（设置）	设置预置位，取值范围 [0x01, 0xFF]
	goto（指定预置位）	预置位跳转，取值范围 [0x01, 0xFF]
	remove（删除）	预置位删除，取值范围 [0x01, 0xFF]

请求示例

POST https://open.volcengineapi.com?Action=CloudControl&Version=2023-10-01
{
  "StreamID": "xxxx-yyyy-zzzzz-bbbb",
  "Cmd": "left",
  "Para": 2,
  "Action": "PTZControl"
}

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081549400102121450322701D9BA",
        "Action": "CloudControl",
        "Version": "2023-10-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。