Interface WatermarkVideo

Represents a video watermark for the presenter view.

Since

0.5.0

interface WatermarkVideo {
    loop: boolean;
    margin: number;
    muted: boolean;
    offset: {
        x: number;
        y: number;
    };
    opacity: number;
    position: Alignment;
    scale: number;
    source: string;
    type: "Video";
    customCss?: string;
    enabled?: boolean;
}

Hierarchy (view full)

Properties

loop margin muted offset opacity position scale source type customCss? enabled?

Properties

loop

loop: boolean

margin

margin: number

The margin of the watermark from the edge of the screen. This is a number in rem units.

Default

1

Example

1 - 1rem
2 - 2rem

muted

muted: boolean

offset

offset: {
    x: number;
    y: number;
}

The offset of the watermark from the position.

Since

0.5.0

opacity

opacity: number

The opacity of the watermark.

Remarks

This is a number between 0 and 1. 0 - Fully transparent 1 - Fully opaque

Default

1

position

position: Alignment

The position of the watermark on the screen.

Default

"BottomRight"

Remarks

This is a 9x9 grid where the screen is divided into 9 equal parts.

Example

TopLeft // Top left corner of the screen
BottomCenter // Bottom center of the screen

scale

scale: number

The scale of the watermark.

Remarks

This is a multiplier for the width and height of the watermark. Minimum value is 0. Maximum value is 2.

Default

1

Example

0.5 - 50% of the original size

source

source: string

type

type

OptionalcustomCss

customCss?: string

Custom CSS for the watermark.

Remarks

This is a string of CSS styles that will be applied on top of the default styles.

Optionalenabled

enabled?: boolean

Whether the watermark is enabled.

Default

false

Remarks

Used to show or hide the watermark on the presenter view.

Settings

Member Visibility

On This Page

Properties