Interface StreamWatermarks

interface StreamWatermarks {
    delete(watermarkId: string): Promise<void>;
    generate(
        input: ReadableStream,
        params: StreamWatermarkCreateParams,
    ): Promise<StreamWatermark>;
    generate(
        url: string,
        params: StreamWatermarkCreateParams,
    ): Promise<StreamWatermark>;
    get(watermarkId: string): Promise<StreamWatermark>;
    list(): Promise<StreamWatermark[]>;
}

Index

Methods

delete generate get list

Methods

delete

delete(watermarkId: string): Promise<void>
Deletes a watermark profile.
Parameters
- watermarkId: string
  The watermark profile identifier.
Returns Promise<void>
A promise that resolves when deletion completes.

Throws
if the watermark is not found

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13514

generate

generate(
input: ReadableStream,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>
Generate a new watermark profile
Parameters
- input: ReadableStream
  The image stream to upload
- params: StreamWatermarkCreateParams
  The watermark creation parameters.
Returns Promise<StreamWatermark>
The created watermark profile.

Throws
if the parameters are invalid

Throws
if the URL is invalid

Throws
if the number of allowed watermarks is reached

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13481
generate(
url: string,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>
Generate a new watermark profile
Parameters
- url: string
  The image url to upload
- params: StreamWatermarkCreateParams
  The watermark creation parameters.
Returns Promise<StreamWatermark>
The created watermark profile.

Throws
if the parameters are invalid

Throws
if the URL is invalid

Throws
if the number of allowed watermarks is reached

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13492

get

get(watermarkId: string): Promise<StreamWatermark>
Retrieves details for a single watermark profile.
Parameters
- watermarkId: string
  The watermark profile identifier.
Returns Promise<StreamWatermark>
The watermark profile details.

Throws
if the watermark is not found

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13506

list

list(): Promise<StreamWatermark[]>
Lists all watermark profiles for an account.

Returns Promise<StreamWatermark[]>
The list of watermark profiles.

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13498