设置巡航路径V3--慢直播-火山引擎

文档中心

立即注册

导航

设置巡航路径V3

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

设置巡航路径（创建或修改巡航路径）。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
StreamID	String	是	`23355851-2d31-461c-9e44-968a0afb72f2`	视频流 ID，可通过调用 ListStreams 接口获取
TrackID	Float	是	`1`	巡航组编号，取值范围：[1, 255]
TrackList	Object of TrackList	是		巡航路径预置位列表, 最多可添加255个预置位，参考以下 TrackList 结构说明
Speed	Float	否	`2`	巡航速度，取值范围：[1, 4095]
StaySeconds	Float	否	`5`	预置位停留时间，单位：秒，[1，4095]

TrackList

参数	类型	是否必选	示例值	描述
PresetID	Float	是	`1`	预置位编号
PresetName	String	是	`预置位1`	预置位名称

返回参数

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

请求示例

POST https://open.volcengineapi.com?Action=SetCruiseTrack&Version=2023-10-01
{
    "DeviceNSID": "340200379911xxxxxxxx",
    "ChannelID": "340200000013xxxxxxxx",
    "TrackID": 1,
    "TrackList": [
        {
            "PresetID": 1,
            "PresetName": "预置位1"
        }
    ],
    "Speed": 200
}

返回示例

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

错误码

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