You need to enable JavaScript to run this app.
导航

编辑录制模板

最近更新时间2022.12.29 10:18:38

首次发布时间2021.11.25 17:22:10

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

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称UpdateRecordTemplate
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
TemplateIDQueryString模板 ID可通过调用 ListRecordTemplates 接口获取

Body 参数

字段
类型
必填
说明
TemplateNameString模板名称
RecordRecord录制配置,参考以下 录制配置结构说明

录制配置结构说明

字段
类型
必填
说明
RecordDurationInteger单个视频文件录制时长,单位毫秒

Type

String

录制方式:

  • realtime(实时录制)

Format

String

视频存储格式:

  • mp4
  • hls
TTLArray of objects录制文件存储周期,参考以下 存储周期结构说明

存储周期结构说明

字段
类型
必填
说明
ForeverBoolean指定存储周期(true:永久保存;false:自定义)
DaysInteger自定义存储时长,单位天

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
IDString编辑成功的录制模板 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"
    }
}