DescribeLiveAISubtitle - ApsaraVideo Live - Alibaba Cloud Documentation Center

You can call the DescribeLiveAISubtitle operation to query a list of caption templates.

Operation description

This operation supports paging. You can specify paging parameters to query a list of caption templates. When you call this operation, ensure that the parameter settings are valid.

Important

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

QPS limits

The queries per second (QPS) limit for a single user is 60. If the number of calls per second exceeds the limit, throttling is triggered, which may affect your business. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits.

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:DescribeLiveAISubtitle

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
SubtitleId	string	No	The ID of the caption template.	445409ec-7eaa-461d-8f29-4bec2eb9****
SubtitleName	string	No	The name of the caption template. The name can contain only digits, uppercase letters, lowercase letters, and hyphens (-). The name cannot start with a hyphen.	sub01
PageNumber	string	No	The page number. Valid values: 1 to 100.	1
PageSize	string	No	The number of templates on each page. Valid values: 1 to 100.	100
IsDefault	boolean	No	Specifies whether to query the default caption templates. Valid values: true: queries the default caption templates. false: does not query the default caption templates. Note Default templates are built-in parameter sets. You can use them by specifying the copyFrom parameter in the AddLiveAISubtitle operation.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b96****
SubtitleConfigs	object
SubtitleConfig	array<object>	A list of caption template information.
	object	The caption template object.
DstLanguage	string	The destination language for translation.	zh-CN
SrcLanguage	string	The source language.	zh-CN
FontColor	string	The font color.	0xFFFFFF
FontName	string	The font.	AlibabaPuHuiTi-Regular
ShowSourceLan	integer	Specifies whether to display the source language.	true
MaxLines	integer	The number of lines to display.	2
WordPerline	integer	The number of characters per line.	20
PositionNormalized	object
Position	array	The information about the caption position.
	number	The position of the captions.	[0.3,0.35]
BgColor	string	The background color of the captions.	0xFF0000
BgWidthNormalized	number	The size of the caption background.	0.09
BorderWidthNormalized	number	The font weight.	0.05
Width	string	The width of the preview window.	1280
Height	string	The height of the preview window.	720
SubtitleName	string	The name of the caption template.	sub1
SubtitleId	string	The ID of the caption template.	597991f3-6ef9-4100-9238-82951de1****
RulesRefer	object
RulesId	array	The information about the caption rule.
	string	The ID of the caption rule.	1419783e-0dd2-4485-a298-6e4a0e4e****
FontSizeNormalized	string	The font size.	0.037
Description	string	The description.	live AI subtitle template

Examples

Success response

JSON format

{
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b96****",
  "SubtitleConfigs": {
    "SubtitleConfig": [
      {
        "DstLanguage": "zh-CN",
        "SrcLanguage": "zh-CN",
        "FontColor": "0xFFFFFF",
        "FontName": "AlibabaPuHuiTi-Regular",
        "ShowSourceLan": 0,
        "MaxLines": 2,
        "WordPerline": 20,
        "PositionNormalized": {
          "Position": [
            0
          ]
        },
        "BgColor": "0xFF0000",
        "BgWidthNormalized": 0.09,
        "BorderWidthNormalized": 0.05,
        "Width": "1280",
        "Height": "720",
        "SubtitleName": "sub1",
        "SubtitleId": "597991f3-6ef9-4100-9238-82951de1****",
        "RulesRefer": {
          "RulesId": [
            "1419783e-0dd2-4485-a298-6e4a0e4e****"
          ]
        },
        "FontSizeNormalized": "0.037",
        "Description": "live AI subtitle template"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.