調用ModifyCasterComponent修改導播台組件。
介面說明
調用本介面修改導播台組件。本介面目前支援的組件類型為文字組件、圖片組件和翻譯跑馬燈元件。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ModifyCasterComponent |
update |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| CasterId |
string |
是 |
導播台 ID。
說明
直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
| ComponentId |
string |
是 |
組件 ID。如果您通過 AddCasterComponent 介面添加導播台組件,請查看 AddCasterComponent 介面調用返回的參數 ComponentId 值。 |
05ab713c-676e-49c0-96ce-cc408da1**** |
| ComponentName |
string |
否 |
組件名稱,預設為組件 ID。 |
text01 |
| ComponentType |
string |
否 |
組件的類型。取值:
|
text |
| Effect |
string |
否 |
組件顯示的特效。取值:
|
animateV |
| ComponentLayer |
string |
否 |
Layer 的尺寸,布局等資訊。格式為 JSON。設定元素說明如下:
|
{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
| TextLayerContent |
string |
否 |
Layer 元素屬性。格式為 JSON。元素屬性說明如下: 重要
當 ComponentType 取值為 text 時,本參數必傳。
|
{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"} |
| ImageLayerContent |
string |
否 |
Layer 元素屬性。格式為 JSON。 重要
當 ComponentType 為 image 時,本參數必傳。 MaterialId 為媒資庫素材 ID。 |
{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d5ecf"} |
| CaptionLayerContent |
string |
否 |
Layer 元素屬性。格式為 JSON。元素屬性說明如下: 重要
當 ComponentType 為 caption 時,本參數必傳。
|
{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"} |
導播台字型說明
字型 | FontName 取值 |
楷體 | KaiTi |
阿里巴巴普惠體-常規 | AlibabaPuHuiTi-Regular |
阿里巴巴普惠體-粗體 | AlibabaPuHuiTi-Bold |
阿里巴巴普惠體-細體 | AlibabaPuHuiTi-Light |
思源黑體-常規 | NotoSansHans-Regular |
思源黑體-粗體 | NotoSansHans-Bold |
思源黑體-細體 | NotoSansHans-Light |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| ComponentId |
string |
組件 ID。可作為查詢導播台組件列表的請求參數。 |
05ab713c-676e-49c0-96ce-cc408da1**** |
| RequestId |
string |
請求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
樣本
正常返回樣本
JSON格式
{
"ComponentId": "05ab713c-676e-49c0-96ce-cc408da1****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidUserId.Malformed | %s | |
| 400 | InvalidCasterId.Malformed | %s | |
| 400 | MissingParameter | %s | |
| 400 | InvalidParameter.Malformed | %s | |
| 400 | InvalidPositionNormalized.Malformed | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 404 | InvalidCaster.NotFound | %s | |
| 404 | InvalidComponent.NotFound | %s | |
| 404 | CanvasNotExist | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。