CreateLiveAIStudio - ApsaraVideo Live - Alibaba Cloud Documentation Center

This API creates a lightweight virtual studio template.

Operation description

Important

The lightweight virtual studio feature is in public preview. While in public preview, this feature is free of charge and you can create a maximum of 300 templates. Standard fees will apply after the public preview ends. The end date will be announced later.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StudioName	string	Yes	The name of the virtual studio template. The name must be unique.	stu02
Description	string	No	A custom description.	template 1080
Width	integer	No	The width of the preview screen, in pixels.	1920
Height	integer	No	The height of the preview screen, in pixels. The preview screen resolution (width × height) must be one of the following: Landscape low definition (LD) 360p: 640 × 360 Portrait LD 360p: 360 × 640 Landscape standard definition (SD) 480p: 854 × 480 Portrait SD 480p: 480 × 854 Landscape high definition (HD) 720p: 1280 × 720 Portrait HD 720p: 720 × 1280 Landscape Full HD (FHD) 1080p: 1920 × 1080 Portrait FHD 1080p: 1080 × 1920	1080
BackgroundType	string	No	The type of the background material. VOD: A video-on-demand (VOD) video. PIC: An image. LIVE: A live stream.	VOD
BackgroundResourceId	string	No	The ID of the VOD resource for the background material. Obtain this ID from the VOD console.	d0eb493192c771efba644531858c0102
BackgroundResourceUrl	string	No	The URL of the background material. You must specify either this parameter or `BackgroundResourceId`.	https://xxx.com/1.mp4
MediaType	string	No	The type of the media material. VOD: A VOD video. PIC: An image. LIVE: A live stream.	VOD
MediaResourceId	string	No	The ID of the VOD resource for the media material. Obtain this ID from the VOD console.	d0eb493192c771efba644531858c0102
MediaResourceUrl	string	No	The URL of the media material. You must specify either this parameter or `MediaResourceId`.	https://xxx.com/2.mp4
MediaLayout	object	No	The layout and position of the media material.
PositionX	number	No	The x-coordinate. Valid values: 0 to 1. The position is relative to the top-left corner of the material.	0
PositionY	number	No	The y-coordinate. Valid values: 0 to 1. The position is relative to the top-left corner of the material.	0
HeightNormalized	number	No	The normalized height of the material. This is the ratio of the material's height to the background's height. Valid values: 0 to 1.	0.5
MattingType	string	Yes	The image matting type. green: Green screen matting. blue: Blue screen matting. complex: Real-world scene matting.	complex
MattingLayout	object	Yes	The layout and position of the source stream after image matting.
PositionX	number	No	The x-coordinate. Valid values: 0 to 1. The position is relative to the top-left corner of the material.	0.3
PositionY	number	No	The y-coordinate. Valid values: 0 to 1. The position is relative to the top-left corner of the material.	0.3
HeightNormalized	number	No	The normalized height of the material. This is the ratio of the material's height to the background's height. Valid values: 0 to 1.	0.5

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	17D7526C-69AD-5761-8037-071C27358345
StudioId	string	The ID of the virtual studio template.	369ced1f-c33a-49e5-91da-bdaae3d6c1c2

Examples

Success response

JSON format

{
  "RequestId": "17D7526C-69AD-5761-8037-071C27358345",
  "StudioId": "369ced1f-c33a-49e5-91da-bdaae3d6c1c2"
}

Error codes

HTTP status code	Error code	Error message	Description
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
400	InvalidParameter.PurchaseTime	%s, please check and try again later.	The parameter PurchaseTime is invalid, please check and try again.
400	InvalidParameter.ExpireTime	%s, please check and try again later.	The parameter ExpireTime is invalid, please check and try again.
400	InvalidParameter	%s.	Parameter error
400	MissingParameter	%s.	Missing parameter
400	InvalidChargeType.Malformed	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidChargeType.PostSupport	%s, please check and try again later.	ChargeType only supports post-paid, please check and try again.
400	InvalidCasterTemplate.Malformed	%s, please check and try again later.	The parameter CasterTemplate is invalid, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.ChargeType	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidPeriod.Malformed	%s, please check and try again later.	Invalid time interval, please check and try again.
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidClientToken.Malformed	%s, please check and try again later.	The parameter ClientToken is invalid, please check and try again.
400	IncorrectCasterStatus	%s, please check and try again later.	Guide station status error, please check and try again.
401	CasterNumberExceed	%s, please check and try again later.	The number of casters exceeds the limit. Please check and try again.
403	PermissionDenied	%s, please check and try again later.	Access denied, please check and try again.
404	InvalidParameter.NormType	%s, please check and try again later.	The parameter NormType is invalid, please check and try again.
404	InvalidConfiguration.NotFound	%s, please check and try again later.	Configuration does not exist, please check and try again.
408	CreateLiveAIStudio.Timeout	%s, please try again later.	Call CreateLiveAIStudio timed out, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.