CreateCustomTemplate - - Alibaba Cloud Documentation Center

Operation description

After you call this operation to create a custom template, record the template name. To use the custom template, set the MixStreamTemplate parameter to the template name when you call the CreateMixStream operation to create a stream mixing task.

QPS limits

The queries per second (QPS) limit for this operation is 10 for each user. API calls that exceed this limit are throttled, which can affect your business. Plan your calls accordingly.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CustomTemplate	string	Yes	The template configuration in JSON format. The value must be in the following format: {height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx}. All fields are required. The call fails if any field is missing. Note For more information about the parameters, see the CustomTemplate details table below.	{"height":"1060","scale":"[16:9]","gop":"60","bframes":"30","cdesc":"h264"}
Template	string	Yes	The name of the template to add. Note Record the template name after you create it. The name is required for subsequent operations, such as using, querying, and deleting the template.	TestTemplate

CustomTemplate details

Parameter	Type	Required	Description
height	String	Yes	The height of the output resolution. If scale is set to 16:9, the maximum resolution is 1920 × 1080. If scale is set to 4:3, the maximum resolution is 1440 × 1080.
scale	String	Yes	The aspect ratio of the output resolution. Only string values are accepted. Valid values: [3:4] [4:3] [16:9] [9:16]
bframes	String	Yes	The number of B-frames in the output stream. The value must be greater than 0 and less than 9.
cdesc	String	Yes	The encoding format. Set the value to h264.
gop	String	Yes	The Group of Pictures (GOP) interval. The value must be greater than 25 and less than 250.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0D715397-2E66-4AE1-694h-C546628AD145

Examples

Success response

JSON format

{
  "RequestId": "0D715397-2E66-4AE1-694h-C546628AD145"
}

Error codes

HTTP status code	Error code	Error message
400	TemplateAlreadyExist	%s
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	MissingParameter	%s
400	CustomTemplateInvalid	%s
500	InternalError	%s
404	InvalidDomainName.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.