DescribeLiveAIStudio - 查询虚拟演播模板

更新时间:2025-02-12 03:59:45

查询用户账号下的虚拟演播模板。

调试

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

授权信息

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

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

请求参数

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

可选参数,指定筛选模板 Id

dbe61b87-db9a-448f-8757-a875edb3f944
StudioNamestring

虚拟背景模板名称

sub02
PageNumberinteger

当前页码。默认值为 1

1
PageSizeinteger

单页显示应用的数量,默认值:10。取值范围:1~50。

10

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Totalinteger

总模板数。

100
PageNumberinteger

当前页码。

1
PageSizeinteger

单页显示应用的数量,默认值:10。取值范围:1~50。

10
StudioConfigsarray<object>

虚拟演播厅模板信息

SubtitleConfigobject

虚拟演播厅模板信息

MediaTypestring

多媒体素材类型:VOD,PIC,LIVE 三选一

  • VOD, 点播视频文件
  • PIC,图片
  • LIVE,直播流
VOD
MediaLayoutstring

多媒体布局信息

"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrlstring

多媒体素材链接 url

https://testbucket.xx.com/2.jpg
MediaResourceIdstring

多媒体素材点播资源 id

d0eb493192c771efba644531858c0102
BackgroundTypestring

背景素材类型:VOD,PIC,LIVE 三选一

  • VOD, 点播视频文件
  • PIC,图片
  • LIVE,直播流
VOD
BackgroundResourceUrlstring

背景素材外部访问地址,需要保证公网可用,与 BackgroundResourceId 二选一即可。

https://testbucket.xx.com/2.jpg
BackgroundResourceIdstring

背景素材资源 ID。

d0eb493192c771efba644531858c0102
Descriptionstring

自定义规则描述信息。

user defined description
TemplateIdstring

虚拟演播模板 ID。

24654384-f5ac-40ea-823b-74e85a61dd9f
TemplateNamestring

虚拟演播模板名称。与 AddLiveAiStudio 中的 StudioName 参数相同

studio1
MattingLayoutstring

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

"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingTypestring

源流抠图类型,对用户推流进行抠图处理

  • green 绿幕背景人像抠图
  • blue 蓝幕背景人像抠图
  • complex 实景人像抠图
complex
Heightstring

预览画面高度,单位:px

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

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

预览画面宽度。

1920
RuleIdsarray

绑定的策略 ID 集合。

ruleIdstring

规则 ID。

2414378f-541a-48d3-be0c-535212f9a6b4

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "StudioConfigs": {
    "SubtitleConfig": [
      {
        "MediaType": "VOD",
        "MediaLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MediaResourceUrl": "https://testbucket.xx.com/2.jpg",
        "MediaResourceId": "\t\nd0eb493192c771efba644531858c0102\n",
        "BackgroundType": "VOD",
        "BackgroundResourceUrl": "https://testbucket.xx.com/2.jpg",
        "BackgroundResourceId": "d0eb493192c771efba644531858c0102",
        "Description": "user defined description",
        "TemplateId": "24654384-f5ac-40ea-823b-74e85a61dd9f",
        "TemplateName": "studio1",
        "MattingLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MattingType": "complex",
        "Height": "1080",
        "Width": "1920",
        "RuleIds": {
          "ruleId": [
            "2414378f-541a-48d3-be0c-535212f9a6b4"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
HTTP status code错误码错误信息
400LiveServiceNotFound%s
400InvalidParameter.PurchaseTime%s
400InvalidParameter.ExpireTime%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
408DescribeLiveAIStudio.Timeout%s

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等