API 文档

创建录制任务(已废弃,请使用新接口)

最近更新时间:2021-02-04 08:25:04

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

  • 使用前提

    1. 录制文件存放于点播平台,所以用户如需使用录制功能,需首先自行开通点播服务。
    2. 录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考 对应文档
  • 模式说明 该接口支持两种录制模式:

    1. 定时录制模式【默认模式】。 需要传入开始时间与结束时间,录制任务根据起止时间自动开始与结束。在所设置结束时间过期之前(且未调用StopLiveRecord提前终止任务),录制任务都是有效的,期间多次断流然后重推都会启动录制任务。
    2. 实时视频录制模式。 忽略传入的开始时间,在录制任务创建后立即开始录制,录制时长支持最大为30分钟,如果传入的结束时间与当前时间差大于30分钟,则按30分钟计算,实时视频录制主要用于录制精彩视频场景,时长建议控制在5分钟以内。
  • 注意事项
    1. 调用接口超时设置应大于3秒,小于3秒重试以及按不同起止时间调用都有可能产生重复录制任务,进而导致额外录制费用。
    2. 受限于音视频文件格式(FLV/MP4/HLS)对编码类型的支持,视频编码类型支持 H.264,音频编码类型支持 AAC。
    3. 为避免恶意或非主观的频繁 API 请求,对定时录制模式最大创建任务数做了限制:其中,当天可以创建的最大任务数不超过4000(不含已删除的任务);当前时刻并发运行的任务数不超过400。有超出此限制的需要提工单申请。
    4. 此调用方式暂时不支持海外推流录制。

默认接口请求频率限制:500次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLiveRecord。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
StreamName String 流名称。
AppName String 推流路径,与推流和播放地址中的 AppName保持一致,默认为 live。
DomainName String 推流域名。多域名推流必须设置。
StartTime String 录制开始时间。中国标准时间,需要 URLEncode(rfc3986)。如 2017-01-01 10:10:01,编码为:2017-01-01+10%3a10%3a01。
定时录制模式,必须设置该字段;实时视频录制模式,忽略该字段。
EndTime String 录制结束时间。中国标准时间,需要 URLEncode(rfc3986)。如 2017-01-01 10:30:01,编码为:2017-01-01+10%3a30%3a01。
定时录制模式,必须设置该字段;实时录制模式,为可选字段。如果通过Highlight参数,设置录制为实时视频录制模式,其设置的结束时间不应超过当前时间+30分钟,如果设置的结束时间超过当前时间+30分钟或者小于当前时间或者不设置该参数,则实际结束时间为当前时间+30分钟。
RecordType String 录制类型。
“video” : 音视频录制【默认】。
“audio” : 纯音频录制。
在定时录制模式或实时视频录制模式下,该参数均有效,不区分大小写。
FileFormat String 录制文件格式。其值为:
“flv”【默认】,“hls”,”mp4”,“aac”,”mp3”。
在定时录制模式或实时视频录制模式下,该参数均有效,不区分大小写。
Highlight Integer 开启实时视频录制模式标志。
0:不开启实时视频录制模式,即定时录制模式【默认】。见示例一
1:开启实时视频录制模式。见示例二
MixStream Integer 开启 A+B=C混流C流录制标志。
0:不开启 A+B=C混流C流录制【默认】。
1:开启 A+B=C混流C流录制。
在定时录制模式或实时视频录制模式下,该参数均有效。
StreamParam String 录制流参数。当前支持以下参数:
record_interval - 录制分片时长,单位 秒,1800 - 7200。
storage_time - 录制文件存储时长,单位 秒。
eg. record_interval=3600&storage_time=2592000。
注:参数需要url encode。
在定时录制模式或实时视频录制模式下,该参数均有效。

3. 输出参数

参数名称 类型 描述
TaskId Integer 任务 ID,全局唯一标识录制任务。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建定时录制任务

适用于有固定开始时间和结束时间段录制需求的场景, 如培训课堂,商业活动以及节目演出等场景。

输入示例

https://live.tencentcloudapi.com/?Action=CreateLiveRecord
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=2018-09-11+12%3a04%3a01
&EndTime=2018-09-11+12%3a08%3a01
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "TaskId": 1234567
  }
}

示例2 创建实时录制任务

适用于直播过程中,遇到精彩画面或因临时需求需要立即开始录制的场景(EndTime 用于指定录制终止时间,录制时长最大支持30分钟)。

输入示例

https://live.tencentcloudapi.com/?Action=CreateLiveRecord
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&Highlight=1
&EndTime=2018-09-11+12%3a08%3a01
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "TaskId": 1234567
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.GetConfigError 获取配置错误。
InternalError.NetworkError 内部网络错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded.MaximumRunningTask 当前并发任务数超限制。
LimitExceeded.MaximumTask 当天已创建任务数超限制。
ResourceNotFound.ChannelNotExist 频道不存在。
ResourceUnavailable.InvalidVodStatus 点播未开服。
ResourceUnavailable.StreamNotExist 推流不存在。
目录