Interface BackgroundMedia

Represents a media-type background.

Remarks

A media-type background is a background that is either an image or a video.

Since

0.4.0

interface BackgroundMedia {
    alignment: Alignment;
    blur: number;
    brightness: number;
    contrast: number;
    enabled: boolean;
    fit: MediaFit;
    hue: number;
    offset: {
        x: number;
        y: number;
    };
    opacity: number;
    rotate: number;
    saturation: number;
    scale: number;
    source: string;
    type: "Video" | "Image";
    customCss?: string;
}

Hierarchy (view full)

Properties

alignment blur brightness contrast enabled fit hue offset opacity rotate saturation scale source type customCss?

Properties

alignment

alignment: Alignment

The alignment of the media within the background.

Default

Center

Since

0.5.0 • Added diagonal alignments

blur

blur: number

The amount of blur (in pixel) to apply to the background media.

Default

0

brightness

brightness: number

The brightness of the background media.

Remarks

The value is a number between -100 and 100.

Since

0.5.0

contrast

contrast: number

The contrast of the background media.

Remarks

The value is a number between -100 and 100.

Since

0.5.0

enabled

enabled: boolean

Whether the background is enabled.

fit

fit: MediaFit

The fit of the media within the background.

Remarks

None - The media will not be resized or cropped.

Fill - The media will stretch to fill the background.

Contain - The media will be contained within the background.

Cover - The media will cover the background.

ScaleDown - The media will be displayed in its original size unless it is larger than the background.

Default

None

hue

hue: number

The hue of the background media.

Remarks

The value is a number between 0 and 360.

Since

0.5.0

offset

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

The offset of the background media.

Remarks

The offset is a pair of numbers that represent the x and y offset of the media.

Since

0.5.0

opacity

opacity: number

The opacity of the background media

Remarks

The value is a number between 0 and 1.

Default

1

rotate

rotate: number

The rotation of the background media.

Since

0.5.0

saturation

saturation: number

The saturation of the background media.

Remarks

The value is a number between -100 and 100.

Since

0.5.0

scale

scale: number

The scale of the background media.

Since

0.5.0

source

source: string

The source of the background media.

type

type: "Video" | "Image"

The type of the background.

OptionalcustomCss

customCss?: string

Custom CSS for the background media.

Settings

Member Visibility

On This Page

Properties