BackgroundReplacementEffect interface

Package:

@azure/communication-calling

Background replacement effect.

Extends

VideoEffect

Inherited Properties

name	Name of the video effect.

Methods

configure(BackgroundReplacementConfig)

Method to configure the effect

Inherited Methods

isSupported()

Please use the isSupported method on the VideoEffectsFeature API.

Inherited Property Details

name

Name of the video effect.

name: VideoEffectName

Property Value

VideoEffectName

Inherited From VideoEffect.name

Method Details

configure(BackgroundReplacementConfig)

Method to configure the effect

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

Parameters

config

BackgroundReplacementConfig

Returns

Promise<void>

Inherited Method Details

isSupported()

Warning

This API is now deprecated.

Please use the isSupported method on the VideoEffectsFeature API.

function isSupported(): Promise<boolean>

Returns

Promise<boolean>

Inherited From VideoEffect.isSupported