全部产品
Search
文档中心

视频直播:CreateLiveAIStudio - 创建虚拟演播模版

更新时间:Nov 21, 2024

本接口用于创建轻量化虚拟演播模板。

接口说明

注意 轻量化虚拟演播功能处于公测阶段,单个用户最多创建 300 个模板

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
StudioNamestring

虚拟演播模板名称,不可重复

stu02
Descriptionstring

自定义描述信息。

template 1080
Widthinteger

预览画面宽度,单位:px

1920
Heightinteger

预览画面高度,单位:px

预览画面宽度 x 高度仅支持以下规格:

  • 横屏流畅 360P 640x360
  • 竖屏流畅 360P 360x640
  • 横屏标清 480P 854x480
  • 竖屏标清 480P 480x854
  • 横屏高清 720P 1280x720
  • 竖屏高清 720P 720x1280
  • 横屏超清 1080P 1920x1080
  • 竖屏超清 1080P 1080x1920
1080
BackgroundTypestring

背景素材类型:

  • VOD 点播视频
  • PIC 图片
  • LIVE 直播流
VOD
BackgroundResourceIdstring

背景素材的点播资源 id,从点播控制台获取

d0eb493192c771efba644531858c0102
BackgroundResourceUrlstring

背景素材的资源访问 url,与资源 id 二选一传入

https://xxx.com/1.mp4
MediaTypestring

多媒体素材类型:

  • VOD 点播视频
  • PIC 图片
  • LIVE 直播流
VOD
MediaResourceIdstring

多媒体素材的点播资源 id,从点播控制台获取

d0eb493192c771efba644531858c0102
MediaResourceUrlstring

多媒体素材的资源访问 url,与资源 id 二选一传入

https://xxx.com/2.mp4
MediaLayoutobject

多媒体素材的布局位置信息

PositionXfloat

位置参数,坐标 x。取值:0~1。素材位置以左上角为基准点。

0
PositionYfloat

位置参数,坐标 y。取值:0~1。素材位置以左上角为基准点。

0
HeightNormalizedfloat

素材的高度归一化值。即素材与背景的高度比。取值:0~1

0.5
MattingTypestring

抠图类型:

  • green 绿幕抠图
  • blue 蓝幕抠图
  • complex 实景抠图
complex
MattingLayoutobject

源流抠图后的布局位置信息

PositionXfloat

位置参数,坐标 x。取值:0~1。素材位置以左上角为基准点。

0.3
PositionYfloat

位置参数,坐标 y。取值:0~1。素材位置以左上角为基准点。

0.3
HeightNormalizedfloat

素材的高度归一化值。即素材与背景的高度比。取值:0~1

0.5

返回参数

名称类型描述示例值
object

响应结构体

RequestIdstring

请求 id

17D7526C-69AD-5761-8037-071C27358345
StudioIdstring

演播模版 id

369ced1f-c33a-49e5-91da-bdaae3d6c1c2

示例

正常返回示例

JSON格式

{
  "RequestId": "17D7526C-69AD-5761-8037-071C27358345",
  "StudioId": "369ced1f-c33a-49e5-91da-bdaae3d6c1c2"
}

错误码

HTTP status code错误码错误信息
400LiveServiceNotFound%s
400InvalidParameter.PurchaseTime%s
400InvalidParameter.ExpireTime%s
400InvalidParameter%s
400MissingParameter%s
400InvalidChargeType.Malformed%s
400InvalidChargeType.PostSupport%s
400InvalidCasterTemplate.Malformed%s
400InvalidParameter.Malformed%s
400InvalidParameter.ChargeType%s
400InvalidPeriod.Malformed%s
400InvalidUserId.Malformed%s
400InvalidClientToken.Malformed%s
400IncorrectCasterStatus%s
401CasterNumberExceed%s
403PermissionDenied%s
404InvalidParameter.NormType%s
404InvalidConfiguration.NotFound%s
408CreateLiveAIStudio.Timeout%s

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