Watermarks

List watermark profiles

client.Stream.Watermarks.List(ctx, query) (*SinglePage[Watermark], error)

GET/accounts/{account_id}/stream/watermarks

Watermark profile details

client.Stream.Watermarks.Get(ctx, identifier, query) (*Watermark, error)

GET/accounts/{account_id}/stream/watermarks/{identifier}

Create watermark profiles via basic upload

client.Stream.Watermarks.New(ctx, params) (*Watermark, error)

POST/accounts/{account_id}/stream/watermarks

Delete watermark profiles

client.Stream.Watermarks.Delete(ctx, identifier, body) (*string, error)

DELETE/accounts/{account_id}/stream/watermarks/{identifier}

ModelsExpand Collapse

type Watermark struct{…}

Created Timeoptional

The date and a time a watermark profile was created.

formatdate-time

DownloadedFrom stringoptional

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

Height int64optional

The height of the image in pixels.

Name stringoptional

A short description of the watermark profile.

Opacity float64optional

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 float64optional

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 stringoptional

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

Scale float64optional

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 float64optional

The size of the image in bytes.

UID stringoptional

The unique identifier for a watermark profile.

maxLength32

Width int64optional

The width of the image in pixels.