Modifies the layout configurations pf a production studio. You need to pass only parameters that you want to modify.
Operation description
Instructions
First, create a director console via the CreateCaster interface, then invoke this interface to modify the layout configuration by passing the changes; elements not to be modified need not be passed. Currently, this interface supports two fill methods for elements: default and adaptive.
QPS Limitation
The per-user QPS limit for this interface is 10 times/second. Exceeding this limit will result in API calls being throttled, which may impact your services. Please use judiciously. For more information, refer to QPS Limitations.
Debugging
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:ModifyCasterLayout | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
VideoLayer | array<object> | Yes | Video information. | |
object | Yes | |||
FillMode | string | No | The scaling mode of the layer. Valid values:
| fit |
FixedDelayDuration | integer | No | The fixed delay of the video layer. This parameter is used to synchronize the video with subtitles. Unit: milliseconds. Valid values: 0 to 5000. Default value: 0. | 5000 |
HeightNormalized | float | No | The normalized value of the height of the element of video layer N.
| 1 |
PositionNormalized | array | No | Normalized position value of the Note
Note: x and y need to be normalized.
| |
float | No | The normalized value of the Note
Note that x and y are normalized values.
| [0,3] | |
PositionRefer | string | No | The reference coordinates of video layer N in the production studio. Valid values:
| topLeft |
WidthNormalized | float | No | The normalized value of the width of the element of video layer N.
| 1 |
AudioLayer | array<object> | Yes | Audio information. | |
object | Yes | |||
FixedDelayDuration | integer | No | 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. | 5000 |
ValidChannel | string | No | The sound channels that are used for volume input in the audio layer N. Valid values:
| all |
VolumeRate | float | No | The normalization ratio of the height for the layer element, where the element's width will be scaled proportionally based on this height. The default value is 0, indicating that the element is displayed in its original size. | 1 |
BlendList | array | Yes | The element represents the location ID of the video resource, i.e., LocationId. LocationId refers to Adding Video Source, and it corresponds to the order of VideoLayers elements. | |
string | Yes | The location ID of video layer N in the production studio. For more information, see AddCasterVideoResource . | RV02 | |
MixList | array | Yes | The element represents the location ID of the audio resource, i.e., LocationId. LocationId is referred to in Adding Video Source, and corresponds in order with the AudioLayers elements. | |
string | Yes | The location ID of audio layer N in the production studio. For more information, see AddCasterVideoResource . | RV02 | |
CasterId | string | Yes | The ID of the production studio.
Note
You can find the ID of the production studio in the Instance ID/Name column.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
LayoutId | string | Yes | The ID of the layout. If the layout was created by calling the AddCasterLayout operation, check the value of the response parameter LayoutId to obtain the ID. | 21926b36-7dd2-4fde-ae25-51b5bc8e**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | InvalidCasterId.Malformed | %s |
400 | InvalidUserId.Malformed | %s |
400 | InvalidLayoutId.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidVideoLayersAndBlendListSize.Mismatch | %s |
400 | InvalidAudioLayersAndMixListSize.Mismatch | %s |
400 | InvalidPositionNormalized.Malformed | %s |
400 | InvalidBlendList.ExceedNorm | %s |
400 | InvalidMixList.ExceedNorm | %s |
400 | InvalidVideoLayersConfig | %s |
400 | InvalidAudioLayersConfig | %s |
400 | InvalidHeightOrWidthNormalized | %s |
401 | IllegalOperation | %s |
404 | InvalidCaster.NotFound | %s |
404 | InvalidLayout.NotFound | %s |
500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|