编辑录制模板--慢直播-火山引擎

文档中心

立即注册

导航

编辑录制模板

最近更新时间：2022.12.29 10:18:38首次发布时间：2021.11.25 17:22:10

编辑指定录制模板的信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpdateRecordTemplate
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
TemplateID	Query	String	是	模板 ID	可通过调用 ListRecordTemplates 接口获取

Body 参数

字段	类型	必填	说明
TemplateName	String	否	模板名称
Record	Record	否	录制配置，参考以下录制配置结构说明

录制配置结构说明

字段	类型	必填	说明
RecordDuration	Integer	是	单个视频文件录制时长，单位毫秒
Type	String	是	录制方式： realtime（实时录制）
Format	String	是	视频存储格式： mp4 hls
TTL	Array of objects	是	录制文件存储周期，参考以下存储周期结构说明

存储周期结构说明

字段	类型	必填	说明
Forever	Boolean	是	指定存储周期（true：永久保存；false：自定义）
Days	Integer	否	自定义存储时长，单位天

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	编辑成功的录制模板 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateRecordTemplate
&Version=2021-01-01
&TemplateID=3694598f-6b59-4c3d-9ea4-13dd8e5bbde3
&<公共请求参数>
{
    "TemplateName": "record-template-02",
    "Record": {
        "RecordDuration": 300000,
        "Type": "realtime",
        "Format": "mp4",
        "TTL": {
            "Forever": false,
            "Days": 7
        }
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112082014000102121680721B0025BF",
        "Action": "UpdateRecordTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "3694598f-6b59-4c3d-9ea4-13dd8e5bbde3"
    }
}