调用DescribeRecordTemplates查询录制模板配置列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeRecordTemplates |
操作接口名,系统规定参数。取值:DescribeRecordTemplates。 |
AppId | String | 是 | yourAppId |
应用ID。通过控制台创建和查询,仅支持传单个ID。 |
PageSize | Integer | 否 | 10 |
每页显示个数。取值必须大于0,默认取值10。 |
PageNum | Integer | 否 | 1 |
第几页。取值必须大于0,默认查询第1页。 |
TemplateIds.N | RepeatList | 否 | 76dasgb**** |
指定查询模板ID列表。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | C292B80E-5175-4BA4-8CC292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE1E-2ABEC4D7**** |
请求ID。 |
Templates | Array of Template |
录制配置模板。 |
|
BackgroundColor | Integer | 0 |
背景色RGB。默认是0(黑色)。计算公式为R+G×256+B×65536,R(红)、G(绿)、B(蓝)的取值:0~255。 |
CreateTime | String | 2020-09-04T06:22:15Z |
创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
FileSplitInterval | Integer | 1800 |
文件切割时长。 |
Formats | List | M3U8 |
录制文件格式。当前仅支持:M3U8、MP4、FLV。 |
LayoutIds | List | 2 |
布局ID列表。 |
MediaEncode | Integer | 50 |
编码选项。 |
MnsQueue | String | record-callback-queue |
录制事件回调mns队列名称。 |
Name | String | 模板-demo |
录制配置模板名称。 |
OssBucket | String | rtc-record-oss |
录制文件存储OSS bucket名称。 |
OssFilePrefix | String | record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime} |
录制文件命名规则。 |
TaskProfile | String | 4IN_1080P |
任务规格。 |
TemplateId | String | 1ca698e2-57fa-4314-8e11-00d950d4**** |
录制配置模板ID。 |
TotalNum | Long | 1 |
返回结果数。 |
TotalPage | Long | 1 |
返回分页数。 |
示例
请求示例
https://rtc.aliyuncs.com?Action=DescribeRecordTemplates
&AppId=yourAppId
&<公共请求参数>
正常返回示例
XML
格式
<DescribeRecordTemplatesResponse>
<TotalNum>1</TotalNum>
<RequestId>C292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE</RequestId>
<TotalPage>1</TotalPage>
<Templates>
<FileSplitInterval>1800</FileSplitInterval>
<OssFilePrefix>record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}</OssFilePrefix>
<TaskProfile>4IN_1080P</TaskProfile>
<OssBucket>rtc-record-pre</OssBucket>
<MediaEncode>50</MediaEncode>
<LayoutIds>2</LayoutIds>
<Formats>m3u8</Formats>
<TemplateId>1ca698e2-57fa-4314-8e11-00d950d4****</TemplateId>
<MnsQueue>record-callback-queue</MnsQueue>
<Name>模板-demo</Name>
<BackgroundColor>0</BackgroundColor>
</Templates>
</DescribeRecordTemplatesResponse>
JSON
格式
{
"TotalNum": 1,
"RequestId": "C292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE",
"TotalPage": 1,
"Templates": [{
"FileSplitInterval": 1800,
"OssFilePrefix": "record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}",
"TaskProfile": "4IN_1080P",
"OssBucket": "rtc-record-pre",
"MediaEncode": 50,
"LayoutIds": [
2
],
"Formats": [
"m3u8"
],
"TemplateId": "1ca698e2-57fa-4314-8e11-00d950d4****",
"MnsQueue": "record-callback-queue",
"Name": "模板-demo",
"BackgroundColor": 0
}]
}
在文档使用中是否遇到以下问题
更多建议
匿名提交