本接口用于创建轻量化虚拟演播模板。
接口说明
轻量化虚拟演播功能处于公测阶段,单个用户最多创建 300 个模板。暂时免费使用,公测结束后将正常收费,具体时间另行通知。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:CreateLiveAIStudio |
create |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
StudioName |
string |
是 |
虚拟演播模板名称,不可重复 |
stu02 |
Description |
string |
否 |
自定义描述信息。 |
template 1080 |
Width |
integer |
否 |
预览画面宽度,单位:px |
1920 |
Height |
integer |
否 |
预览画面高度,单位:px 预览画面宽度 x 高度仅支持以下规格:
|
1080 |
BackgroundType |
string |
否 |
背景素材类型:
|
VOD |
BackgroundResourceId |
string |
否 |
背景素材的点播资源 id,从点播控制台获取 |
d0eb493192c771efba644531858c0102 |
BackgroundResourceUrl |
string |
否 |
背景素材的资源访问 url,与资源 id 二选一传入 |
https://xxx.com/1.mp4 |
MediaType |
string |
否 |
多媒体素材类型:
|
VOD |
MediaResourceId |
string |
否 |
多媒体素材的点播资源 id,从点播控制台获取 |
d0eb493192c771efba644531858c0102 |
MediaResourceUrl |
string |
否 |
多媒体素材的资源访问 url,与资源 id 二选一传入 |
https://xxx.com/2.mp4 |
MediaLayout |
object |
否 |
多媒体素材的布局位置信息 |
|
PositionX |
number |
否 |
位置参数,坐标 x。取值:0~1。素材位置以左上角为基准点。 |
0 |
PositionY |
number |
否 |
位置参数,坐标 y。取值:0~1。素材位置以左上角为基准点。 |
0 |
HeightNormalized |
number |
否 |
素材的高度归一化值。即素材与背景的高度比。取值:0~1。 |
0.5 |
MattingType |
string |
是 |
抠图类型:
|
complex |
MattingLayout |
object |
是 |
源流抠图后的布局位置信息 |
|
PositionX |
number |
否 |
位置参数,坐标 x。取值:0~1。素材位置以左上角为基准点。 |
0.3 |
PositionY |
number |
否 |
位置参数,坐标 y。取值:0~1。素材位置以左上角为基准点。 |
0.3 |
HeightNormalized |
number |
否 |
素材的高度归一化值。即素材与背景的高度比。取值:0~1。 |
0.5 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
响应结构体 |
||
RequestId |
string |
请求 id |
17D7526C-69AD-5761-8037-071C27358345 |
StudioId |
string |
演播模版 id |
369ced1f-c33a-49e5-91da-bdaae3d6c1c2 |
示例
正常返回示例
JSON
格式
{
"RequestId": "17D7526C-69AD-5761-8037-071C27358345",
"StudioId": "369ced1f-c33a-49e5-91da-bdaae3d6c1c2"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | LiveServiceNotFound | %s | |
400 | InvalidParameter.PurchaseTime | %s | |
400 | InvalidParameter.ExpireTime | %s | |
400 | InvalidParameter | %s | |
400 | MissingParameter | %s | |
400 | InvalidChargeType.Malformed | %s | |
400 | InvalidChargeType.PostSupport | %s | |
400 | InvalidCasterTemplate.Malformed | %s | |
400 | InvalidParameter.Malformed | %s | |
400 | InvalidParameter.ChargeType | %s | |
400 | InvalidPeriod.Malformed | %s | |
400 | InvalidUserId.Malformed | %s | |
400 | InvalidClientToken.Malformed | %s | |
400 | IncorrectCasterStatus | %s | |
401 | CasterNumberExceed | %s | |
403 | PermissionDenied | %s | |
404 | InvalidParameter.NormType | %s | |
404 | InvalidConfiguration.NotFound | %s | |
408 | CreateLiveAIStudio.Timeout | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。