You need to enable JavaScript to run this app.
导航
通道巡航控制
最近更新时间:2023.07.20 09:51:03首次发布时间:2023.01.09 17:19:04

通道巡航控制。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称CruiseControl
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

Body 参数

字段
类型
必填
说明
DeviceNSIDString设备国标 ID,可通过调用 ListDevices 接口获取
ChannelIDString设备通道 ID,可通过调用 ListStreams 接口获取

Action

String

巡航指令,可选枚举值包括:

  • Add(巡航组加入一个预置位,所需参数:TrackID,PresetID)

  • Remove(巡航组删除一个预置位,所需参数:TrackID,PresetID;当 PresetID=0 时,表示删除整个巡航组)

  • SetSpeed(设置巡航速度,所需参数:TrackID,Speed)

  • SetStay(设置巡航停留时间,单位:秒,所需参数:TrackID,StaySeconds)

  • Start(开始巡航,所需参数:TrackID)

  • Stop(停止巡航,所需参数:TrackID)

TrackIDNumber巡航组编号,取值范围:[1, 255]
PresetIDNumber预置位编号,取值范围:[0, 255],适用于 AddRemove 指令;当 Action=RemovePresetID=0 时, 表示删除 TrackID 对应的整条巡航路径
SpeedNumber巡航速度,取值范围:[1, 4095],适用于 SetSpeed 指令
StaySecondsNumber预置位停留时间,单位:秒,[1~4095],取值范围:[1, 4095],适用于 SetStay 指令

返回结果

返回参数说明

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

示例

请求示例

POST https://open.volcengineapi.com?Action=CruiseControl
&Version=2021-01-01
&<公共请求参数>
{
    "DeviceNSID": "340200379911xxxxxxxx",
    "ChannelID": "340200000013xxxxxxxx",
    "Action": "SetSpeed",
    "TrackID": 1,
    "Speed": 200
}

返回示例

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