Modifies a virtual studio template.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
StudioName | string | Yes | The name of the virtual studio template. The name is the same as the value of the StudioName parameter that was specified when you called the CreateLiveAIStudio operation to create the virtual studio template. | stu02 |
Description | string | No | The custom description. | custom |
Width | integer | No | The preview width. Unit: pixels. | 1920 |
Height | integer | No | The preview height. Unit: pixels. The following preview specifications (width × height) are supported:
| 1080 |
BackgroundType | string | No | The type of the background material. Valid values:
| VOD |
BackgroundResourceId | string | No | The ID of the background material in ApsaraVideo VOD. You can obtain the ID from the ApsaraVideo VOD console. | d0eb493192c771efba644531858c0102 |
BackgroundResourceUrl | string | No | The URL of the background material. | https://xxx.com/2.mp4 |
MediaType | string | No | The type of the multimedia material. Valid values:
| VOD |
MediaResourceId | string | No | The ID of the multimedia material in ApsaraVideo VOD. You can obtain the ID from the ApsaraVideo VOD console. | d0eb493192c771efba644531858c01102 |
MediaResourceUrl | string | No | The URL of the multimedia material. Specify either this parameter or the MediaResourceId parameter. | https://xxx.com/1.mp4 |
MediaLayout | object | No | The layout information of the multimedia material. | |
PositionX | float | No | The x-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material. | 0 |
PositionY | float | No | The y-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material. | 0 |
HeightNormalized | float | No | 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. | 0.5 |
MattingType | string | Yes | The type of chroma key. Valid values:
| complex |
MattingLayout | object | Yes | The layout information of the chroma-keyed material. | |
PositionX | float | No | The x-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material. | 0 |
PositionY | float | No | The y-coordinate of the material. Valid values: 0 to 1. The upper-left corner is used as the coordinate origin for the material. | 0 |
HeightNormalized | float | No | The normalized value of the height. The value indicates the ratio of the material height to the height of the background. Valid values: 0 to 1. | 0.5 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "0BA6B3C4-525A-5381-A2B0-5351323F31C5"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | LiveServiceNotFound | %s |
400 | InvalidParameter.PurchaseTime | %s |
400 | InvalidParameter.ExpireTime | %s |
400 | MissingParameter | %s |
400 | InvalidChargeType.Malformed | %s |
400 | InvalidChargeType.PostSupport | %s |
400 | InvalidCasterTemplate.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidParameter.ChargeType | %s |
400 | InvalidPeriod.Malformed | %s |
400 | InvalidUserId.Malformed | %s |
400 | InvalidClientToken.Malformed | %s |
400 | IncorrectCasterStatus | %s |
401 | CasterNumberExceed | %s |
403 | PermissionDenied | %s |
404 | InvalidParameter.NormType | %s |
404 | InvalidConfiguration.NotFound | %s |
408 | ModifyLiveAIStudio.Timeout | %s |
For a list of error codes, visit the Service error codes.