DescribeStudioLayouts - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries one or more layouts of a virtual studio.

Operation description

You must first call the AddStudioLayout operation to add a layout for a virtual production studio. You can then call this operation to query the layout settings.

QPS limits

This operation supports up to 15 queries per second (QPS) per user. Calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeStudioLayouts

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the returned CasterId. If you create a production studio in the ApsaraVideo Live console, go to the ApsaraVideo Live console > Production Studio > Cloud Production Studio page to view the ID. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	5c6a2a0d-f228-4a64-af62-20e91b96****
LayoutId	string	No	The layout ID. To specify multiple layout IDs, separate them with commas (,). If you leave this parameter empty, all layouts of the production studio are returned. If you add a layout by calling the AddStudioLayout operation, use the returned LayoutId.	445409ec-7eaa-461d-8f29-4bec2eb9****

Response parameters

Parameter	Type	Description	Example
	object	The layout details.
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b9676b3
StudioLayouts	array<object>	The layout details.
	object	The layout details.
BgImageConfig	object	The background resource configuration.
Id	string	The unique ID of the background material.	k12kj31****
ImageUrl	string	The URL of the material.	http://example.org
LocationId	string	The position ID.	RV01
MaterialId	string	The ID of the video-on-demand (VOD) material.	asdfas9df89asd8f9****
CommonConfig	object	The information about the common layout. This parameter is returned if the layout is a common layout.
ChannelId	string	The ID of the channel to which the video resource is attached.	RV01
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
LayerOrderConfigList	array<object>	The layer order configuration.
	object	The layer order configuration.
Id	string	The unique ID of the resource.	k12kj31****
Type	string	The type of the resource configuration. Valid values: background: background material. media: multimedia material.	media
LayoutId	string	The ID of the production studio layout.	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	The name of the production studio layout.	测试布局
LayoutType	string	The type of the production studio layout. Valid values: common: common layout. studio: production studio layout.	studio
MediaInputConfigList	array<object>	The multimedia input resource configuration.
	object	The multimedia input source configuration.
ChannelId	string	The ID of the channel to which the video resource is attached.	RV01
FillMode	string	The fill mode. The default value is none.	none
HeightNormalized	number	The normalized height of the material. This is the ratio of the material height to the background height. Valid values: 0 to 1.	0.4
Id	string	The unique ID of the multimedia material.	k12kj31****
ImageMaterialId	string	The ID of the VOD image material.	lkajsdfsa8fd89asd8****
Index	integer	The index of the multimedia material. This parameter is for display on the frontend and has no logical function.	1
PositionNormalized	array	The normalized coordinates of the material's fill area, in the format [x,y]. The values of x and y range from 0 to 1. For example, [0.1,0.2] indicates a horizontal offset of 10% and a vertical offset of 20% from the top-left corner.
	number	The normalized coordinate of the material's fill area, in the format `[x,y]`. The values of x and y range from 0 to 1. For example, `[0.1,0.2]` indicates a horizontal offset of 10% and a vertical offset of 20% from the top-left corner.	0.1
PositionRefer	string	The reference point for the material's position. The default value is topLeft, which indicates that the top-left corner is the reference point.	topLeft
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
WidthNormalized	number	The normalized width of the material. This is the ratio of the material width to the background width. Valid values: 0 to 1.	0.4
ScreenInputConfigList	array<object>	The chroma keying input configuration.
	object	The chroma keying input configuration.
AudioConfig	object	The audio configuration.
ValidChannel	string	The corresponding channel.	1
VolumeRate	number	The volume.	1.0
ChannelId	string	The ID of the channel to which the video resource is attached.	RV01
Color	string	The color for chroma keying. Valid values: blue: blue screen background. green: green screen background. auto: automatic detection. complex: real scene matting.	green
HeightNormalized	number	The normalized height. This is the ratio of the keyed portrait's height to the background's height. Valid values: 0 to 1.	0.4
Id	string	The unique ID of the chroma key source material.	k12kj31****
Index	integer	The index of the chroma key source. This parameter is for display on the frontend and has no logical function.	1
OnlyAudio	boolean	Audio only.	true
PortraitType	integer	The portrait type. Valid values: 0: half-length. 1: full-length.	0
PositionX	string	The x-coordinate. Valid values: 0 to 1. The top-left corner is the reference point for the material's position.	0.1
PositionY	string	The y-coordinate. Valid values: 0 to 1. The top-left corner is the reference point for the material's position.	0.2
VideoResourceId	string	The ID of the video resource.	asdfasdfasdfasdfa****
Total	integer	The total number of layouts.	1

Examples

Success response

JSON format

{
  "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
500	InternalError	%s
404	InvalidCaster.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.