All URIs are relative to https://ws.api.video
| Method | Description | HTTP request |
|---|---|---|
| upload() | Upload a watermark | POST /watermarks |
| delete() | Delete a watermark | DELETE /watermarks/{watermarkId} |
| list() | List all watermarks | GET /watermarks |
Create a new watermark by uploading a JPG or a PNG image.
| Name | Type | Required | Description |
|---|---|---|---|
| file | string | Readable | Buffer | yes | The `.jpg` or `.png` image to be added as a watermark. |
Promise<Watermark>.
Delete a watermark.
| Name | Type | Required | Description |
|---|---|---|---|
| watermarkId | string | yes | The watermark ID for the watermark you want to delete. |
Promise<void>.
List all watermarks associated with your workspace.
| Name | Type | Required | Description |
|---|---|---|---|
| sortBy | string | no | Allowed: createdAt. You can search by the time watermark were created at. |
| sortOrder | string | no | Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. |
| currentPage | number | no | Choose the number of search results to return per page. Minimum value: 1 |
| pageSize | number | no | Results per page. Allowed values 1-100, default is 25. |
Promise<WatermarksListResponse>.