調用AddLiveAISubtitle添加字幕模板。
介面說明
使用說明
本介面支援添加直播字幕模板配置,模板配置支援描述字幕內容、布局等資訊。
添加字幕模板後,您還需要調用 AddLiveAIProduceRules 介面添加字幕規則,重新推流後,播流中才能帶字幕。
即時字幕僅支援北京、上海、新加坡、印尼、沙特地區。
當前即時字幕功能處於公測階段,單個使用者最多可添加 300 個字幕模板。暫時免費使用,公測結束後將正常收費,具體時間另行通知。
QPS 限制
本介面的單使用者 QPS 限制為 60 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。更多資訊,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:AddLiveAISubtitle |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| SubtitleName |
string |
是 |
字幕模板名稱,僅支援數字、大小寫字母或虛線-,虛線不和位於首位。 |
sub01 |
| SrcLanguage |
string |
是 |
源語言,取值:
|
zh-CN |
| DstLanguage |
string |
否 |
翻譯目標語言,取值:
|
zh-CN |
| FontColor |
string |
否 |
字型顏色,RGBA 值。 |
0xFFFFFF |
| FontName |
string |
否 |
字型,取值:
|
KaiTi |
| BgColor |
string |
否 |
字幕背景顏色,RGBA 值。 |
0xFF0000 |
| PositionNormalized |
array |
是 |
字幕位置資訊 |
|
|
number |
否 |
字幕位置。以螢幕左下角為起點的 x,y 軸。 說明
x,y 需要進行歸一化計算。實際數值需要乘以畫面高度。如畫面高度為 720p 設定的 PositionNormalized 為[0.1,0.5] ,則字幕的實際位置是 x 軸為 72,y 軸為 360。 |
[0.32,0.27] |
|
| ShowSourceLan |
boolean |
否 |
是否顯示源語言,ShowSourceLan 預設為 false。 |
true |
| MaxLines |
integer |
否 |
顯示行數。 |
2 |
| WordPerLine |
integer |
是 |
每行顯示字數,取值範圍:支援輸入【1,500】內的整數。 |
20 |
| FontSizeNormalized |
number |
是 |
字型尺寸,取值範圍:【0,1】 |
0.037 |
| BorderWidthNormalized |
number |
否 |
字型粗細,取值範圍:【0,1】 |
0.05 |
| BgWidthNormalized |
number |
否 |
字幕背景尺寸,取值範圍:【0,1】 |
0.09 |
| CopyFrom |
string |
否 |
複製的字幕模板,傳值 SubtitleName |
sub01 |
| Description |
string |
否 |
自訂字幕描述資訊。可包含中英文、數字、字元,不超過 128 位。 |
live AI subtitle template |
| Width |
string |
否 |
預覽畫面寬度,單位:px |
1280 |
| Height |
string |
否 |
預覽畫面高度,單位:px 預覽畫面寬度 x 高度僅支援以下規格:
|
720 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
5c6a2a0df228-4a64-af62-20e91b96**** |
| SubtitleId |
string |
字幕模板 ID。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "5c6a2a0df228-4a64-af62-20e91b96****",
"SubtitleId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s. | 參數錯誤 |
| 400 | MissingParameter | %s. | 參數缺失 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在無效參數:%s。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。