文档

StartCloudRecord - 开始云端录制任务

更新时间:

本接口用于开始云端录制任务。

接口说明

使用说明

本接口用于开始云端录制任务。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Panesobject []

单元格设置。

SourceTypestring

单元格媒体类型。取值:

  • video:用户摄像头或者屏幕共享流(默认值)。
  • camera:摄像头流。
  • screen:共享屏幕流。
video
PaneIdinteger

布局 ID,从 0 开始。

0
Sourcestring

单元格媒体源。可指定 userId,如需指定特定用户类型。可使用通配符配置,支持以下类型。

  • $ActiveSpeaker:当前频道发言人
  • $ScreenShare: 屏幕共享用户,当频道中有多个屏幕共享时,将按照先后顺序依次填充
PaneCropModeinteger

裁剪方式。取值:

  • 1:保持比例裁剪。
  • 2:保持比例留边。
  • 3:拉伸铺满。
3
Imagesobject []

窗格局部图片水印。

Urlstring

对应的图片内容在推流期间不支持更新

https://aliyun.com/123xx.jpg
Alphadouble

透明度。

0.9
PaneImageCropModeinteger

裁剪方式。取值:

  • 1:保持比例裁剪。
  • 2:保持比例留边。
  • 3:拉伸铺满。
2
Layerinteger

z 轴层级。

0
Textsobject []

窗格局部文字水印。

Texturestring

水印内容。

文字水印
FontSizeinteger

字体大小。

36
Alphadouble

水印透明度。

0.9
FontColorobject

字体颜色。

Fontinteger

字体。

  • 0:阿里巴巴普惠体 Regular
  • 1:阿里巴巴普惠体 Light
  • 2:阿里巴巴普惠体 Medium
  • 3:阿里巴巴普惠体 Bold
  • 4:阿里巴巴普惠体 Heavy
  • 5:阿里妈妈数黑体
  • 6:钉钉进步体
  • 7:阿里妈妈刀隶体
  • 8:阿里妈妈东方大楷
  • 9:阿里妈妈方圆体
0
Layerinteger

z 轴层级。

0
HasBoxboolean

是否需要矩形框。

BoxColorobject

矩形框颜色。

BoxAlphadouble

矩形框透明度。

0.6
BoxBorderwinteger

矩形框线宽。

5
StorageConfigobject

存储配置

Vendorinteger

存储平台。取值:

vendor对象存储产品备注
1AliYun OSS阿里云
1
Regioninteger

存储地域。

RegionAliYun OSS
0CN_Hangzhou
1CN_Shanghai
2CN_Qingdao
3CN_Beijing
4CN_Zhangjiakou
5CN_Huhehaote
6CN_Shenzhen
7CN_Hongkong
8US_West_1
9US_East_1
10AP_Southeast_1
11AP_Southeast_2
12AP_Southeast_3
13AP_Southeast_5
14AP_Northeast_1
15AP_South_1
16EU_Central_1
17EU_West_1
18EU_East_1(ME_East_1)
19AP_Southeast_6
20CN_Heyuan
21CN_Guangzhou
22CN_Chengdu
23CN_Nanjing
24CN_Fuzhou
25CN_Wulanchabu
26CN_Northeast_2
27CN_Southeast_7
0
Bucketstring

存储桶名称

test-bucket-for-recording
AccessKeystring

accessKey

LTAX***
SecretKeystring

secretKey

APb6qWYEzKtYxE***
AppIdstring

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

eo85****
ChannelIdstring

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

testid
TemplateIdstring

模版 ID。

567
TaskIdstring

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

123
CropModeinteger

裁剪方式。取值:

  • 1:保持比例裁剪。
  • 2:保持比例留边(默认值)。
  • 3:拉伸铺满。
2
Imagesobject []

全局图片水印。

Urlstring

图片地址。对应的图片内容在推流期间不支持更新。

https://aliyun.com/123xxx.jpg
Alphadouble

透明度。

0.9
ImageCropModeinteger

裁剪方式。取值:

  • 1:保持比例裁剪。
  • 2:保持比例留边。
  • 3:拉伸铺满。
2
Layerinteger

z 轴层级。

0
Textsobject []

全局文字水印。

Texturestring

水印内容。

文字水印
FontSizeinteger

字体大小。

36
Alphadouble

水印透明度。

0.1
FontColorobject

字体颜色。

Fontinteger

字体。

  • 0:阿里巴巴普惠体 Regular
  • 1:阿里巴巴普惠体 Light
  • 2:阿里巴巴普惠体 Medium
  • 3:阿里巴巴普惠体 Bold
  • 4:阿里巴巴普惠体 Heavy
  • 5:阿里妈妈数黑体
  • 6:钉钉进步体
  • 7:阿里妈妈刀隶体
  • 8:阿里妈妈东方大楷
  • 9:阿里妈妈方圆体
0
Layerinteger

z 轴层级。

0
HasBoxboolean

是否需要矩形框。

BoxColorobject

矩形框颜色。

BoxAlphadouble

矩形框透明度。

0.6
BoxBorderwinteger

矩形框线宽。

5
ClockWidgetsobject []

全局时钟水印。

Zoneinteger

时区。

8
FontSizeinteger

时钟字体大小。

30
Alphadouble

透明度。

0.9
FontColorobject

字体颜色。

Fontinteger

字体。

  • 0:阿里巴巴普惠体 Regular
  • 1:阿里巴巴普惠体 Light
  • 2:阿里巴巴普惠体 Medium
  • 3:阿里巴巴普惠体 Bold
  • 4:阿里巴巴普惠体 Heavy
  • 5:阿里妈妈数黑体
  • 6:钉钉进步体
  • 7:阿里妈妈刀隶体
  • 8:阿里妈妈东方大楷
  • 9:阿里妈妈方圆体
0
Layerinteger

z 轴层级。

0
HasBoxboolean

是否需要矩形框。

BoxColorobject

矩形框颜色。

BoxAlphadouble

矩形框透明度。

0.6
BoxBorderwinteger

矩形框线宽。

5

注意 这是注意的内容

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

返回参数

名称类型描述示例值
object

result

TaskIdstring

本次云端录制的任务 ID。

123
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CF8

示例

正常返回示例

JSON格式

{
  "TaskId": "123",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用