DescribeStudioLayouts - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries one or more layouts of a virtual studio.

Operation description

You must call the AddStudioLayout operation to configure layouts for a virtual studio before you call this operation to query layouts.

QPS limits

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeStudioLayouts	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	The ID of the production studio instance. If you call the CreateCaster operation to create a production studio instance, you can obtain the instance ID from the CasterId parameter in the response. If you create a production studio instance in the ApsaraVideo Live console, perform the following operations to obtain the instance ID: Log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Then, view the instance ID on the Production Studio Management page. Note The value displayed in the Name column for an instance on the Production Studio Management page is the ID of the instance.	5c6a2a0d-f228-4a64-af62-20e91b96****
LayoutId	string	No	The ID of the layout. You can specify multiple layout IDs and separate them with commas (,). If you leave this parameter empty, all layouts of the production studio are returned. If you call the AddStudioLayout operation to configure a layout for a virtual studio, you can obtain the ID of the layout from the LayoutId parameter in the response.	445409ec-7eaa-461d-8f29-4bec2eb9****

Response parameters

Parameter	Type	Description	Example
	object	The details.
RequestId	string	The ID of the request.	5c6a2a0d-f228-4a64-af62-20e91b9676b3
StudioLayouts	array<object>	The layout information.
StudioLayout	object
BgImageConfig	object	The background material configurations.
Id	string	The unique ID of the material.	k12kj31****
ImageUrl	string	The URL of the material.	http://example.org
LocationId	string	The position ID.	RV01
MaterialId	string	The ID of the material in ApsaraVideo VOD.	asdfas9df89asd8f9****
CommonConfig	object	The common layout configurations. This parameter is returned only for a common layout.
ChannelId	string	The ID of the channel that is bound to the video resource.	RV01
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
LayerOrderConfigList	array<object>	The layer sorting configurations.
LayerOrderConfig	object
Id	string	The unique ID of the resource.	k12kj31****
Type	string	The type of the resource. Valid values: background: background material media: multimedia material	media
LayoutId	string	The ID of the layout.	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	The name of the layout.
LayoutType	string	The type of the layout. Valid values: common studio	studio
MediaInputConfigList	array<object>	The multimedia input configurations.
MediaInputConfig	object
ChannelId	string	The ID of the channel that is bound to the video resource.	RV01
FillMode	string	The fill type. Default value: none.	none
HeightNormalized	float	The normalized value of the material height. The value indicates the ratio of the material height to the height of the background. Valid values: 0 to 1.	0.4
Id	string	The unique ID of the multimedia material.	k12kj31****
ImageMaterialId	string	The ID of the image in ApsaraVideo VOD.	lkajsdfsa8fd89asd8****
Index	integer	The sequence number of the multimedia material. This parameter is displayed on the frontend but not used in the operation logic.	1
PositionNormalized	array	The normalized value of the position of the material, in the format of [unk][x,y][unk]. Valid values of x and y: 0 to 1. For example, [unk][0.1,0.2][unk] indicates that the material is horizontally offset by 10% and vertically offset by 20% towards the upper-left corner.
Position	string	The normalized value of the position of the material, in the format of `[x,y]`. Valid values of x and y: 0 to 1. For example, `[0.1,0.2]` indicates that the material is horizontally offset by 10% and vertically offset by 20% towards the upper-left corner.	0.1
PositionRefer	string	The coordinate origin for the material. Default value: topLeft. topLeft indicates that the upper-left corner is used as the coordinate origin.	topLeft
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
WidthNormalized	float	The normalized value of the material width. The value indicates the ratio of the material width to the width of the background. Valid values: 0 to 1.	0.4
ScreenInputConfigList	array<object>	The input configurations for chroma key.
ScreenInputConfig	object
AudioConfig	object	The audio configurations.
ValidChannel	string	The corresponding channel.	1
VolumeRate	float	The volume.	1.0
ChannelId	string	The ID of the channel that is bound to the video resource.	RV01
Color	string	The color gamut for chroma key. Valid values: blue green auto: automatic recognition complex: background replacement	green
HeightNormalized	float	The normalized value of the height. The value indicates the ratio of the height of the keyed portrait to the height of the background. Valid values: 0 to 1.	0.4
Id	string	The unique ID of the chroma key source.	k12kj31****
Index	integer	The sequence number of the chroma key source. This parameter is displayed on the frontend but not used in the operation logic.	1
OnlyAudio	boolean	Indicates whether only audio exists.	true
PortraitType	integer	The portrait type. Valid values: 0: half body 1: full body	0
PositionX	string	The x-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material.	0.1
PositionY	string	The y-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material.	0.2
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
Total	integer	The total number of layouts.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
  "StudioLayouts": [
    {
      "BgImageConfig": {
        "Id": "k12kj31****",
        "ImageUrl": " http://example.org",
        "LocationId": "RV01",
        "MaterialId": "asdfas9df89asd8f9****"
      },
      "CommonConfig": {
        "ChannelId": "RV01",
        "VideoResourceId": "asdfasdfasdfasdfa****"
      },
      "LayerOrderConfigList": [
        {
          "Id": "k12kj31****",
          "Type": "media"
        }
      ],
      "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "LayoutName": "",
      "LayoutType": "studio",
      "MediaInputConfigList": [
        {
          "ChannelId": "RV01",
          "FillMode": "none",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "ImageMaterialId": "lkajsdfsa8fd89asd8****",
          "Index": 1,
          "PositionNormalized": [
            "0.1"
          ],
          "PositionRefer": "topLeft",
          "VideoResourceId": "asdfasdfasdfasdfa****",
          "WidthNormalized": 0.4
        }
      ],
      "ScreenInputConfigList": [
        {
          "AudioConfig": {
            "ValidChannel": "1",
            "VolumeRate": 1
          },
          "ChannelId": "RV01",
          "Color": "green",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "Index": 1,
          "OnlyAudio": true,
          "PortraitType": 0,
          "PositionX": "0.1",
          "PositionY": "0.2",
          "VideoResourceId": "asdfasdfasdfasdfa****"
        }
      ]
    }
  ],
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
500	InternalError	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history