UpdateLiveAIProduceRules - ApsaraVideo Live - Alibaba Cloud Documentation Center

Updates a caption rule.

Operation description

This operation updates the parameters for a specified caption rule.

Important

The real-time caption feature is in invitational preview. Each user can add a maximum of 300 caption templates.

QPS limit

The queries per second (QPS) limit for this API operation is 60 per user. If you exceed this limit, API calls are throttled. This may affect your business. Plan your API 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:UpdateLiveAIProduceRules

create

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Domain	string	Yes	The primary playback domain name.	demo.aliyundoc.com
App	string	Yes	The name of the live streaming application.	AppName
Suffix	string	No	The suffix to match.	test01
SubtitleName	string	No	The name of the caption template.	sub01
StudioName	string	No	The name of the virtual background template.	sub02
IsLazy	boolean	No	Specifies whether the caption is triggered by stream pulling. Valid values: true: The caption is enabled when stream pulling starts. If no stream pulling occurs within 5 minutes, the caption is disabled. The caption is enabled again the next time stream pulling starts. false: The caption is enabled as long as stream ingest is active, regardless of whether stream pulling is active.	true
RulesId	string	No	The ID of the caption rule.	445409ec-7eaa-461d -8f29-4bec2eb9****
LiveTemplate	string	No	The specifications of the output caption. Valid values: Landscape low definition (360p, 640 × 360): `lp_ld` Portrait low definition (360p, 360 × 640): `lp_ld_v` Landscape standard definition (480p, 854 × 480): `lp_sd` Portrait standard definition (480p, 480 × 854): `lp_sd_v` Landscape high definition (720p, 1280 × 720): `lp_hd` Portrait high definition (720p, 720 × 1280): `lp_hd_v` Landscape ultra-high definition (1080p, 1920 × 1080): `lp_ud` Portrait ultra-high definition (1080p, 1080 × 1920): `lp_ud_v`	lp_ld
SubtitleId	string	No	The ID of the caption template.	445409ec-7eaa-461d-8f29-4bec2eb9****
Description	string	No	The description of the caption rule. The description can be up to 128 characters long and can contain Chinese characters, letters, digits, and special characters.	live AI subtitle template

Response parameters

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

Examples

Success response

JSON format

{
  "RequestId": "5c6a2a0df228-4a64-af62-20e91b96****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter	%s.	Parameter error

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.