DescribeLiveAISubtitle - - Alibaba Cloud Documentation Center

Queries subtitle templates.

Operation description

This interface supports querying the list of subtitle template information with specified pagination parameters. Ensure that the parameter settings meet the requirements when calling.

Notice The real-time subtitle function is currently in the beta testing phase, and each user can add up to 300 subtitle templates.

QPS Limit

The QPS limit for this interface per user is 60 times/second. Exceeding this limit will result in API calls being throttled, which may impact your business operations. Please use it reasonably. For more information, refer to QPS Limitation.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveAISubtitle	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SubtitleId	string	No	The ID of the subtitle template.	445409ec-7eaa-461d-8f29-4bec2eb9****
SubtitleName	string	No	The name of the subtitle template. The name can contain only digits, letters, and hyphens (-). The name cannot start with a hyphen.	sub01
PageNumber	string	No	The page number. Valid values: [1,100].	1
PageSize	string	No	The number of entries per page. Valid values: [1,100].	100
IsDefault	boolean	No	Specifies whether to query the default subtitle template. Valid values: true false Note **The default template includes the built-in parameter configurations. You can specify the copyFrom parameter when you call the AddLiveAISubtitle operation to use the default template.	false

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2024-06-11	The Error code has changed. The request parameters of the API has changed	View Change Details