GreenscreenMediaFilterConfig interface

The configuration for a GreenscreenMediaFilter.

Signature:

export interface GreenscreenMediaFilterConfig 

Properties

PropertyModifiersTypeDescription
maxHeightreadonlynumberThe maximum height in pixels at which the filtered frames should be rendered.
maxWidthreadonlynumberThe maximum width in pixels at which the filtered frames should be rendered.
targetFrameRate?readonlynumber(Optional) The frame rate at which the filter should be run in FPS. If not specified it defaults to the maximum frame rate allowed by the platform (which is usually 30 FPS).

GreenscreenMediaFilterConfig.maxHeight property

The maximum height in pixels at which the filtered frames should be rendered.

Signature:

readonly maxHeight: number;

GreenscreenMediaFilterConfig.maxWidth property

The maximum width in pixels at which the filtered frames should be rendered.

Signature:

readonly maxWidth: number;

GreenscreenMediaFilterConfig.targetFrameRate property

The frame rate at which the filter should be run in FPS. If not specified it defaults to the maximum frame rate allowed by the platform (which is usually 30 FPS).

Signature:

readonly targetFrameRate?: number;