VideoBackgroundReplacementEffect interface

Package:

@azure/communication-react

Contains the attibutes of a selected replacement video background effect

Extends

BackgroundReplacementConfig

Properties

effectName	Name of effect to replace video background effect
key	key for unique identification of the custom background

Inherited Properties

backgroundImageUrl	URL of the background image
effectInitTimeThresholdInMs	Time to wait (in MS) before firing the 'timeForEffectsWarningReached' event. Default value - 20000
fpsWarningThreshold	Minimum fps threshold before firing the 'fpsWarningThresholdReached' event. Default value - 5

Property Details

effectName

Name of effect to replace video background effect

effectName: "replacement"

Property Value

"replacement"

key

key for unique identification of the custom background

key?: string

Property Value

string

Inherited Property Details

backgroundImageUrl

URL of the background image

backgroundImageUrl: string

Property Value

string

Inherited From BackgroundReplacementConfig.backgroundImageUrl

effectInitTimeThresholdInMs

Time to wait (in MS) before firing the 'timeForEffectsWarningReached' event. Default value - 20000

effectInitTimeThresholdInMs?: number

Property Value

number

Inherited From BackgroundReplacementConfig.effectInitTimeThresholdInMs

fpsWarningThreshold

Minimum fps threshold before firing the 'fpsWarningThresholdReached' event. Default value - 5

fpsWarningThreshold?: number

Property Value

number

Inherited From BackgroundReplacementConfig.fpsWarningThreshold