cloudflare/resources/stream/watermarks.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as WatermarksAPI from 'cloudflare/resources/stream/watermarks';
import { SinglePage } from 'cloudflare/pagination';
export declare class Watermarks extends APIResource {
    /**
     * Creates watermark profiles using a single `HTTP POST multipart/form-data`
     * request.
     */
    create(params: WatermarkCreateParams, options?: Core.RequestOptions): Core.APIPromise<Watermark>;
    /**
     * Lists all watermark profiles for an account.
     */
    list(params: WatermarkListParams, options?: Core.RequestOptions): Core.PagePromise<WatermarksSinglePage, Watermark>;
    /**
     * Deletes a watermark profile.
     */
    delete(identifier: string, params: WatermarkDeleteParams, options?: Core.RequestOptions): Core.APIPromise<WatermarkDeleteResponse>;
    /**
     * Retrieves details for a single watermark profile.
     */
    get(identifier: string, params: WatermarkGetParams, options?: Core.RequestOptions): Core.APIPromise<Watermark>;
}
export declare class WatermarksSinglePage extends SinglePage<Watermark> {
}
export interface Watermark {
    /**
     * The date and a time a watermark profile was created.
     */
    created?: string;
    /**
     * The source URL for a downloaded image. If the watermark profile was created via
     * direct upload, this field is null.
     */
    downloadedFrom?: string;
    /**
     * The height of the image in pixels.
     */
    height?: number;
    /**
     * A short description of the watermark profile.
     */
    name?: string;
    /**
     * 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.
     */
    opacity?: number;
    /**
     * 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.
     */
    padding?: number;
    /**
     * The location of the image. Valid positions are: `upperRight`, `upperLeft`,
     * `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the
     * `padding` parameter.
     */
    position?: string;
    /**
     * 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.
     */
    scale?: number;
    /**
     * The size of the image in bytes.
     */
    size?: number;
    /**
     * The unique identifier for a watermark profile.
     */
    uid?: string;
    /**
     * The width of the image in pixels.
     */
    width?: number;
}
export type WatermarkDeleteResponse = unknown | string;
export interface WatermarkCreateParams {
    /**
     * Path param: The account identifier tag.
     */
    account_id: string;
    /**
     * Body param: The image file to upload.
     */
    file: string;
    /**
     * Body param: A short description of the watermark profile.
     */
    name?: string;
    /**
     * Body param: 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.
     */
    opacity?: number;
    /**
     * Body param: 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.
     */
    padding?: number;
    /**
     * Body param: The location of the image. Valid positions are: `upperRight`,
     * `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores
     * the `padding` parameter.
     */
    position?: string;
    /**
     * Body param: 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.
     */
    scale?: number;
}
export interface WatermarkListParams {
    /**
     * The account identifier tag.
     */
    account_id: string;
}
export interface WatermarkDeleteParams {
    /**
     * Path param: The account identifier tag.
     */
    account_id: string;
    /**
     * Body param:
     */
    body: unknown;
}
export interface WatermarkGetParams {
    /**
     * The account identifier tag.
     */
    account_id: string;
}
export declare namespace Watermarks {
    export import Watermark = WatermarksAPI.Watermark;
    export import WatermarkDeleteResponse = WatermarksAPI.WatermarkDeleteResponse;
    export import WatermarksSinglePage = WatermarksAPI.WatermarksSinglePage;
    export import WatermarkCreateParams = WatermarksAPI.WatermarkCreateParams;
    export import WatermarkListParams = WatermarksAPI.WatermarkListParams;
    export import WatermarkDeleteParams = WatermarksAPI.WatermarkDeleteParams;
    export import WatermarkGetParams = WatermarksAPI.WatermarkGetParams;
}
//# sourceMappingURL=watermarks.d.ts.map