Watermarking

Overlay a visible watermark on your source video with this filter.

🚧

Note

Watermarking is not available for the image output.

For more information on how to position a watermark, please see this article.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <!-- Format fields -->
        <logo>
            <logo_source>[LogoURL]</logo_source> <!-- required-->
            <logo_x>[LogoLeft]</logo_x>
            <logo_y>[LogoTop]</logo_y>
            <logo_mode>[LogoMode]</logo_mode>
            <logo_threshold>[LogoTreshold]</logo_threshold>
            <logo_transparent>[LogoTransparent]</logo_transparent>
            <!-- logo_transparent is alias for logo_threshold -->
        </logo>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "logo": {
                "logo_source": "[LogoURL]",
                "logo_x": "[LogoLeft]",
                "logo_y": "[LogoTop]",
                "logo_mode": "[LogoMode]",
                "logo_threshold": "[LogoTreshold]",
                "logo_transparent": "[LogoTransparent]"
            }
        }
    }
}

Parameter

Description

Allowed Values

Default Value

logo_source

Specify the URL of the logo image. The image format can be GIF, JPG or PNG.

http://[user[:password]@]hostname[:port]/[path]/[filename]

ftp://[user[:password]@]hostname[:port]/[path]/[filename][?passive=yes]

sftp://[user[:password]@]hostname[:port]/[path]/[filename]

None

logo_x

Specify the left offset of logo image.

Positive integer

10

logo_y

Specify the top offset of logo image.

Positive integer

10

logo_mode

Specify the video and watermarking picture mixing mode.

0: If the mask color matches the threshold, the logo will be transparent and only the video will be shown.

1: If the mask color is lighter or darker than the threshold value, the logo (watermark) will appear.

1

logo_threshold or logo_transparent

Specify the threshold color mask.

6-digit hexadecimal 000000—FFFFFF
Examples:
000000 — sets color black to transparent mask
808080 — sets color gray to transparent mask

000000

❗️

For logo_source parameter

<logo_source /> is a required parameter.

📘

For logo_mode parameter

If your logo source is PNG with alpha-channel, set <logo_mode /> equal to 1 to keep transparency.