BackgroundReplacementEffect class

Package:

@azure/communication-calling-effects

Background replacement effect.

Constructors

BackgroundReplacementEffect(BackgroundReplacementConfig)

Properties

name	Name of the effect

Methods

configure(BackgroundReplacementConfig)	Method to update effect config
isSupported()	This method is deprecated. Please use the isSupported method on the VideoEffectsFeature API from the main @azure/communication-calling package instead.

Constructor Details

BackgroundReplacementEffect(BackgroundReplacementConfig)

new BackgroundReplacementEffect(bgReplacementConfig: BackgroundReplacementConfig)

Parameters

bgReplacementConfig

BackgroundReplacementConfig

Property Details

name

Name of the effect

name: VideoEffectName

Property Value

VideoEffectName

Method Details

configure(BackgroundReplacementConfig)

Method to update effect config

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

Parameters

newBgReplacementConfig

BackgroundReplacementConfig

Returns

Promise<void>

isSupported()

Warning

This API is now deprecated.

This method is deprecated. Please use the isSupported method on the VideoEffectsFeature API from the main @azure/communication-calling package instead.

function isSupported(): Promise<boolean>

Returns

Promise<boolean>