@auvious/media-tools / IMediaEffect

Interface: IMediaEffect

Generic for input

Implemented by

• BackgroundFilter
• MediaEffect
• NoiseSuppressionEffect
• VAD

Table of contents

Properties

• name

Methods

• onOutput
• onUnload
• setInput

Properties

name

• name: string

distinct effect name

Methods

onOutput

▸ onOutput(callback): () => void

listen for output changes

Parameters

Name	Type
callback	(stream: MediaStream) => void

Returns

fn

▸ (): void

Returns

void

---

onUnload

▸ onUnload(callback): () => void

listen for effect removal

Parameters

Name	Type
callback	() => void

Returns

fn

▸ (): void

Returns

void

---

setInput

▸ setInput(stream?): void

Parameters

Name	Type
stream?	MediaStream

Returns

void