接口说明

使用说明

调用本接口前，您必须已经调用 AddRecordTemplate 添加录制配置模板。
默认最多同时启动 100 个录制任务，超出后新的录制任务将不可用，如果有特殊需求，请提交工单。

QPS 限制

本接口的单用户 QPS 限制为 500 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求参数

字段名称	字段详情
SubSpecUsersarray<string>	指定该任务订阅的用户列表。示例值:userID子级条数 <= 64
SubSpecAudioUsersarray<string>	指定订阅房间里有哪些用户音频流。示例值:1子级条数 <= 64
SubSpecShareScreenUsersarray<string>	指定订阅房间里有哪些用户屏幕共享流。示例值:1子级条数 <= 64
SubSpecCameraUsersarray<string>	指定订阅房间里有哪些用户摄像头流。示例值:1子级条数 <= 64
UnsubSpecAudioUsersarray<string>	指定非订阅房间里有哪些用户音频流。示例值:1子级条数 <= 64
UnsubSpecShareScreenUsersarray<string>	指定非订阅房间里有哪些用户屏幕共享流。示例值:1子级条数 <= 64
UnsubSpecCameraUsersarray<string>	指定非订阅房间里有哪些用户摄像头流。示例值:1子级条数 <= 64
UserPanesarray<object>	布局参数列表。子级条数 <= 16
LayoutIdsarray<integer<int64>>	布局 ID 组。示例值:1111子级条数 <= 64
AppIdstring	应用 ID。通过控制台创建和查询，仅支持传单个 ID。示例值:yourAppId
ChannelIdstring	频道 ID。仅支持传单个 ID。示例值:yourChannelId参考取值来源: DescribeRtcChannelList
TaskIdstring	任务 ID。仅支持传单个 ID，需保证唯一。由 1~55 位大小写字母、数字、下划线、短划线（-）组成。示例值:yourTaskId
TaskProfilestring	任务计费配置，根据您的不同设置，进行收费。请参见下文中的 TaskProfile 枚举值。展开详情示例值:4IN_1080P
MediaEncodeinteger<int32>	编码选项，请参见下文中的 MediaEncode 枚举值。示例值:20
TemplateIdstring	配置模板 ID。获取模板 ID，请参见 AddRecordTemplate 。示例值:76dasgb****参考取值来源: AddRecordTemplate UpdateRecordTemplate CreateAppRecordTemplate DescribeRecordTemplates ModifyAppStreamingOutTemplate
SourceTypestring	单流录制模式下视频源，取值：展开详情示例值:camera
StreamTypeinteger<int32>	单流录制模式，取值：展开详情示例值:0
MixModeinteger<int32>	录制模式，取值：展开详情示例值:1
CropModeinteger<int64>	视频的裁剪方式。取值：展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1

请求说明

MediaEncode 枚举值：

ID	宽	高	码流（kps）	帧率（fps）
0	0	0	64	0
1	640	360	500	15
54	360	640	500	30
53	360	640	500	15
52	640	360	500	30
10	960	540	700	24
20	1280	720	1024	25
22	720	1280	1024	30
23	800	600	1024	30
30	1920	1080	2048	30
31	1080	1920	2048	30
24	750	780	1024	30
25	750	540	700	30
26	720	1280	2048	30
27	1280	720	2048	30
28	1280	720	3096	30
32	1024	768	1024	24
33	1280	960	1024	24
34	1024	768	2048	24
35	1280	960	2048	24
36	1280	720	1024	24
37	1280	720	2048	24
38	540	960	750	15
39	540	960	1500	30
40	1280	720	1200	15
41	720	1280	1200	15
42	720	1280	1500	15
43	540	960	1200	15

TaskProfile 枚举值：

说明 Mixed_Audio（纯音频）不限制最大输入路数，其余规格根据第一个数字判断支持最大输入路数，例如：4IN_720P 代表支持最大输入路数为 4。

-	1080P	720P	360P	Audio
1IN	1IN_1080P	1IN_720P	1IN_360P	无
2IN	2IN_1080P	2IN_720P	2IN_360P	无
4IN	4IN_1080P	4IN_720P	4IN_360P	无
9IN	9IN_1080P	9IN_720P	9IN_360P	无
12IN	12IN_1080P	12IN_720P	12IN_360P	无
16IN	16IN_1080P	16IN_720P	16IN_360P	无
Mixed	无	无	无	Mixed_Audio

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:760bad53276431c499e30dc36f6b****

返回说明

录制结果回调 录制产生的结果文件写入到用户 MNS 队列或者将结果文件通过 JSON 格式以 HTTP POST 方式回调，参数定义如下所示：

参数名称	类型	说明
AppId	String	应用 ID。
ChannelId	String	频道 ID。
TaskId	String	录制任务 ID。
Event	String	事件类型，目前仅支持 FileCreated 事件。
MsgId	String	消息 ID。
StartTime	String	录制开始时间。
StopTime	String	录制结束时间。
Url	String	录制到 OSS 的文件 HTTP 地址。

示例说明：

{
    "AppId": "9q****",
    "ChannelId": "record-004",
    "Duration": 1792.257,
    "Event": "FileCreated",
    "MsgId": "83eaaf62-19e8-45df-929b-79f4753b****",
    "StartTime": "2020-09-02T10:23:54Z",
    "StopTime": "2020-09-02T10:53:46Z",
    "TaskId": "task-005",
    "Url": "http://rtc-record.****.aliyuncs.com/record/0902-1/9q****/record-004_task-005/2020-09-02-18-23-56_2020-09-02-18-53-56.m3u8"
}

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

200	TaskExisted	the task is existed	诊断

变更历史

暂无变更历史

StartRecordTask_音视频通信_API文档