Skip to main content
Version: 5.1.3

Class: BackgroundTransformer

Constructors​

constructor​

• new BackgroundTransformer()

Methods​

init​

▸ init(id, config): Promise<void>

Parameters​

NameType
idstring
configBackgroundOptions

Returns​

Promise<void>


transform​

▸ Optional transform(frame, controller): Promise<void>

Parameters​

NameType
frameVideoFrame
controllerTransformStreamDefaultController<any>

Returns​

Promise<void>


setBackgroundOptions​

▸ setBackgroundOptions(options): Promise<void>

Parameters​

NameType
optionsBackgroundOptions

Returns​

Promise<void>


setVideoBGReadable​

▸ setVideoBGReadable(stream): Promise<void>

Parameters​

NameType
streamReadableStream<any>

Returns​

Promise<void>


setVirtualBGImage​

▸ setVirtualBGImage(image): Promise<void>

Parameters​

NameType
imageImageBitmap

Returns​

Promise<void>


setFlickeringOptions​

▸ setFlickeringOptions(options): void

Parameters​

NameType
optionsFlickeringOptions

Returns​

void


profile​

▸ profile(duration): Promise<ResolvedWebglQuery[]>

Parameters​

NameType
durationnumber

Returns​

Promise<ResolvedWebglQuery[]>


getTransformerType​

▸ getTransformerType(): string

Returns​

string


enable​

▸ enable(): void

Returns​

void


disable​

▸ disable(): void

Returns​

void