All Products
Search
Document Center

:ModifyLiveAIStudio

Last Updated:Dec 06, 2024

Modifies a virtual studio template.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StudioNamestringYes

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
DescriptionstringNo

The custom description.

custom
WidthintegerNo

The preview width. Unit: pixels.

1920
HeightintegerNo

The preview height. Unit: pixels.

The following preview specifications (width × height) are supported:

  • Landscape low definition 360p (640×360)
  • Portrait low definition 360p (360×640)
  • Landscape standard definition 480p (854×480)
  • Portrait standard definition 480p (480×854)
  • Landscape high definition 720p (1280×720)
  • Portrait high definition 720p (720×1280)
  • Landscape ultra-high definition 1080p (1920×1080)
  • Portrait ultra-high definition 1080p (1080×1920)
1080
BackgroundTypestringNo

The type of the background material. Valid values:

  • VOD: a video in ApsaraVideo VOD
  • PIC: an image
  • LIVE: a live stream
VOD
BackgroundResourceIdstringNo

The ID of the background material in ApsaraVideo VOD. You can obtain the ID from the ApsaraVideo VOD console.

d0eb493192c771efba644531858c0102
BackgroundResourceUrlstringNo

The URL of the background material.

https://xxx.com/2.mp4
MediaTypestringNo

The type of the multimedia material. Valid values:

  • VOD: a video in ApsaraVideo VOD
  • PIC: an image
  • LIVE: a live stream
VOD
MediaResourceIdstringNo

The ID of the multimedia material in ApsaraVideo VOD. You can obtain the ID from the ApsaraVideo VOD console.

d0eb493192c771efba644531858c01102
MediaResourceUrlstringNo

The URL of the multimedia material. Specify either this parameter or the MediaResourceId parameter.

https://xxx.com/1.mp4
MediaLayoutobjectNo

The layout information of the multimedia material.

PositionXfloatNo

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
PositionYfloatNo

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
HeightNormalizedfloatNo

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
MattingTypestringYes

The type of chroma key. Valid values:

  • green: green-screen chroma key
  • blue: blue-screen chroma key
  • complex: background replacement
complex
MattingLayoutobjectYes

The layout information of the chroma-keyed material.

PositionXfloatNo

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
PositionYfloatNo

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
HeightNormalizedfloatNo

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

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0BA6B3C4-525A-5381-A2B0-5351323F31C5

Examples

Sample success responses

JSONformat

{
  "RequestId": "0BA6B3C4-525A-5381-A2B0-5351323F31C5"
}

Error codes

HTTP status codeError codeError message
400LiveServiceNotFound%s
400InvalidParameter.PurchaseTime%s
400InvalidParameter.ExpireTime%s
400MissingParameter%s
400InvalidChargeType.Malformed%s
400InvalidChargeType.PostSupport%s
400InvalidCasterTemplate.Malformed%s
400InvalidParameter.Malformed%s
400InvalidParameter.ChargeType%s
400InvalidPeriod.Malformed%s
400InvalidUserId.Malformed%s
400InvalidClientToken.Malformed%s
400IncorrectCasterStatus%s
401CasterNumberExceed%s
403PermissionDenied%s
404InvalidParameter.NormType%s
404InvalidConfiguration.NotFound%s
408ModifyLiveAIStudio.Timeout%s

For a list of error codes, visit the Service error codes.