DescribeCasterLayouts - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the layouts of a production studio.

Operation description

You can call this API operation to query the layouts of a production studio. If you do not specify a layout ID, all layouts of the studio are returned.

QPS limits

The queries per second (QPS) limit for this API operation is 15 calls per second for each user. If you exceed this limit, API calls are throttled. This can affect your business, so you should call this API operation at a reasonable rate.

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:DescribeCasterLayouts

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 created the production studio by calling the CreateCaster operation, use the CasterId value returned in the response. If you created the production studio in the LIVE console, find the ID on the Production Studio > Cloud Production Studio page. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	No	The layout ID. If you do not provide a value for LayoutId, all layouts of the production studio are returned.	72d2ec7a-4cd7-4a01-974b-7cd53947****

Response parameters

Parameter	Type	Description	Example
	object
Layouts	object
Layout	array<object>	The layout list.
	object	The layout list.
AudioLayers	object
AudioLayer	array<object>	The list of AudioLayer configurations.
	object	The list of AudioLayer configurations.
FixedDelayDuration	integer	The fixed latency for the audio. This can be used for caption synchronization. Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.	20
ValidChannel	string	The sound channels that can be used for audio input. Valid values: leftChannel: The left sound channel. rightChannel: The right sound channel. all (default): Both sound channels.	all
VolumeRate	number	The volume rate. A value of 1 indicates the original volume. Note The default value is 0. This displays the element in its original size.	1
BlendList	object
LocationId	array	The list of associated positions. The order is the same as that of VideoLayers.
	string	The position ID.	RV01
LayoutId	string	The layout ID.	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	object
LocationId	array	The list of associated positions. The order is the same as that of AudioLayers.
	string	The position ID.	RV01
VideoLayers	object
VideoLayer	array<object>	The list of VideoLayer configurations. The default array sequence is used.
	object	The list of VideoLayer configurations. The default array sequence is used.
FillMode	string	The fill mode of the element. Valid values: none (default): No fill. The layer is configured based on the video frame. fit: Fit. The layer is configured based on the fill area. The video frame is scaled with its original aspect ratio to fit the longer edge of the fill area and is centered. If the aspect ratio of the fill area is different from that of the video frame, the layer below is displayed in the unfilled areas. If no layer is configured below, the background is black.	fit
FixedDelayDuration	integer	The fixed latency set for the video. This can be used for caption synchronization. Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.	20
HeightNormalized	number	The normalized height of the layer element. If the fill mode is none, the width of the element is scaled proportionally based on this height. The default value is 0, which means the video is displayed in its original size. If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized height of the fill area.	0.5
PositionNormalizeds	object
Position	array	The normalized position of the layer element in the format `[x,y]`. The default value is `[0,0]`. Note The x and y coordinates must be normalized.
	number	The value.	0
PositionRefer	string	The reference point for the element's position. Valid values: topLeft (default): Top left. topRight: Top right. bottomLeft: Bottom left. bottomRight: Bottom right. center: Center. topCenter: Top center. bottomCenter: Bottom center. leftCenter: Left center. rightCenter: Right center.	topLeft
WidthNormalized	number	The normalized width of the layer element. If the fill mode is none, the height of the element is scaled proportionally based on this width. The default value is 0, which means the video is displayed in its original size. If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized width of the fill area.	0.5
RequestId	string	The request ID.	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	The total number of records.	3

Examples

Success response

JSON format

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

Error codes

HTTP status code	Error code	Error message
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.