UpdateCloudRecord
更新云端录制任务
服务地址:
华东2(上海)
输入参数
只看必填
AppId应用ID
ChannelId已存在的频道ID
TemplateId模版ID
TaskId本次云端录制的任务ID
Panes单元格设置
0
SourceType单元格媒体类型
VideoOrderSourceType为video时
PaneId窗格ID
Source单元格媒体源
PaneCropMode裁剪方式
ReservePaneForOfflineUser未入会用户窗格占位
请选择布尔值
Images窗格局部图片水印
0
Url图片地址
Alpha透明度
PaneImageCropMode裁剪方式
X横坐标
Y纵坐标
Width
Height
Layerz轴层级
Display水印显示时机
Backgrounds背景图片
0
Url背景图地址
Alpha透明度
PaneBackgroundCropMode裁剪方式
X横坐标
Y纵坐标
Width
Height
Layerz轴层级
Display显示时机
Texts窗格局部文字水印
0
Texture水印内容
FontSize字体大小
Alpha水印透明度
FontColor字体颜色
RR
GG
BB
Font字体
X横坐标
Y纵坐标
Layerz轴层级
HasBox是否需要矩形框
请选择布尔值
BoxColor矩形框颜色
RR
GG
BB
BoxAlpha矩形框透明度
BoxBorderw矩形框线宽
Display水印显示时机
Whiteboard白板配置
WhiteboardId白板ID
Images全局图片水印
0
Url图片地址
Alpha透明度
ImageCropMode裁剪方式
X横坐标
Y纵坐标
Width
Height
Layerz轴层级
Backgrounds背景图片
0
Url图片地址
Alpha透明度
BackgroundCropMode裁剪方式
X横坐标
Y纵坐标
Width
Height
Layerz轴层级
Texts全局文字水印
0
Texture水印内容
FontSize字体大小
Alpha水印透明度
FontColor字体颜色
RR
GG
BB
Font字体
X横坐标
Y纵坐标
Layerz轴层级
HasBox是否需要矩形框
请选择布尔值
BoxColor矩形框颜色
RR
GG
BB
BoxAlpha矩形框透明度
BoxBorderw矩形框线宽
ClockWidgets全局时钟水印
0
Zone时区
FontSize时钟字体大小
Alpha透明度
FontColor字体颜色
RR
GG
BB
Font字体
X横坐标
Y纵坐标
Layerz轴层级
HasBox是否需要矩形框
请选择布尔值
BoxColor矩形框颜色
RR
GG
BB
BoxAlpha矩形框透明度
BoxBorderw矩形框线宽
LayoutSpecifiedUsers布局生成用户指定列表
Type用户名单类型
Ids指定用户ID列表
0具体用户ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

本接口用于更新在线频道的云端录制任务。

QPS 限制

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

请求参数

字段名称字段详情
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

示例值:eo85****
ChannelIdstring

已存在的频道 ID,仅支持传单个 ID。

示例值:testid参考取值来源:
    DescribeRtcChannelList
TemplateIdstring

模版 ID。展开详情

示例值:567参考取值来源:
    AddRecordTemplate
    UpdateRecordTemplate
    CreateAppRecordTemplate
    DescribeRecordTemplates
    ModifyAppStreamingOutTemplate
字符长度 <= 128字符长度 >= 1
TaskIdstring

本次云端录制的任务 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 55 字节。

示例值:123正则:^[0-9a-zA-Z_-]+$字符长度 <= 55字符长度 >= 1
Panesarray<object>

单元格设置。

子级条数 <= 16
Imagesarray<object>

全局图片水印。

子级条数 <= 3
Backgroundsarray<object>

背景图片。

子级条数 <= 3
Textsarray<object>

全局文字水印。

子级条数 <= 3
ClockWidgetsarray<object>

全局时钟水印。

子级条数 <= 3
LayoutSpecifiedUsersobject

布局生成用户指定列表,包括黑/白名单两种。展开详情

请求说明

注意 相关补充

局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过 16。

高级水印层次说明
RTC 媒体服务器 生成的画面会分成以下几个步骤:

绘制视频 -> 绘制图片 -> 绘制文字

视频、图片、文字是完全分开的,从整个画面来看 文字优先级 > 图片 > 视频

  1. 绘制视频: 根据客户定义的布局对视频画面进行布局

    a. 宫格中的图片和全局图片的 layer 统一排列。

    b. layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

  2. 绘制图片 图片包括用户自定义的 png/jpg 图片。

    a. 根据用户配置宽高、位置、透明度等信息进行绘制。

    b. layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

  3. 绘制文字 文字分为 3 个类型 : 区域文字 全局文字和时间戳文字 。

    a. 同一类型文字根据 layer 顺序绘制,layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

    b. 不同类型文字优先级为 : 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时,优先级较低的将被覆盖。

重叠部分的显示:

  1. 重叠部分,如果没有特别配置,高优先级将覆盖低优先级 。
  2. 低优先级内容如果不想被高优先级内容覆盖,可以设置高优先级内容的透明度属性为 0。

返回参数

字段名称字段详情
TaskIdstring

本次云端录制的任务 ID。

示例值:123
RequestIdstring

请求 ID。

示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CF8
变更历史
暂无变更历史