AddLiveAIProduceRules - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds a subtitle rule.

Operation description

After you add a subtitle template by calling the AddLiveAISubtitle operation, you can call this operation to add a subtitle rule.
To play a subtitle stream, append _{Subtitle template name} to the StreamName in the playback URL.
- RTMP: rtmp://example.aliyundoc.com/app/stream_{Subtitle template name}?auth_key={access token}
- FLV: http://example.aliyundoc.com/app/stream_{Subtitle template name}.flv?auth_key={access token}
- M3U8: http://example.aliyundoc.com/app/stream_{Subtitle template name}.m3u8?auth_key={access token}

Important

The real-time subtitle feature is in invitational preview. You can add up to 300 subtitle templates.

QPS limits

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

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 streaming domain.	demo.aliyundoc.com
App	string	Yes	The name of the live streaming application. The name can be up to 256 characters long and can contain digits, uppercase and lowercase letters, hyphens (-), and underscores (_). The AppName must match the AppName in the ingest URL for the template to take effect.	AppName
Suffix	string	No	The suffix to match.	test01
SubtitleName	string	No	The name of the subtitle template.	sub01
StudioName	string	No	The name of the virtual background template.	sub02
IsLazy	boolean	No	Specifies whether the rule is triggered by stream pulling. Valid values: true: Subtitles are generated when stream pulling starts. If no stream is pulled for 5 minutes, subtitle generation stops. Subtitle generation resumes when stream pulling starts again. false: Subtitles are generated when stream ingest starts, regardless of whether a stream is being pulled.	true
LiveTemplate	string	Yes	The specifications of the output subtitles. 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
Description	string	No	The description of the subtitle rule. The description can contain Chinese and English characters, digits, and special characters. It can be up to 128 characters in length.	live AI subtitle template

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0df228-4a64-af62-20e91b96****
RulesId	string	The ID of the subtitle rule.	445409ec-7eaa-461d-8f29-4bec2eb9****

Examples

Success response

JSON format

{
  "RequestId": "5c6a2a0df228-4a64-af62-20e91b96****",
  "RulesId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
}

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.