Configure Live AI Subtitle Rules for Real-Time Streams - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Adds a subtitle rule.

Operation description

After you call the AddLiveAISubtitle operation to add a subtitle template, you can call this operation to add a subtitle rule.
To play a subtitle stream, append _{subtitle template name} to the StreamName in the streaming 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. A single user can add up to 300 subtitle templates.

QPS limit

The QPS limit for a single user calling this operation is 60 calls per second. If the limit is exceeded, API calls are throttled, which may affect your services. Make API calls at a reasonable frequency.

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 of the streamer.	demo.aliyundoc.com
App	string	Yes	The application name of the live stream. The name can be up to 256 characters in length and can contain digits, letters, hyphens (-), and underscores (_). The template takes effect only when the AppName matches the AppName in the ingest URL.	AppName
Suffix	string	No	The suffix for matching.	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 to trigger subtitle generation upon stream pulling. Valid values: true: Subtitle generation starts when a stream is pulled. If no stream is pulled within 5 minutes, subtitle generation stops and resumes only when a stream is pulled again. false: Subtitle generation starts as long as a stream is ingested, regardless of whether a stream is pulled.	true
LiveTemplate	string	Yes	The output specification of the subtitle. Valid values: `lp_ld`: landscape low definition, 360p, 640×360 `lp_ld_v`: portrait low definition, 360p, 360×640 `lp_sd`: landscape standard definition, 480p, 854×480 `lp_sd_v`: portrait standard definition, 480p, 480×854 `lp_hd`: landscape high definition, 720p, 1280×720 `lp_hd_v`: portrait high definition, 720p, 720×1280 `lp_ud`: landscape ultra-high definition, 1080p, 1920×1080 `lp_ud_v`: portrait ultra-high definition, 1080p, 1080×1920	lp_ld
Description	string	No	The description of the subtitle rule. The description can contain Chinese characters, English letters, digits, and special characters, and can be up to 128 characters in length.	live AI subtitle template

Response elements

Element	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.