Updated on 2024-02-29 GMT+08:00

Text Watermarks

Text watermark parameters are the parameters used when adding text watermarks. These parameters include the font size, type, and color of texts. Table 1 lists the descriptions for text watermark parameters in detail.

Table 1 Text watermark parameters

Parameter

Value Description

Code Example

text

Required parameter when adding text watermarks.

NOTICE:

The parameter value must be encoded using URL-safe Base64, for example, encodeText = url_safe_base64_encode(fontText), with a maximum length of 64 characters.

image/watermark,text_SGVsbG8g5Zu-

54mH5pyN5YqhIQ,size_60,color_FF0000,type_

ZmFuZ3poZW5nc2h1c29uZw==,g_center,rotate_30

size

Optional parameter that represents the font size of watermarks. It ranges from 0 to 1000, and it is set to 40 by default.

type

Optional parameter that represents the font type of watermarks. Table 2 shows the values in detail. The default value is wqy-zenhei (the value after encoding is d3F5LXplbmhlaQ).

NOTICE:

- The parameter value must be encoded using URL-safe Base64, for example, encodeText = url_safe_base64_encode(fontType).

- Line breaks are currently not supported.

color

Optional parameter that represents the font color of watermarks.

The value is a six-digit hexadecimal code, from 000000 to FFFFFF (which represents black and is the default value).

shadow

Optional parameter that represents the extent of transparency of text watermarks. It ranges from 0 to 100.

fill

Optional parameter, representing the overspread effect of watermarks. The value can be 0 or 1.

  • 0: No effect.
  • 1: Overspread.

rotate

Optional parameter, representing the clockwise angle of text watermarks. The angle is larger than 0 and smaller than 360 degrees.

Table 2 Cross reference for font type encoding

Parameter

Value After URL base64 Encoding

Value Description

Remarks

droidsansfallback

ZHJvaWRzYW5zZmFsbGJhY2s=

DroidSansFallback

According to Request For Comments (RFC), the fuller "=" can be omitted, and the value becomes ZHJvaWRzYW5zZmFsbGJhY2s.

fangzhengfangsong

ZmFuZ3poZW5nZmFuZ3Nvbmc=

FZFongSong

According to RFC, the fuller "=" can be omitted, and the value becomes ZmFuZ3poZW5nZmFuZ3Nvbmc.

fangzhengheiti

ZmFuZ3poZW5naGVpdGk=

FZSimHei

According to RFC, the fuller "=" can be omitted, and the value becomes ZmFuZ3poZW5naGVpdGk.

fangzhengkaiti

ZmFuZ3poZW5na2FpdGk=

FZKaiTi

According to RFC, the fuller "=" can be omitted, and the value becomes ZmFuZ3poZW5na2FpdGk.

fangzhengshusong

ZmFuZ3poZW5nc2h1c29uZw==

FZShuSong

According to RFC, the fuller "=" can be omitted, and the value becomes ZmFuZ3poZW5nc2h1c29uZw.

wqy-microhei

d3F5LW1pY3JvaGVp

WenQuanYi Micro Hei

-

wqy-zenhei

d3F5LXplbmhlaQ==

WenQuanYi Zen Hei

According to RFC, the fuller "=" can be omitted, and the value becomes d3F5LXplbmhlaQ.

API Call Examples

  • Add a text watermark Hello to the original image. Set text size to 60, color to red, and font to FZShuSong.

    Parameters are as follows:

    URL Base64 code: SGVsbG8g5Zu, namely text_SGVsbG8g5Zu

    Font size: size_60

    Font color: color_FF0000

    Font type: type_ZmFuZ3poZW5nc2h1c29uZw==

    The URL request is as follows:

    https://obs.region.example.com/image-demo/example.jpg?x-image-process=image/watermark,text_SGVsbG8g5Zu,size_60,color_FF0000,type_ZmFuZ3poZW5nc2h1c29uZw==

  • Add the text watermark to the original image and center the watermark. Rotate the text 30 degrees clockwise. Other parameters are set in a way similar to the previous example.

    https://obs.region.example.com/image-demo/example.jpg?x-image-process=image/watermark,text_SGVsbG8g5Zu,size_60,color_FF0000,type_ZmFuZ3poZW5nc2h1c29uZw==,g_center,rotate_30

  • Insert image and text watermarks at the same time. Put the text watermark Hello at the bottom right, with font size set to 60, shadow to 50, and color to red.

    Use the image watermark logo.png, with both horizontal and vertical margins set to 10.

    Set the transparency of this mixed watermark to 50 and put the image in front and the text behind, in the bottom alignment.

    https://obs.region.example.com/image-demo/example.jpg?x-image-process=image/watermark,image_ZS1zaGFyZS9pbWFnZS1kZW1vL2xvZ28ucG5n,text_SGVsbG8g5Zu,size_60,color_FF0000,shadow_50,type_ZmFuZ3poZW5nc2h1c29uZw==,g_br,x_10,y_10,align_2,order_0

  • Insert an image watermark and a text watermark separately. Put the text watermark Hello at the bottom right, with font size set to 60 and color to red.

    Use the image watermark logo.png, with the horizontal margin set to 40 and vertical margin to 10.

    Set the transparency of the image watermark to 90. The image watermark is inserted first, and then the text watermark.

    https://obs.region.example.com/example.jpg?x-image-process=image/watermark,image_ZS1zaGFyZS9pbWFnZS1kZW1vL2xvZ28ucG5n,g_br,t_90,x_45,y_10/watermark,text_SGVsbG8g5Zu,size_60,color_FF0000,type_ZmFuZ3poZW5nc2h1c29uZw==,g_br,x_0,y_330