為了簡化水印任務的處理過程,視頻點播將復雜的水印位置、水印大小、水印文字的字體、顏色等水印參數固化成模板,并通過具有唯一性的水印模板ID來指代。調用本接口可以添加圖片水印模板或文字水印模板。
接口說明
- 調用本接口可以添加圖片水印模板(
Image
)或文字水印模板(Text
),其中,圖片水印模板支持如下格式:靜態圖片(PNG)、動態圖片(GIF、APNG、MOV)。 - 調用本接口添加圖文水印模板后,您還需調用 AddTranscodeTemplateGroup 或 UpdateTranscodeTemplateGroup 接口,將圖文水印模板關聯到轉碼模板組上,以便后續發起水印轉碼時選用。
- 為視頻添加圖文水印的詳細信息,請參見視頻圖文水印。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vod:AddWatermark | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Type | string | 是 | 水印模板類型:
| Image |
Name | string | 是 | 水印模板名稱。
| 圖片水印模板 |
WatermarkConfig | string | 是 | 圖文水印的配置信息(JSON 字符串),包括水印顯示位置、水印效果等配置。圖片水印和文字水印的配置參數不同,參數結構詳情,請參見 WatermarkConfig 。 | { "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" } |
FileUrl | string | 否 | 水印圖片文件的 OSS 地址(不帶鑒權)。 說明
Type 為Image )時,本參數必傳。FileURL 的值可作為本參數的請求參數。 | http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png |
AppId | string | 否 | 應用 ID。默認取值:app-1000000。若已開通多應用體系,傳入應用 ID,可將水印模板添加到指定應用下。使用說明,請參見多應用體系。 | app-**** |
返回參數
示例
正常返回示例
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"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。