@auvious/media-tools / NoiseSuppressionEffect

Class: NoiseSuppressionEffect

Generic for input

Implements

• IMediaEffect

Table of contents

Constructors

• constructor

Properties

• audioContext
• destination
• disposed
• events
• inputTrack
• name
• options
• setupToken
• source
• stopObservingWorklet
• streamIn
• streamOut
• worklet

Methods

• cleanupLocalSetup
• createOutputStream
• dispose
• isProcessingStartedMessage
• onOutput
• onUnload
• setInput
• setupAudio
• teardownAudio
• unload

Constructors

constructor

• new NoiseSuppressionEffect(options?): NoiseSuppressionEffect

Parameters

Name	Type
options	NoiseSuppressionEffectOptions

Returns

NoiseSuppressionEffect

Properties

audioContext

• Private Optional audioContext: AudioContext

---

destination

• Private Optional destination: MediaStreamAudioDestinationNode

---

disposed

• Private disposed: boolean = false

---

events

• events: Events<INoiseSuppressionEffectEvents>

---

inputTrack

• Private Optional inputTrack: MediaStreamTrack

---

name

• name: string = "auvious.noise-suppression"

distinct effect name

Implementation of

IMediaEffect.name

---

options

• Private options: Required<Omit<NoiseSuppressionEffectOptions, "audioContext" | "moduleUrl">> & Pick<NoiseSuppressionEffectOptions, "audioContext" | "moduleUrl">

---

setupToken

• Private setupToken: number = 0

---

source

• Private Optional source: MediaStreamAudioSourceNode

---

stopObservingWorklet

• Private Optional stopObservingWorklet: () => void

Type declaration

▸ (): void

Returns

void

---

streamIn

• Private Optional streamIn: MediaStream

---

streamOut

• Private Optional streamOut: MediaStream

---

worklet

• Private Optional worklet: Object

Type declaration

Name	Type
moduleUrl	string
node	AudioWorkletNode
processorName	string
ready	Promise<{ type: "ready" }>
dispose	() => void

Methods

cleanupLocalSetup

▸ cleanupLocalSetup(audioContext, source, destination, worklet): void

Parameters

Name	Type
audioContext	AudioContext
source	MediaStreamAudioSourceNode
destination	MediaStreamAudioDestinationNode
worklet	Object
worklet.dispose	() => void

Returns

void

---

createOutputStream

▸ createOutputStream(stream, audioTrack?): MediaStream

Parameters

Name	Type
stream	MediaStream
audioTrack?	MediaStreamTrack

Returns

MediaStream

---

dispose

▸ dispose(): void

Returns

void

---

isProcessingStartedMessage

▸ isProcessingStartedMessage(message): message is Object

Parameters

Name	Type
message	unknown

Returns

message is Object

---

onOutput

▸ onOutput(callback): () => void

listen for output changes

Parameters

Name	Type
callback	(stream: MediaStream) => void

Returns

fn

▸ (): void

Returns

void

Implementation of

IMediaEffect.onOutput

---

onUnload

▸ onUnload(callback): () => void

listen for effect removal

Parameters

Name	Type
callback	() => void

Returns

fn

▸ (): void

Returns

void

Implementation of

IMediaEffect.onUnload

---

setInput

▸ setInput(stream?): void

Parameters

Name	Type
stream?	MediaStream

Returns

void

Implementation of

IMediaEffect.setInput

---

setupAudio

▸ setupAudio(stream, audioTrack): Promise<void>

Parameters

Name	Type
stream	MediaStream
audioTrack	MediaStreamTrack

Returns

Promise<void>

---

teardownAudio

▸ teardownAudio(): void

Returns

void

---

unload

▸ unload(): void

Returns

void