DescribeLiveAIStudio - 查询虚拟演播模板 - 视频直播

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
StudioId	string	否	可选参数，指定筛选模板 Id	dbe61b87-db9a-448f-8757-a875edb3f944
StudioName	string	否	虚拟背景模板名称	sub02
PageNumber	integer	否	当前页码。默认值为 1。	1
PageSize	integer	否	单页显示应用的数量，默认值：10。取值范围：1~50。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	总模板数。	100
PageNumber	integer	当前页码。	1
PageSize	integer	单页显示应用的数量，默认值：10。取值范围：1~50。	10
StudioConfigs	array<object>	虚拟演播厅模板信息
SubtitleConfig	object	虚拟演播厅模板信息
MediaType	string	多媒体素材类型：VOD,PIC,LIVE 三选一 VOD, 点播视频文件 PIC，图片 LIVE，直播流	VOD
MediaLayout	string	多媒体布局信息	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrl	string	多媒体素材链接 url	https://testbucket.xx.com/2.jpg
MediaResourceId	string	多媒体素材点播资源 id	d0eb493192c771efba644531858c0102
BackgroundType	string	背景素材类型：VOD,PIC,LIVE 三选一 VOD, 点播视频文件 PIC，图片 LIVE，直播流	VOD
BackgroundResourceUrl	string	背景素材外部访问地址，需要保证公网可用，与 BackgroundResourceId 二选一即可。	https://testbucket.xx.com/2.jpg
BackgroundResourceId	string	背景素材资源 ID。	d0eb493192c771efba644531858c0102
Description	string	自定义规则描述信息。	user defined description
TemplateId	string	虚拟演播模板 ID。	24654384-f5ac-40ea-823b-74e85a61dd9f
TemplateName	string	虚拟演播模板名称。与 AddLiveAiStudio 中的 StudioName 参数相同	studio1
MattingLayout	string	多媒体素材位置布局信息。	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingType	string	源流抠图类型，对用户推流进行抠图处理 green 绿幕背景人像抠图 blue 蓝幕背景人像抠图 complex 实景人像抠图	complex
Height	string	预览画面高度，单位：px 预览画面宽度 x 高度仅支持以下规格：横屏流畅 360P 640x360 竖屏流畅 360P 360x640 横屏标清 480P 854x480 竖屏标清 480P 480x854 横屏高清 720P 1280x720 竖屏高清 720P 720x1280 横屏超清 1080P 1920x1080 竖屏超清 1080P 1080x1920	1080
Width	string	预览画面宽度。	1920
RuleIds	array	绑定的策略 ID 集合。
ruleId	string	规则 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	错误码	错误信息
400	LiveServiceNotFound	%s
400	InvalidParameter.PurchaseTime	%s
400	InvalidParameter.ExpireTime	%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	DescribeLiveAIStudio.Timeout	%s

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