All Products
Search
Document Center

:UpdateLiveAIProduceRules

Last Updated:Dec 05, 2024
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Updates a subtitle rule.

Operation description

You can call this operation to modify the parameters of a specified subtitle rule.

Note The live subtitles feature is in invitational preview. You can add up to 300 subtitle templates.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
live:UpdateLiveAIProduceRulescreate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainstringYes

The main streaming domain.

demo.aliyundoc.com
AppstringYes

The name of the application to which the live stream belongs.

AppName
SuffixstringNo

The suffix to match.

test01
SubtitleNamestringNo

The name of the subtitle template.

sub01
StudioNamestringNo

The name of the virtual background template.

sub02
IsLazybooleanNo

Specifies whether to generate live subtitles when stream pulling starts. Valid values:

  • true: generates live subtitles when stream pulling starts and stops generating live subtitles when no streams are pulled for 5 minutes. When stream pulling restarts, live subtitles are generated again.
  • false: generates live subtitles when stream ingest starts.
true
RulesIdstringNo

The ID of the subtitle rule.

445409ec-7eaa-461d -8f29-4bec2eb9****
LiveTemplatestringNo

The specification of the output subtitles. Valid values:

  • lp_ld: 360p (640 × 360)
  • lp_ld_v: 360p (360 × 640)
  • lp_sd: 480p (854 × 480)
  • lp_sd_v: 480p (480 × 854)
  • lp_hd: 720p (1280 × 720)
  • lp_hd_v: 720p (720 × 1280)
  • lp_ud: 1080p (1920 × 1080)
  • lp_ud_v: 1080p (1080 × 1920)
lp_ld
SubtitleIdstringNo

The ID of the subtitle template.

445409ec-7eaa-461d-8f29-4bec2eb9****
DescriptionstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5c6a2a0df228-4a64-af62-20e91b96****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400MissingParameter%s.Missing parameter
400InvalidParameter%s.Parameter error

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-14The Error code has changed. The request parameters of the API has changedView Change Details
2024-07-04The Error code has changed. The request parameters of the API has changedView Change Details