BackgroundReplacementEffect class

Background replacement effect.

Properties

name

Name of the effect

Methods

configure(BackgroundReplacementConfig)

Method to update effect config

isSupported()

Method to check if effect is supported.

Constructor Details

BackgroundReplacementEffect(BackgroundReplacementConfig)

new BackgroundReplacementEffect(bgReplacementConfig: BackgroundReplacementConfig)

Parameters

bgReplacementConfig
BackgroundReplacementConfig

Property Details

name

Name of the effect

name: VideoEffectName

Property Value

Method Details

configure(BackgroundReplacementConfig)

Method to update effect config

function configure(newBgReplacementConfig: BackgroundReplacementConfig): Promise<void>

Parameters

newBgReplacementConfig
BackgroundReplacementConfig

Returns

Promise<void>

isSupported()

Method to check if effect is supported.

function isSupported(): Promise<boolean>

Returns

Promise<boolean>

true if effect is supported in the current environment