Adds a subtitle rule.
Operation description
-
After you call the AddLiveAISubtitle operation to add a subtitle template, you can call this operation to create a subtitle rule for the template.
-
You must add "_Subtitle template name" after the stream name in the streaming URL to play the subtitle stream.
- 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}
QPS limit
You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:AddLiveAIProduceRules | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Domain | string | Yes | The main streaming domain. | demo.aliyundoc.com |
| App | string | Yes | The name of the application to which the live stream belongs. | AppName |
| Suffix | string | No | suffix match | test01 |
| SubtitleName | string | No | The name of the subtitle template. | sub01 |
| StudioName | string | No | Virtual background template name | sub02 |
| IsLazy | boolean | No | Specifies whether to trigger the subtitle rule when stream pulling starts. Valid values:
| true |
| LiveTemplate | string | Yes | The specification of the output subtitles. Valid values:
| lp_ld |
| Description | string | No | The description of the subtitle rule. The description can be up to 128 characters in length and can contain letters, digits, and special characters. | live AI subtitle template |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-14 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-07-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |