通过ModifyViewLayout修改合流布局中的背景、水印和用户名单-音视频通信-阿里云-音视频通信(RTC)-阿里云帮助中心

设置合流布局

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rtc:ModifyViewLayout

update

*App

acs:rtc::{#accountId}:app/{#AppId}

无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，通过控制台创建和查询，仅支持传单个 ID。	eo85****
ChannelId	string	是	已存在的频道 ID，仅支持传单个 ID。	testid
TemplateId	string	是	模版 ID。	567
TaskId	string	是	任务 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 55 字节。	123
Panes	array<object>	否	单元格设置，做多设置 16 个。
	array<object>	否
SourceType	string	否	单元格媒体类型。取值： video：用户摄像头或者屏幕共享流（默认值）。 camera：摄像头流。 screen：共享屏幕流。	video
Images	array<object>	否	窗格局部图片水印。
	object	否
PaneImageCropMode	integer	否	裁剪方式。取值： 1：保持比例裁剪。 2：保持比例留边。 3：拉伸铺满。	2
Alpha	number	否	透明度。	0.9
X	number	是	横坐标。	0.2
Y	number	是	纵坐标。	0.3
Height	number	是	高。	0.2
Width	number	是	宽。	0.2
Layer	integer	否	z 轴层级。	0
Url	string	是	图片地址。	https://aliyun.com/123xxx.jpg
Texts	array<object>	否	窗格局部文字水印。
	array<object>	否	文本内容。
BoxBorderw	integer	否	矩形框线宽。	5
BoxColor	object	否	矩形框颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
FontSize	integer	否	字体大小。	36
FontColor	object	否	字体颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
Alpha	number	否	水印透明度。	0.9
X	number	是	横坐标。	0.2
HasBox	boolean	否	是否需要矩形框。
Y	number	是	纵坐标。	0.2
Texture	string	是	水印内容。	文字水印
Layer	integer	否	z 轴层级。	0
Font	integer	否	字体。 0：阿里巴巴普惠体 Regular 1：阿里巴巴普惠体 Light 2：阿里巴巴普惠体 Medium 3：阿里巴巴普惠体 Bold 4：阿里巴巴普惠体 Heavy 5：阿里妈妈数黑体 6：钉钉进步体 7：阿里妈妈刀隶体 8：阿里妈妈东方大楷 9：阿里妈妈方圆体	0
BoxAlpha	number	否	矩形框透明度。	0.6
PaneCropMode	integer	否	裁剪方式。取值： 1：保持比例裁剪。 2：保持比例留边。 3：拉伸铺满。	2
PaneId	string	是	窗格 ID，从 0 开始。	0
Source	string	否	单元格媒体源。可指定 userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。 - $ActiveSpeaker：当前频道发言人 - $ScreenShare：屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充	22
Backgrounds	array<object>	否	背景图片。
	object	否	背景图片。
BackgroundCropMode	integer	否	裁剪方式。取值： 1：保持比例裁剪。 2：保持比例留边。 3：拉伸铺满。	2
Alpha	number	否	透明度。	0.9
X	number	是	横坐标。	0.2
Y	number	是	纵坐标。	0.2
Height	number	是	高。	0.2
Width	number	是	宽。	0.2
Layer	integer	否	z 轴层级。	0
Url	string	是	图片地址。	https://aliyun.com/123.jpg
Images	array<object>	否	全局图片水印。
	object	否	全局图片水印。
Alpha	number	否	透明度。	0.9
X	number	是	横坐标。	0.2
Y	number	是	纵坐标。	0.2
Height	number	是	高。	0.2
ImageCropMode	integer	否	裁剪方式。取值： 1：保持比例裁剪。 2：保持比例留边。 3：拉伸铺满。	2
Width	number	是	宽。	0.2
Layer	integer	否	z 轴层级。	0
Url	string	是	图片地址。	https://aliyun.com/123xxx.jpg
Texts	array<object>	否	全局文字水印。
	array<object>	否	全局文字水印。
BoxBorderw	integer	否	矩形框线宽。	5
BoxColor	object	否	矩形框颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
FontSize	integer	否	字体大小。	36
Alpha	number	否	水印透明度。	0.1
FontColor	object	否	字体颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
X	number	是	横坐标。	0.2
HasBox	boolean	否	是否需要矩形框。
Y	number	是	纵坐标。	0.2
Texture	string	是	水印内容。	文字水印
Layer	integer	否	z 轴层级。	0
Font	integer	否	字体。 0：阿里巴巴普惠体 Regular 1：阿里巴巴普惠体 Light 2：阿里巴巴普惠体 Medium 3：阿里巴巴普惠体 Bold 4：阿里巴巴普惠体 Heavy 5：阿里妈妈数黑体 6：钉钉进步体 7：阿里妈妈刀隶体 8：阿里妈妈东方大楷 9：阿里妈妈方圆体	0
BoxAlpha	number	否	矩形框透明度。	0.6
ClockWidgets	array<object>	否	全局时钟水印。
	array<object>	否	全局时钟水印。
BoxBorderw	integer	否	矩形框线宽。	5
BoxColor	object	否	矩形框颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
FontSize	integer	否	时钟字体大小。	30
Zone	integer	否	时区。	8
Alpha	number	否	透明度。	0.9
FontColor	object	否	字体颜色。
R	integer	否	R。	255
B	integer	否	B。	255
G	integer	否	G。	255
X	number	是	横坐标。	0.2
HasBox	boolean	否	是否需要矩形框。
Y	number	是	纵坐标。	0.2
Layer	integer	否	z 轴层级。	0
Font	integer	否	字体。 0：阿里巴巴普惠体 Regular 1：阿里巴巴普惠体 Light 2：阿里巴巴普惠体 Medium 3：阿里巴巴普惠体 Bold 4：阿里巴巴普惠体 Heavy 5：阿里妈妈数黑体 6：钉钉进步体 7：阿里妈妈刀隶体 8：阿里妈妈东方大楷 9：阿里妈妈方圆体	0
BoxAlpha	number	否	矩形框透明度。	0.6
LayoutSpecifiedUsers	object	否	黑白名单设置。
Type	string	是	用户名单类型，黑名单：black，白名单：white。	white
Ids	array	是	指定用户 ID 列表。
	string	是	具体用户 ID。	123

返回参数

名称	类型	描述	示例值
	object	参数。
TaskId	string	任务 ID。	123
RequestId	string	请求 ID。	231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "TaskId": "123",
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

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

变更历史

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