為了簡化水印任務(wù)的處理過程,視頻點(diǎn)播將復(fù)雜的水印位置、水印大小、水印文字的字體、顏色等水印參數(shù)固化成模板,并通過具有唯一性的水印模板ID來指代。調(diào)用本接口可以添加圖片水印模板或文字水印模板。
接口說明
- 調(diào)用本接口可以添加圖片水印模板(
Image
)或文字水印模板(Text
),其中,圖片水印模板支持如下格式:靜態(tài)圖片(PNG)、動(dòng)態(tài)圖片(GIF、APNG、MOV)。 - 調(diào)用本接口添加圖文水印模板后,您還需調(diào)用 AddTranscodeTemplateGroup 或 UpdateTranscodeTemplateGroup 接口,將圖文水印模板關(guān)聯(lián)到轉(zhuǎn)碼模板組上,以便后續(xù)發(fā)起水印轉(zhuǎn)碼時(shí)選用。
- 為視頻添加圖文水印的詳細(xì)信息,請(qǐng)參見視頻圖文水印。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vod:AddWatermark | *全部資源 * |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Type | string | 是 | 水印模板類型:
| Image |
Name | string | 是 | 水印模板名稱。
| 圖片水印模板 |
WatermarkConfig | string | 是 | 圖文水印的配置信息(JSON 字符串),包括水印顯示位置、水印效果等配置。圖片水印和文字水印的配置參數(shù)不同,參數(shù)結(jié)構(gòu)詳情,請(qǐng)參見 WatermarkConfig 。 | { "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" } |
FileUrl | string | 否 | 水印圖片文件的 OSS 地址(不帶鑒權(quán))。 說明
Type 為Image )時(shí),本參數(shù)必傳。FileURL 的值可作為本參數(shù)的請(qǐng)求參數(shù)。 | http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png |
AppId | string | 否 | 應(yīng)用 ID。默認(rèn)取值:app-1000000。若已開通多應(yīng)用體系,傳入應(yīng)用 ID,可將水印模板添加到指定應(yīng)用下。使用說明,請(qǐng)參見多應(yīng)用體系。 | app-**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfo": {
"CreationTime": "2018-11-07T09:05:52Z",
"Type": "Image",
"IsDefault": "NotDefault",
"FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
"WatermarkConfig": "{\n \"Width\": \"55\",\n \"Height\": \"55\",\n \"Dx\": \"9\",\n \"Dy\": \"9\",\n \"ReferPos\": \"BottomLeft\"\n}",
"Name": "圖片水印模板",
"WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
}
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。