1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
创建录制模板,数量上限:50,成功返回模板id后,需要调用CreateLiveRecordRule接口,将模板id绑定到流进行使用。
录制相关文档:直播录制。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateLiveRecordTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TemplateName | 是 | String | 模板名。仅支持中文、英文、数字、_、-。 示例值:templat |
Description | 否 | String | 描述信息。 示例值:test |
FlvParam | 否 | RecordParam | Flv录制参数,开启Flv录制时设置。 |
HlsParam | 否 | RecordParam | Hls录制参数,开启hls录制时设置。 |
Mp4Param | 否 | RecordParam | Mp4录制参数,开启Mp4录制时设置。 |
AacParam | 否 | RecordParam | Aac录制参数,开启Aac录制时设置。 |
IsDelayLive | 否 | Integer | 直播类型,默认 0。 0:普通直播, 1:慢直播。 示例值:12 |
HlsSpecialParam | 否 | HlsSpecialParam | HLS专属录制参数。 |
Mp3Param | 否 | RecordParam | Mp3录制参数,开启Mp3录制时设置。 |
CosStore | 否 | Integer | 是否存储至 cos,值为 1 时表示存储至 cos。 示例值:1 |
RemoveWatermark | 否 | Boolean | 是否去除水印,类型为慢直播时此参数无效。 如果为false,则录制水印流或转码流;如果为true,则录制原始流。 示例值:false |
FlvSpecialParam | 否 | FlvSpecialParam | FLV 录制特殊参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TemplateId | Integer | 模板Id。 示例值:1000 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLiveRecordTemplate
<公共请求参数>
{
"RemoveWatermark": "false",
"FlvParam": {
"StorageTime": "2",
"VodSubAppId": "251195406",
"Enable": "1",
"RecordInterval": "2222"
},
"IsDelayLive": "0",
"Description": "字符串",
"TemplateName": "字符串"
}
输出示例
{
"Response": {
"RequestId": "74ed2203-278d-4ec8-8c67-65626a94daef",
"TemplateId": 362894
}
}
示例2 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=CreateLiveRecordTemplate
&TemplateName=templat
&Description=test
&FlvParam.Enable=0
&FlvParam.RecordInterval=1800
&FlvParam.StorageTime=600
&HlsParam.Enable=1
&HlsParam.RecordInterval=1800
&HlsParam.StorageTime=600
&<公共请求参数>
输出示例
{
"Response": {
"TemplateId": 1000,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NotFound | 找不到记录。 |
InternalError | 内部错误。 |
InternalError.ArgsNotMatch | 针对添加转码模版的接口。 |
InternalError.ConfInUsed | 模版使用中。 |
InternalError.ConfNotFound | 模版不存在。 |
InternalError.ConfOutLimit | 模版数量超过限制。 |
InternalError.InvalidInput | 参数检校不通过。 |
InternalError.NotFound | 记录不存在。 |
InternalError.RuleAlreadyExist | 规则已经配置。 |
InternalError.RuleInUsing | 规则使用中。 |
InternalError.RuleNotFound | 规则不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidVodFileName | 错误的VodFileName。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
UnsupportedOperation.NotLVBCodeMode | 非直播码/新版控制台模式。 |