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

文档中心

立即注册

导航

设置巡航路径

最近更新时间：2023.07.20 09:51:03首次发布时间：2023.07.20 09:51:03

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

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	SetCruiseTrack
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
DeviceNSID	String	是	设备国标 ID，可通过调用 ListDevices 接口获取
ChannelID	String	是	设备通道 ID，可通过调用 ListStreams 接口获取
TrackID	Number	是	巡航组编号，取值范围：[1, 255]
TrackList	Array of objects	是	巡航路径预置位列表, 最多可添加255个预置位，参考以下 TrackList 结构说明
Speed	Number	否	巡航速度，取值范围：[1, 4095]
StaySeconds	Number	否	预置位停留时间，单位：秒，[1，4095]

TrackList 结构说明

字段	类型	必填	说明
PresetID	Number	是	预置位编号，取值范围：[0, 255]
PresetName	String	否	预置位名称

返回结果

返回参数说明

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

示例

请求示例

POST https://open.volcengineapi.com?Action=SetCruiseTrack
&Version=2021-01-01
&<公共请求参数>
{
    "DeviceNSID": "340200379911xxxxxxxx",
    "ChannelID": "340200000013xxxxxxxx",
    "TrackID": 1,
    "TrackList": [
        {
            "PresetID": 1,
            "PresetName": "预置位1"
        }
    ],
    "Speed": 200
}

返回示例

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