Skip to content
Start here

Watermarks

List watermark profiles
stream.watermarks.list(WatermarkListParams**kwargs) -> SyncSinglePage[Watermark]
GET/accounts/{account_id}/stream/watermarks
Watermark profile details
stream.watermarks.get(stridentifier, WatermarkGetParams**kwargs) -> Watermark
GET/accounts/{account_id}/stream/watermarks/{identifier}
Create watermark profiles via basic upload
stream.watermarks.create(WatermarkCreateParams**kwargs) -> Watermark
POST/accounts/{account_id}/stream/watermarks
Delete watermark profiles
stream.watermarks.delete(stridentifier, WatermarkDeleteParams**kwargs) -> WatermarkDeleteResponse
DELETE/accounts/{account_id}/stream/watermarks/{identifier}
ModelsExpand Collapse
class Watermark:
created: Optional[datetime]

The date and a time a watermark profile was created.

formatdate-time
downloaded_from: Optional[str]

The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.

height: Optional[int]

The height of the image in pixels.

name: Optional[str]

A short description of the watermark profile.

opacity: Optional[float]

The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.

maximum1
minimum0
padding: Optional[float]

The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.

maximum1
minimum0
position: Optional[str]

The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.

scale: Optional[float]

The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0 fills the entire video.

maximum1
minimum0
size: Optional[float]

The size of the image in bytes.

uid: Optional[str]

The unique identifier for a watermark profile.

maxLength32
width: Optional[int]

The width of the image in pixels.

str