@bitmovin/api-sdk/dist/models/WatermarkFilter.d.ts

Bitmovin JS/TS API SDK

import Filter from './Filter';
import FilterType from './FilterType';
import PositionUnit from './PositionUnit';
/**
 * @export
 * @class WatermarkFilter
 */
export declare class WatermarkFilter extends Filter {
    /**
     * Discriminator property for Filter
     * @type {string}
     * @memberof WatermarkFilter
     */
    readonly type: FilterType;
    /**
     * URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)
     * @type {string}
     * @memberof WatermarkFilter
     */
    image?: string;
    /**
     * Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.
     * @type {number}
     * @memberof WatermarkFilter
     */
    left?: number;
    /**
     * Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.
     * @type {number}
     * @memberof WatermarkFilter
     */
    right?: number;
    /**
     * Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.
     * @type {number}
     * @memberof WatermarkFilter
     */
    top?: number;
    /**
     * Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.
     * @type {number}
     * @memberof WatermarkFilter
     */
    bottom?: number;
    /**
     * Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.
     * @type {PositionUnit}
     * @memberof WatermarkFilter
     */
    unit?: PositionUnit;
    constructor(obj?: Partial<WatermarkFilter>);
}
export default WatermarkFilter;