Adding watermarks¶
A watermark is burned into a video's encoded renditions at upload time: create a reusable watermark profile once, then select it whenever you upload or fetch a video.
Getting started quickly¶
- Create a watermark profile in the
Project -> Settings -> Watermarkspage. - Select the watermark when uploading videos in the
Project -> Videos -> Video Uploadpage. - Done. The video will use the watermark in all its outputs.
- Create a watermark profile using the create watermark ⧉ endpoint (a multipart form with the image file and the fields below).
- Pass the profile's id as
metadata.watermark_idwhen uploading ⧉ or fetching ⧉ a video. - Done. The video will use the watermark in all its outputs.
Watermark profile options¶
| Field | Type | Default | Meaning |
|---|---|---|---|
title | string | — | Name of the profile (up to 64 characters). |
file | PNG image | — | The watermark image, at most 2 MB. PNG only (transparency supported); the image itself is stored as-is. |
position | enum | upper_right | Where the watermark sits: upper_left, upper_right, lower_left, lower_right, or center. |
scale | 0–1 | 0.1 | Watermark height as a fraction of the video's height; the aspect ratio is preserved. |
opacity | 0–1 | — | 1 is fully opaque, 0 invisible. |
padding | 0–1 | 0.1 | Space between the watermark and the video's edges. Ignored when position is center. |
Behavior¶
- The watermark is burned into the pixels of every encoded rendition — it cannot be removed from a video afterwards, and viewers cannot disable it.
- A watermark profile cannot be edited after creation. To change the image or settings, create a new profile and use it for future uploads; already encoded videos keep the watermark they were encoded with.
- The video's
asset.watermark_idfield reports which watermark a video was encoded with.