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

文档中心

立即注册

导航

云台控制

最近更新时间：2023.01.09 17:19:04首次发布时间：2023.01.09 17:19:04

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

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CloudControl
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SipID	Query	String	否	SIP 服务器 ID

Body 参数

字段	类型	必填	说明
DeviceID	String	是	设备国标 ID，可通过调用 ListDevices 接口获取
ChannelID	String	是	通道 ID，可通过调用 ListStreams 接口获取
Cmd	String	是	控制行为，参考以下控制行为和取值范围列表
Para	uint8	是	参数取值范围，参考以下控制行为和取值范围列表
Action	String	是	操控指令类型，可选枚举值包括： 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]

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

示例

请求示例

POST https://open.volcengineapi.com?Action=CloudControl
&Version=2021-01-01
&SipID=340200000020xxxxxxxx
&<公共请求参数>
{
    "DeviceID":"340200859911xxxxxxxx",
    "ChannelID":"110000005813xxxxxxxx",
    "Cmd": "left",
    "Para": 2,
    "Action": "PTZControl"
}

返回示例

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