DescribeLiveAISubtitle - 查詢字幕模板 - ApsaraVideo Live

調用DescribeLiveAISubtitle查詢字幕模板列表。

介面說明

本介面支援指定分頁參數查詢字幕模板列表資訊，調用時請保證參數設定符合要求。

重要

當前即時字幕功能處於邀測階段，單個使用者最多可添加 300 個字幕模板。

QPS 限制

本介面的單使用者 QPS 限制為 60 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveAISubtitle

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
SubtitleId	string	否	字幕模板 ID。	445409ec-7eaa-461d-8f29-4bec2eb9****
SubtitleName	string	否	字幕模板名稱，僅支援數字、大小寫字母或虛線-，虛線不和位於首位。	sub01
PageNumber	string	否	分頁的頁數。取值範圍【1,100】	1
PageSize	string	否	每頁模板數值。取值範圍【1,100】	100
IsDefault	boolean	否	是否查詢字幕預設模版，取值範圍： true，查詢。 false，不查詢。說明預設模版：系統預先內建的參數集，使用者可以通過 AddLiveAISubtitle 介面的 copyFrom 參數使用。	false

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	5c6a2a0df228-4a64- af62-20e91b96****
SubtitleConfigs	object
SubtitleConfig	array<object>	字幕模板資訊列表。
	object	字幕模板資訊對象
DstLanguage	string	翻譯目標語言	zh-CN
SrcLanguage	string	源語言	zh-CN
FontColor	string	字型顏色	0xFFFFFF
FontName	string	字型	AlibabaPuHuiTi-Regular
ShowSourceLan	integer	是否顯示源語言	true
MaxLines	integer	顯示行數	2
WordPerline	integer	每行顯示字數	20
PositionNormalized	object
Position	array	字幕位置資訊
	number	字幕位置	[0.3,0.35]
BgColor	string	字幕背景顏色	0xFF0000
BgWidthNormalized	number	字幕背景尺寸	0.09
BorderWidthNormalized	number	字型粗細	0.05
Width	string	預覽畫面寬度	1280
Height	string	預覽畫面高度	720
SubtitleName	string	字幕模板名稱	sub1
SubtitleId	string	字幕模板 ID	597991f3-6ef9-4100-9238-82951de1****
RulesRefer	object
RulesId	array	字幕規則資訊
	string	字幕規則 ID	1419783e-0dd2-4485-a298-6e4a0e4e****
FontSizeNormalized	string	字型尺寸	0.037
Description	string	描述資訊	live AI subtitle template

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter	%s.	參數錯誤
400	MissingParameter	%s.	參數缺失
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。