DescribeStudioLayouts - ApsaraVideo Live

Usage notes

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

QPS limit

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 limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeStudioLayouts	The operation that you want to perform. Set the value to DescribeStudioLayouts.
CasterId	String	Yes	5c6a2a0d-f228-4a64-af62-20e91b96****	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance Name column.
LayoutId	String	No	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the layout. You can specify multiple layout IDs by separating 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.

Response parameters

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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeStudioLayouts
&CasterId=5c6a2a0d-f228-4a64-af62-20e91b96****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "Test layout",
    "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

For a list of error codes, see Service error codes.