1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
创建一个在指定时间启动、结束的录制任务,并使用指定录制模板ID对应的配置进行录制。
- 使用前提
- 录制文件存放于点播平台或对象存储内,所以用户如需使用录制功能,需首先自行开通点播服务或对象存储服务。
- 录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考对应文档。
- 注意事项
- 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效,期间只要正常推流都会正常录制,与是否多次推、断流无关。
- 使用上避免创建时间段相互重叠的录制任务。若同一条流当前存在多个时段重叠的任务,为避免重复录制系统将启动最多3个录制任务。
- 创建的录制任务记录在平台侧只保留3个月。
- 当前录制任务管理API(CreateRecordTask/StopRecordTask/DeleteRecordTask)与旧API(CreateLiveRecord/StopLiveRecord/DeleteLiveRecord)不兼容,两套接口不能混用。
- 避免 创建录制任务 与 推流 操作同时进行,可能导致因录制任务未生效而引起任务延迟启动问题,两者操作间隔建议大于3秒。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateRecordTask。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
StreamName | 是 | String | 流名称。 示例值:livetest |
DomainName | 是 | String | 推流域名。 示例值:5000.live.push.com |
AppName | 是 | String | 推流路径。 示例值:live |
EndTime | 是 | Integer | 录制任务结束时间,Unix时间戳。设置时间必须大于StartTime及当前时间,且小于当前时间+7天。 示例值:1589904000 |
StartTime | 否 | Integer | 录制任务开始时间,Unix时间戳。如果不填表示立即启动录制。EndTime - StartTime不能超过24小时。 示例值:1589889600 |
StreamType | 否 | Integer | 推流类型,默认0。取值: 0-直播推流。 1-合成流,即 A+B=C 类型混流。 示例值:0 |
TemplateId | 否 | Integer | 录制模板ID,CreateLiveRecordTemplate 返回值。如果不填或者传入错误ID,则默认录制HLS格式、永久存储。 示例值:0 |
Extension | 否 | String | 扩展字段,暂无定义。默认为空。 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID,全局唯一标识录制任务。返回TaskId字段说明录制任务创建成功。 示例值:UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
https://live.tencentcloudapi.com/?Action=CreateRecordTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1589889600
&EndTime=1589904000
&TemplateId=0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.GetConfigError | 获取配置错误。 |
InternalError.NetworkError | 内部网络错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded.MaximumRunningTask | 当前并发任务数超限制。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
ResourceUnavailable.InvalidVodStatus | 点播未开服。 |
UnsupportedOperation | 操作不支持。 |