AddLiveRecordVodConfig - 添加直播录制转点播配置

更新时间:
复制为 MD 格式

增加直播录制转点播配置,将录制内容保存到点播媒资库。

接口说明

  • 存储至 VOD 时,对录制后的视频进行自动合并、转码处理等,将产生视频处理费用,在视频点播服务收取。详情请参见剪辑合成计费媒资转码计费。自动合成和转码常见问题,请参见直播转点播常见问题 FAQ

  • 使用金融云账号不支持视频直播录制到点播。

QPS 限制

本接口的单用户 QPS 限制为 1000 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:AddLiveRecordVodConfig

create

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

DomainName

string

主播流域名。

说明

请先确认与此播放域名直播中心相同区域的点播已开通服务。

example.com

AppName

string

播流所属应用名称。您可在流管理页面查看 AppName。

testName

StreamName

string

播流名称。您可在流管理页面查看 StreamName。

stream

VodTranscodeGroupId

string

重要 当使用按格式配置功能,即传入 RecordFormat 参数时,此参数无效,可不传。
对录制后的视频在点播服务中进行一次转码,所使用的点播转码模板组 ID。

e2d796d3bb5fd8049d32bff62f94****

CycleDuration

integer

周期录制时长。单位:秒。默认值为 3600,取值范围:300~21600

300

AutoCompose

string

重要 当使用按格式配置功能,即传入 RecordFormat 参数时,此参数无效,可不传。
在直播录制结束后自动将多个录制周期文件合并成一个录制文件。

设置为 ON 表示开启自动合并,且必须同时设置请求参数 ComposeVodTranscodeGroupId。不传入参数值表示关闭自动合并。

ON

SpaceId

string

点播应用空间 ID,通过点播控制台应用信息查询接口获取。未开启应用空间时无需填写。

app-1000000

StorageLocation

string

存储地址。

****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com

ComposeVodTranscodeGroupId

string

重要 当使用按格式配置功能,即传入 RecordFormat 参数时,此参数无效,可不传
对自动合成出来的新视频在点播服务中进行一次转码,所使用的点播转码模板组 ID。当 AutoCompose 为 ON 时,本参数必填。

*****

OnDemand

integer

录制触发方式,取值:

  • 0(默认值):自动录制。

  • 1:按需录制,通过 HTTP 回调方式。

  • 2:按需录制,通过解析推流参数。

  • 7:手动录制,默认不录制,可以通过 RealTimeRecordCommand 接口手动控制录制开启或停止。

0

RecordContent

string

录制内容。取值:

  • raw(默认值):录制源流

  • transcode:录制转码流

如需同时录制源流和转码流,请将两个取值同时传入,以","分隔,如 raw,transcode

说明

录制内容包含 transcode 时,TranscodeTemplates 至少传入一个转码模版。

raw

DelayTime

integer

断流拼接时长。 直播断流时长超过设定的拼接时长后,将会生成新文件,断流拼接时长支持 15~21600 秒。

180

RecordFormat

array<object>

按格式配置录制参数列表。

object

录制格式配置。

Format

string

录制格式。取值:

  • m3u8

  • flv

  • mp4

m3u8

SliceDuration

integer

单个切片时长。单位:秒。

仅当 RecordFormat.N.Format(格式)设为 m3u8 时,本参数有效。

不填则默认为 30 秒。取值范围:5s~30s。

30

AutoCompose

string

在直播录制结束后自动将多个录制周期文件合并成一个录制文件。取值:

  • ON:开启自动合并

  • OFF:关闭自动合并

ON

VideoProcess

string

视频处理源。取值:

  • origin(默认值):处理源视频

  • compose:处理合并后视频

如需同时处理源视频和合并后视频,请将两个取值同时传入,以","分隔,如 origin,compose

origin

ProcessMethod

string

视频处理方式。取值:

  • transcode:使用转码模版组处理视频

  • workflow:使用工作流处理视频

transcode

ProcessTemplateId

string

视频处理转码模版组 ID 或工作流模版 ID。取值:

说明

此处传入的 ID 必须与 ProcessMethod 传入的视频处理方式对应,即 ProcessMethod 传入 transcode,此处应使用转码模版组 ID。

e2d796d3bb5fd8049d32bff62f94****

Tags

string

视频分类标签。

sports

TranscodeTemplates

array

转码流录制的转码模板组。

string

  • 转码流录制的转码模板,可进行多个设置,最多为 10 个。

  • 当设置 RecordContent 传入值包含 transcode 时,至少需要设置一个 TranscodeTemplates。

  • 如需录制多个或全部的转码流,可设置 TranscodeTemplates.1 为通配符*即可。

说明

TranscodeTemplates 不允许传入raw,属于保留标识。
RepeatList 表示为 TranscodeTemplates.N 中的 N,可理解为递增进行多个设置,如:TranscodeTemplates.1=sd,TranscodeTemplates.2=hd。

sd

返回参数

名称

类型

描述

示例值

object

请求 ID。

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

异常返回示例

JSON格式

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ConfigAlreadyExists Config has already exist.
400 CommomLiveRcordConfigExisted Commom liverecord config has already exist.
400 InvalidAutoCompose.Malformed Specified parameter AutoCompose is not valid.
400 InvalidAutoComposeAndComposeVodTranscodeGroupId.Malformed Specified parameter AutoCompose and ComposeVodTranscodeGroupId is not valid, must both empty or input
400 InvalidParam %s. 参数校验失败
500 InternalError The request processing has failed due to backend service exception.
403 InvalidRegion.Conflict Specified parameter StorageLocation and Region is not match
404 InvalidStorage.NotFound Specified parameter StorageLocation is not exist
404 InvalidTemplateGroupId.NotFound Specified parameter vodTranscodeGroupId or composeVodTranscodeGroupId is not exist

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情