UpdateLiveAISubtitle - ApsaraVideo Live - Alibaba Cloud Documentation Center

Updates a subtitle template.

Operation description

Usage notes

You can use this operation to modify the parameters of a specific caption template.

Important

The real-time caption feature is in invitational preview. A maximum of 300 caption templates can be added per user.

QPS limits

The queries per second (QPS) limit for this operation is 60 calls per second per user. API calls that exceed this limit are throttled, which may affect your business. Plan your API calls accordingly. For more information, see QPS limits.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
SubtitleName	string	No	The name of the caption template. The name can contain only digits, letters, and hyphens (-). The name cannot start with a hyphen.	live AI subtitle template
SrcLanguage	string	No	The source language. Valid values: en-US: English zh-CN: Chinese ru-RU: Russian	zh-CN
DstLanguage	string	No	The target language for translation. Valid values: en-US: English zh-CN: Chinese es-ES: Spanish ru-RU: Russian	zh-CN
FontColor	string	No	The font color, specified as an RGBA value.	0xFFFFFF
FontName	string	No	The font. Valid values: KaiTi (default) AlibabaPuHuiTi-Regular AlibabaPuHuiTi-Bold AlibabaPuHuiTi-Light NotoSansHans-Regular NotoSansHans-Bold NotoSansHans-Light	KaiTi
BgColor	string	No	The background color of the captions, specified as an RGBA value.	0xFF0000
PositionNormalized	array	No	The position of the captions.
	number	No	The position of the captions, represented by x and y coordinates. The origin (0,0) is the lower-left corner of the screen.	[0.32,0.27]
ShowSourceLan	boolean	No	Specifies whether to show the source language. Default value: false.	true
MaxLines	integer	No	The number of lines to display.	2
WordPerLine	integer	No	The number of characters per line. The value must be an integer from 1 to 500.	20
FontSizeNormalized	number	No	The font size. The value must be between 0 and 1.	0.037
BorderWidthNormalized	number	No	The width of the font border. The value must be between 0 and 1.	0.05
BgWidthNormalized	number	No	The width of the background area. The value must be between 0 and 1.	0.09
SubtitleId	string	Yes	The ID of the caption template.	597991f3-6ef9-4100-9238-82951de1****
Description	string	No	The custom description of the caption template. The description can contain letters, digits, and special characters. It can be up to 128 characters long.	live AI subtitle template
Width	string	No	The width of the preview window in pixels.	1280
Height	string	No	The height of the preview window in pixels. The preview window supports only the following resolutions (width × height): 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	720

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	String 5c6a2a0df228-4a64- af62-20e91b96****

Examples

Success response

JSON format

{
  "RequestId": "String\t5c6a2a0df228-4a64- af62-20e91b96****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter	%s.	Parameter error
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.