UpdateRtcCloudRecording - 更新Rtc云端录制任务_视频直播(LIVE)-阿里云帮助中心

更新rtc云端录制任务。

接口说明

QPS 限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:UpdateRtcCloudRecording

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	启动 Rtc 云端录制时返回的任务 id。	****73-8501--8ac1-72295a****
SubscribeParams	object	是	更新后的订阅相关参数。
SubscribeUserIdList	array	是	订阅的 UserId 信息列表，单流录制模式下，会对其中每个 UserId 分别进行录制；混流录制模式下，会将所有 UserId 的音视频混合到一组音视频中。说明数组内最多支持 17 个元素。
	object	否	订阅的 UserId 的信息
UserId	string	是	订阅的 UserId。	userA
StreamType	integer	否	订阅的 UserId 的媒体类型。取值： 0：原始流，即包括音频和视频。（默认值） 1：仅音频流。 2：仅视频流。	0
SourceType	integer	否	该 UserId 的视频输入流类型，仅针对订阅视频流时（StreamType=2）有效。取值： 0：摄像头。（默认值） 1：屏幕共享。	0
MixLayoutParams	object	否	更新后的布局相关参数，单流录制模式下不填，混流录制模式下非纯音频转码时必填。
MixBackground	object	否	混流全局背景图。
RenderMode	integer	否	画面输出时的显示模式。取值： 0：裁剪。（默认值） 1：缩放并显示黑底。	0
Url	string	否	背景图 URL，最大长度不超过 2048 个字符。	https://xxxx.com/photos/my-test-picture.png
UserPanes	array	否	用于指定订阅的用户的窗口布局信息，只有设置了布局信息的 UserId，才会被放到画面中。混流模式且录制非纯音频文件时必填。
	array<object>	否	画面中窗口配置。
UserId	string	否	该窗口对应的 UserId。不设置 UserId 时，会按照订阅的用户进入频道的顺序依次填入窗口。这里设置的 UserId 与 SourceType 的组合必须包含在 SubscribeUserIdList 中。订阅纯音频流是不能加入到布局中的	userA
SourceType	integer	否	该 UserId 的视频输入流类型。不填写 UserId 时，此处设置 SourceType 无效。取值： 0：摄像头。（默认值） 1：屏幕共享。这里设置的 UserId 与 SourceType 的组合必须包含在 SubscribeUserIdList 中。	0
Height	string	否	窗格高度，归一化百分比。取值范围须在[0,1]内。(默认为 0)	0.5
Width	string	否	窗格宽度，归一化百分比。取值范围须在[0,1]内。(默认为 0)	0.5
X	string	否	坐标 X，归一化百分比。取值范围须在[0,1]内。(默认为 0)	0
Y	string	否	坐标 Y，归一化百分比。取值范围须在[0,1]内。(默认为 0)	0
ZOrder	integer	否	叠放顺序，0 为最底层，1 层在 0 层之上，以此类推。(默认为 0)	0
SubBackground	object	否	子画面背景图，当用户关闭摄像头、或入会后未推流、或入会后中途离会时，会在布局位置填充为对应的图片。
RenderMode	integer	否	子画面输出时的显示模式。取值： 0：裁剪。（默认值） 1：缩放并显示黑底。	0
Url	string	否	背景图 URL，最大长度不超过 2048 个字符。	https://xxxx.com/photos/my-test-pane-picture.png

支持同时订阅同一个 UserId 的摄像头和屏幕共享。对于单流录制模式，如果要同时订阅同一个 UserId 的摄像头和屏幕共享，FileNamePattern 和 SliceNamePattern 中必须包含 SourceType 变量（避免出现录制文件互相覆盖的情况）。
对于单流录制模式，目前不支持只订阅某个 UserId 的纯视频流。即在单流模式下，UserInfo.StreamType 的值不能设置为 2。
如果只希望录制某个 UserId 的屏幕流，而不录制音频流，要么订阅该 UserId 的纯视频流并设置 SourceType 为 1（单流录制模式下暂时不支持），要么订阅该 UserId 的原始流并在推流时视频流只推屏幕流，且不推音频流或静音；如果希望录制某个 UserId 的屏幕流和音频流，要么订阅该 UserId 的原始流并在推流时视频流只推屏幕流，且同时推音频流，要么订阅该 UserId 的纯视频流并设置 SourceType 为 1（单流录制模式下暂时不支持），同时订阅该 UserId 的纯音频流。
在单流录制模式下，如果 RecordParams.StreamType 是纯音频流（值为 1），那么 SubscribeParams 中不能存在订阅纯视频的情况（值为 2）；如果 RecordParams.StreamType 是纯视频流（值为 2），那么 SubscribeParams 中不能存在订阅纯音频的情况（值为 1）。
在混流录制模式下，如果 RecordParams.StreamType 是纯音频流（值为 1），那么 SubscribeParams 中不能所有 UserId 都只订阅纯视频（值为 2）；如果 RecordParams.StreamType 是纯视频流（值为 2），那么 SubscribeParams 中不能所有 UserId 都只订阅纯音频（值为 1）。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 id。	****58-5876--83CA-B56278****
TaskId	string	任务 id。	****73-8501--8ac1-72295a****

示例

正常返回示例

JSON格式

{
  "RequestId": "******58-5876-****-83CA-B56278******\n",
  "TaskId": "******73-8501-****-8ac1-72295a******\n"
}

错误码

HTTP status code	错误码	错误信息	描述
400	NotFound.Task	%s, please check the TaskId.	参数TaskId不存在。
400	InvalidParameter.TaskId	%s, please check the TaskId.	指定的task必须处于运行中或者恢复中状态。
400	InvalidParameter.SubscribeParams.SubscribeUserIdList	%s, please check the subscribeUserIdList of subscribeParams.	参数SubscribeUserIdList无效，请检查。
400	InvalidParameter.MixLayoutParams.UserPanes	%s, please check the userPanes of mixLayoutParams.	参数UserPanes存在无效字段，请检查。
400	InvalidParameter.MixTranscodeParams	%s, please check the transcodeParams.	参数MixTranscodeParams存在无效字段，请检查。
400	MissingParameter	%s.	参数缺失
403	InvalidParameter.UserId	%s, please check the UserId.	UserId无效，请检查。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。