文档

AddImageMosaic - 添加图片马赛克

更新时间:

在一张图片的一个或多个特定区域内添加多种形状的马赛克、高斯模糊或纯色块,并将填充后的图片保存到指定的OSS文件对象地址。该功能主要用于隐私保护。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 调用该接口前,请确保当前 Region 已经存在可用的项目(Project),详见项目管理
  • 该接口支持的输入图片编码格式为 jpg 与 png,单边长不超过 30000 像素,总像素不超过 2.5 亿像素。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
SourceURIstring

源图片的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

支持的图片格式:jpg,png,tiff,jp2,bmp。

oss://examplebucket/sampleobject.jpg
TargetURIstring

输出图片存储的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://examplebucket/outputImage.jpg
ImageFormatstring

图片保存时的编码格式。可取值为 jpg、png、webp,默认与输入图片编码格式相同。

jpg
Qualityinteger

输出图片的压缩质量,仅限 jpg 和 webp 图片格式。设置范围为 0~100,默认为 80。

80
Targetsobject []

处理框及操作类别参数数组。

Typestring

添加的马赛克类型。可取值如下:

  • square:方形的马赛克
  • diamond:菱形的马赛克
  • hexagon:正六边形的马赛克
  • blur:高斯模糊
  • pure:纯色块
square
Boundaryobject

处理框位置信息。

ReferPosstring

处理框在图片上的基准位置。可取值如下:

  • topright:右上方
  • topleft(默认):左上方
  • bottomright:右下方
  • bottomleft:左下方
topleft
Xfloat

处理框相较于基准点的水平偏移,不同取值的含义如下:

  • 取值为大于等于 0 的整数:表示距离基准位置的横向距离,单位为 px。
  • 取值为小数:表示横向距离像素值与图片整体宽度的比值,取值范围为[0,1)。
0
Yfloat

处理框相较于基准点的垂直偏移,不同取值的含义如下:

  • 取值为大于等于 0 的整数:表示距离基准位置的纵向距离,单位为 px。
  • 取值为小数:表示纵向距离像素值与图片整体高度的比值,取值范围为[0,1)。
0
Heightfloat

处理框的高,不同取值的含义如下:

  • 取值为大于等于 0 的整数:表示处理框高度,单位为 px。
  • 取值为小数:表示框纵向长度像素值与图片整体高度的比值,取值范围为[0,1)。
200
Widthfloat

处理框的宽,不同取值的含义如下:

  • 取值为大于等于 0 的整数:表示处理框宽度,单位为 px。
  • 取值为小数:表示框横向长度像素值与图片整体宽度的比值,取值范围为[0,1)。
200
MosaicRadiusinteger

马赛克小块的半径大小。默认值为 5,单位为 px。

说明 该参数对于添加高斯模糊与纯色块不生效。
5
BlurRadiusinteger

高斯模糊的模糊半径,取值范围为 1~50,默认值为 3,单位为 px。

说明 该参数仅在添加高斯模糊时生效。
3
Sigmainteger

高斯模糊的标准差,取值必须大于 0,默认值为 5。

说明 该参数仅在添加高斯模糊时生效。
5
Colorstring

纯色块的颜色,支持#FFFFFF形式与预设的redwhite等关键字。默认值为#FFFFFF,即白色。

说明 该参数仅在添加纯色块时生效。
#FFFFFF
CredentialConfigCredentialConfig

链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

CA995EFD-083D-4F40-BE8A-BDF75FF*****

示例

正常返回示例

JSON格式

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FF*****"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈