Modifies a layout.
Usage note
You only need to set parameters that need to be modified to this operation.
QPS limit
A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyCasterLayout |
The operation that you want to perform. Set the value to ModifyCasterLayout. |
BlendList.N | RepeatList | Yes | RV02 |
The location ID of video layer N in the production studio. For more information about the location ID, see AddCasterVideoResource. Make sure that the video layers specified by this parameter are in the same order as those specified by the VideoLayers parameter. |
CasterId | String | Yes | 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e**** |
The ID of the production studio. If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response. If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path: Production Studios > Production Studio Management Note The CasterId is reflected in the Name column on the Production Studio Management page.
|
LayoutId | String | Yes | 21926b36-7dd2-4fde-ae25-51b5bc8e**** |
The ID of the layout. It is included in the response when you call the AddCasterLayout operation. |
MixList.N | RepeatList | Yes | RV02 |
The location ID of audio layer N in the production studio. For more information about the location ID, see AddCasterVideoResource. Make sure that the audio layers specified by this parameter are in the same order as those specified by the AudioLayers parameter. |
RegionId | String | No | cn-shanghai |
The ID of the region. |
VideoLayer.N.FillMode | String | No | fit |
The scaling mode of video layer N. Valid values:
|
VideoLayer.N.HeightNormalized | Float | No | 1 |
The normalized value of the height of the image of video layer N.
|
VideoLayer.N.WidthNormalized | Float | No | 1 |
The normalized value of the width of the image of video layer N.
|
VideoLayer.N.PositionRefer | String | No | topLeft |
The reference coordinates of video layer N in the production studio. Valid values:
|
VideoLayer.N.PositionNormalized.N | RepeatList | No | [0,3] |
The normalized value of the Note The coordinates indicate the location of video layer N in the production studio. Set
this parameter to the normalized value of the coordinates.
|
VideoLayer.N.FixedDelayDuration | Integer | No | 5000 |
The fixed delay of video layer N. You can use this parameter to synchronize the video with subtitles. Unit: milliseconds. Valid values: 0 to 5000. Default value: 0. |
AudioLayer.N.VolumeRate | Float | No | 1 |
The normalized value of heights for the elements in audio layer N. The widths of the elements are scaled based on this parameter. The default value is 0, which indicates that the elements in audio layer N are not scaled. |
AudioLayer.N.ValidChannel | String | No | all |
The valid voice channels of audio layer N. Valid values:
|
AudioLayer.N.FixedDelayDuration | Integer | No | 5000 |
The fixed delay of audio layer N. You can use this parameter to synchronize the audio with subtitles. Unit: milliseconds. Default value: 0. Valid values: 0 to 5000. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
LayoutId | String | 21926b36-7dd2-4fde-ae25-51b5bc8e**** |
The ID of the layout. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=ModifyCasterLayout
&BlendList.1=RV02
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****
&LayoutId=21926b36-7dd2-4fde-ae25-51b5bc8e****
&MixList.1=RV02
&<Common request parameters>
Sample success responses
XML
format
<ModifyCasterLayoutResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e****</LayoutId>
</ModifyCasterLayoutResponse>
JSON
format
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****"
}
Error codes
For a list of error codes, visit the API Error Center.