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

Bitmovin JS/TS API SDK

import Filter from './Filter';
import FilterType from './FilterType';
import PositionUnit from './PositionUnit';
/**
 * @export
 * @class EnhancedWatermarkFilter
 */
export declare class EnhancedWatermarkFilter extends Filter {
    /**
     * Discriminator property for Filter
     * @type {string}
     * @memberof EnhancedWatermarkFilter
     */
    readonly type: FilterType;
    /**
     * URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)
     * @type {string}
     * @memberof EnhancedWatermarkFilter
     */
    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 EnhancedWatermarkFilter
     */
    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 EnhancedWatermarkFilter
     */
    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 EnhancedWatermarkFilter
     */
    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 EnhancedWatermarkFilter
     */
    bottom?: number;
    /**
     * @type {PositionUnit}
     * @memberof EnhancedWatermarkFilter
     */
    unit?: PositionUnit;
    /**
     * Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)
     * @type {number}
     * @memberof EnhancedWatermarkFilter
     */
    opacity?: number;
    /**
     * Desired width of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it
     * @type {number}
     * @memberof EnhancedWatermarkFilter
     */
    width?: number;
    /**
     * Desired height of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it
     * @type {number}
     * @memberof EnhancedWatermarkFilter
     */
    height?: number;
    constructor(obj?: Partial<EnhancedWatermarkFilter>);
}
export default EnhancedWatermarkFilter;