You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

添加录制配置

最近更新时间：2023.11.13 13:47:54

首次发布时间：2023.09.25 14:34:04

我的收藏

为指定域名空间下的 App 添加录制模版。

说明

暂不支持对同一个域名下的同一个 App 绑定多个录制模板，如果多次创建录制模板，会将历史创建的录制模板删除，重新创建新的模板并绑定。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=CreateRecordPresetV2&Version=2023-01-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是CreateRecordPresetV2接口名称。当前 API 的名称为 CreateRecordPresetV2。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称
AppString是live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamString否stream001流名称
RecordPresetConfigObject of RecordPresetConfig是-录制模板详细配置

RecordPresetConfig

参数类型是否必选示例值描述

TranscodeRecord

Integer

否

1

转码流录制，默认值为 0。支持的取值如下所示。

  • 0：不录制；
  • 1：录制。
  • 2：全部录制，如果录制转码流后缀列表（TranscodeSuffixList）为空则全部录制，不为空则录制 TranscodeSuffixList 命中的转码后缀。

说明

TranscodeRecord 和 OriginRecord 的取值至少一个不为 0。

OriginRecord

Integer

否

0

源流录制，默认值为 0。支持的取值如下所示。

  • 0：不录制；
  • 1：录制。

说明

TranscodeRecord 和 OriginRecord 的取值至少一个不为 0。

SliceDurationInteger否5录制 HLS 格式时，单个 TS 切片时长，单位为 s，默认值为 5，取值范围为 [5,30]

FlvParam

Object of RecordParam

否

-

FLV 录制参数，开启 FLV 录制时设置

说明

FlvParam、HlsParam、Mp4Param 至少开启一个。

HlsParam

Object of RecordParam

否

-

HLS 录制参数，开启 HLS 录制时设置

说明

FlvParam、HlsParam、Mp4Param至少开启一个。

Mp4Param

Object of RecordParam

否

-

MP4 录制参数，开启 MP4 录制时设置

说明

FlvParam、HlsParam、Mp4Param至少开启一个。

TranscodeSuffixListArray of String否["_hd","_bd"]录制转码流后缀列表，转码流录制配置为全部录制时（TranscodeRecord 配置等于 2）生效。

RecordParam

参数类型是否必选示例值描述

Enable

Boolean

否

true

当前格式的录制是否开启，默认 false，取值及含义如下所示。

  • false：不开启；
  • true：开启。
DurationInteger否7200断流录制单文件录制时长，单位为 s，默认值为 7200，取值范围为 -1，[300,86400]，-1表示一直录制，目前只对HLS生效
RealtimeRecordDurationInteger否300实时录制文件时长，单位为 s，取值范围为 [300,21600]

Splice

Integer

否

0

断流拼接间隔时长，对实时录制无效，单位为 s，默认值为 0。支持的取值如下所示。

  • -1：一直拼接；
  • 0：不拼接；
  • 大于 0：断流拼接时间间隔，对 HLS 录制生效。

TOSParam

Object of TOSParam

否

-

TOS 存储相关配置

说明

TOSParam和VODParam配置且配置其中一个。

VODParam

Object of VODParam

否

-

VOD 存储相关配置

说明

TOSParam和VODParam配置且配置其中一个。

ContinueDurationInteger否180断流等待时长，取值范围[0,3600]

TOSParam

参数类型是否必选示例值描述

Enable

Boolean

否

true

是否使用 TOS 存储，默认为 false，取值及含义如下所示。

  • false：不使用；
  • true：使用。

Bucket

String

否

live-test-tos-example

TOS 存储空间，一般使用 CDN 对应的 Bucket

说明

如果 TOSParam 中的 Enable 取值为 true，则 Bucket 必填。

StorageDirString否/TOS 存储目录，默认为空
ExactObjectString否record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}录制文件的存储位置。存储路径为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}

VODParam

参数类型是否必选示例值描述

Enable

Boolean

否

true

是否使用 VOD 存储，默认为 false，取值及含义如下所示。

  • false：不使用；
  • true：使用。

VodNamespace

String

否

Snapshot

视频点播（VOD）空间名称。可登录视频点播控制台查询

说明

如果 VODParam 中的 Enable 取值为 true，则 VodNamespace 必填。

WorkflowIDString否25524a2d*********891d7daf4b9工作流模版 ID，对于存储在点播的录制文件，会使用该工作流模版对视频进行处理。可登录视频点播控制台获取 ID
ClassificationIDInteger否12**34直播录制文件存储到点播时的视频分类 ID，您可以通过视频点播的 ListVideoClassifications 接口查询视频分类 ID 等信息。

StorageClass

Integer

否

1

直播录制文件存储到点播时的存储类型。默认值为 1，支持的取值及含义如下所示。

  • 1：标准存储；
  • 2：归档存储。

ExactObject

String

否

record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}

录制文件的存储位置，最大长度为 200 个字符。默认的存储位置为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} ，参数格式要求如下所示。

  • 支持删除固定路径，如 {App}/{Stream}；
  • 不支持以正斜线（/）或者反斜线（\）开头；
  • 不支持 “//” 和 “/./” 等字符串；
  • 不支持 \b、\t、\n、\v、\f、\r 等字符；
  • 不支持 “..” 作为文件名；
  • 目录层级至少包含 2 级及以上，如 live/{App}/{Stream}。

返回参数

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

示例

请求示例

POST https://live.volcengineapi.com?Action=CreateRecordPresetV2&Version=2023-01-01
{
    "Vhost":"push.example.com",
    "App":"live",
    "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": "CreateRecordPresetV2",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429RequestLimitExceeded.Exist%s already exist请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。