BackgroundBlurEffect class

Package:

@azure/communication-calling-effects

Background blur effect

Constructors

BackgroundBlurEffect(BackgroundBlurConfig)

Properties

name	Name of the effect

Methods

configure(BackgroundBlurConfig)	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

BackgroundBlurEffect(BackgroundBlurConfig)

new BackgroundBlurEffect(bgBlurConfig?: BackgroundBlurConfig)

Parameters

bgBlurConfig

BackgroundBlurConfig

Property Details

name

Name of the effect

name: VideoEffectName

Property Value

VideoEffectName

Method Details

configure(BackgroundBlurConfig)

Method to update effect config

function configure(newBgBlurConfig: BackgroundBlurConfig): Promise<void>

Parameters

newBgBlurConfig

BackgroundBlurConfig

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>