Class WatermarkFilter

Export

WatermarkFilter

Hierarchy (view full)

Constructors

constructor

Properties

bottom? createdAt? customData? description? id? image? left? modifiedAt? name? right? top? type unit? _discriminatorMapping _discriminatorName

Constructors

constructor

Properties

Optional bottom

bottom?: 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.

Memberof

WatermarkFilter

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

Optional image

image?: string

URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)

Memberof

WatermarkFilter

Optional left

left?: number

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.

Memberof

WatermarkFilter

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

Optional right

right?: 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.

Memberof

WatermarkFilter

Optional top

top?: 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.

Memberof

WatermarkFilter

Readonly type

type: FilterType = FilterType.WATERMARK

Discriminator property for Filter

Memberof

WatermarkFilter

Optional unit

unit?: PositionUnit

Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.

Memberof

WatermarkFilter

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionidimageleftmodifiedAtnamerighttoptypeunit_discriminatorMapping_discriminatorName