添加水印_视频水印_媒体处理_服务端API

描述

添加水印数据。

注意：目前支持的图片水印格式包括静态(PNG)、动态(GIF、APNG、MOV)。

请求参数

参数名称	参数类型	必填项	描述
Action	String	是	接口名称，取值：AddWatermark
Name	String	是	水印名称。只支持中英文、数字。长度不超过128个字节 UTF-8编码
Type	String	是	水印类型：Image(图片)、Text(文字)，默认取值：Image。水印类型不同，WatermarkConfig内容不同。
WatermarkConfig	WatermarkConfig	是	水印显示位置、效果等配置(JSON字符串)。不同的水印类型对应不同的WatermarkConfig内容。
FileUrl	String	否	水印文件oss地址。图片水印必传。
AppId	String	否	应用ID。取值如：app-1000000。使用说明参考文档多应用。

注：水印文件上传参见CreateUploadAttachedMedia

返回参数

参数名称	参数类型	描述
RequestId	String	请求ID
WatermarkInfo	WatermarkInfo	水印信息

API示例

请求示例

https://vod.cn-shanghai.aliyuncs.com?Action=AddWatermark&Type=Image&Name=test&FileUrl=http://outin-3262681cddeb00163e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C9934515B1EF727EBAE7FDEC-6-2.png&WatermarkConfig={"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}

返回示例

JSON格式

文字水印

 {
    "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
      "WatermarkInfo": {
          "Name": "文字水印测试",
          "CreationTime": "2018-11-07T09:05:52Z",
          "IsDefault": "NotDefault",
          "Type": "Text",
          "WatermarkId": "9bcc8bfadb843f475c109a2671d0df97",
          "WatermarkConfig": {
            "FontColor": "Blue",
            "FontSize": 80,
            "Content": "水印测试"
          }
      }
 }

图片水印

 {
   "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
   "WatermarkInfo":{
      "Name": "图片水印测试",
      "CreationTime": "2018-11-06T08:03:17Z",
      "WatermarkId": "505e2e287ea49c40f8cecfddd386d384",
      "FileUrl": "https://outin-3262681cdde111e89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=XXXXXXX&Signature=gmf1eYMoDVg%2BHQCb4UGozBW4xZo%3D",
      "IsDefault": "NotDefault",
      "Type": "Image",
      "WatermarkConfig": {
        "ReferPos": "BottomRight",
        "Type": "Image",
        "Height": "55",
        "Width": "55",
        "Dx": "8",
        "Dy": "8"
      }
    }
  }

错误码

下表列举了本接口特有的错误码。视频点播通用的错误码信息，参见错误码表。

错误代码	错误信息	HTTP 状态码	说明
NoSuchResource	The specified resource %s does not exist.	404	用户相关的资源数据不存在， %s表示具体资源信息。

SDK示例

建议使用服务端SDK 来调用API，此API各语言调用的示例代码，请参考如下：