最近更新时间:2023.09.25 21:09:58
首次发布时间:2022.04.19 20:40:35
根据域名空间下的应用所关联的录制模版配置更新修改,可调整格式和存储目录等。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版更新录制列表接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateRecordPresetV2 | 接口名称。当前 API 的名称为 UpdateRecordPresetV2 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间名称 |
App | String | 是 | live | 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
Stream | String | 否 | example_stream | 流名称 |
Preset | String | 是 | liverecord | 模版名称,由 1 到 50 位数字、字母、下划线及"-"和"."组成。可调用 ListVhostRecordPresetV2 接口,查询模版名称 |
RecordPresetConfig | Object of RecordPresetConfig | 否 | - | 录制模板详细配置 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
TranscodeRecord | Integer | 否 |
| 转码流录制,默认值为 0。支持的取值如下所示。
说明
|
OriginRecord | Integer | 否 |
| 源流录制,默认值为 0。支持的取值如下所示。
说明
|
SliceDuration | Integer | 否 | 5 | 录制 HLS 格式时,单个 TS 切片时长,单位为 s,默认值为 5,取值范围为 [5,30] |
FlvParam | Object of RecordParam | 否 |
| FLV 录制参数,开启 FLV 录制时设置 说明
|
HlsParam | Object of RecordParam | 否 |
| HLS 录制参数,开启 HLS 录制时设置 说明
|
Mp4Param | Object of RecordParam | 否 |
| MP4 录制参数,开启 MP4 录制时设置 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Enable | Boolean | 否 |
| 当前格式的录制是否开启,默认 false,取值及含义如下所示。
|
Duration | Integer | 否 | 7200 | 断流录制单文件录制时长,单位为 s,默认值为 7200,取值范围为 [300,86400] |
RealtimeRecordDuration | Integer | 否 | 7200 | 实时录制文件时长,单位为 s,取值范围为 [300,21600] |
Splice | Integer | 否 |
| 断流拼接间隔时长,对实时录制无效,单位为 s,默认值为 0。支持的取值如下所示。
|
TOSParam | Object of TOSParam | 否 |
| TOS 存储相关配置 说明
|
VODParam | Object of VODParam | 否 |
| VOD 存储相关配置 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Enable | Boolean | 否 |
| 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
|
Bucket | String | 否 |
| TOS 存储空间,一般使用 CDN 对应的 Bucket 说明 如果 TOSParam 中的 Enable 取值为 true,则 Bucket 必填。 |
StorageDir | String | 否 | / | TOS 存储目录,默认为空 |
ExactObject | String | 否 | record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} | 录制文件的存储位置。存储路径为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Enable | Boolean | 否 |
| 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
|
VodNamespace | String | 否 |
| 视频点播(VOD)空间名称。可登录视频点播控制台查询 说明 如果 VODParam 中的 Enable 取值为 true,则 VodNamespace 必填。 |
WorkflowID | String | 否 | 25524a2d*********891d7daf4b9 | 工作流模版 ID,对于存储在点播的录制文件,会使用该工作流模版对视频进行处理。可登录视频点播控制台获取 ID |
ClassificationID | String | 否 | 23**41 | 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的 ListVideoClassifications 接口查询视频分类 ID 等信息。 |
StorageClass | Integer | 否 |
| 直播录制文件存储到点播时的存储类型。默认值为 1,支持的取值及含义如下所示。
|
ExactObject | String | 否 |
| 录制文件的存储位置,最大长度为 200 个字符。默认的存储位置为
|
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=UpdateRecordPresetV2&Version=2020-08-01 { "Vhost":"push.example.com", "App":"live", "Preset":"liverecord", "RecordPresetConfig": { "OriginRecord": 1, "HlsParam": { "Enable": "true", "RealtimeRecordDuration": 7200, "Splice": 0 }, "TOSParam": { "Enable": true, "Bucket": "live-test-tos-example", "StorageDir": "", "RecordObject": "record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}" }, } }
{ "ResponseMetadata": { "RequestId": "20220726*******************051B513A", "Action": "UpdateRecordPresetV2", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" } }
访问公共错误码获取详细信息。