通道巡航控制V3--慢直播-火山引擎

文档中心

立即注册

导航

通道巡航控制V3

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

通道巡航控制。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Action	String	是	`SetSpeed`	巡航指令，可选枚举值包括： Add（巡航组加入一个预置位，所需参数：TrackID，PresetID） Remove（巡航组删除一个预置位，所需参数：TrackID，PresetID；当 `PresetID=0` 时，表示删除整个巡航组） SetSpeed（设置巡航速度，所需参数：TrackID，Speed） SetStay（设置巡航停留时间，单位：秒，所需参数：TrackID，StaySeconds） Start（开始巡航，所需参数：TrackID） Stop（停止巡航，所需参数：TrackID）
PresetID	Integer	否	`3`	预置位编号，取值范围：[0, 255]，适用于 `Add` 和 `Remove` 指令；当 `Action=Remove` 且 `PresetID=0` 时, 表示删除 `TrackID` 对应的整条巡航路径
Speed	Float	否	`200`	巡航速度，取值范围：[1, 4095]，适用于 `SetSpeed` 指令
StaySeconds	Float	否	`4`	预置位停留时间，单位：秒，[1~4095]，取值范围：[1, 4095]，适用于 `SetStay` 指令

返回参数

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

请求示例

POST https://open.volcengineapi.com?Action=CruiseControl&Version=2023-10-01
{
  "Action": "SetSpeed",
  "PresetID": 3,
  "Speed": 200,
  "StaySeconds": 4
}

返回示例

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

错误码

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