1. References
  2. Web SDK v5
  3. Stream
  4. AudioProcessor
Rate this page:

AudioProcessor

Interface that represents an audio processor.

Methods

setProcessor

Copy URL
setProcessor(processor: 
WasmProcessor
): 
void

Sets a WASM processor.

Parameters

Returns

  • type:

    void

startProcessing

Copy URL
startProcessing(streamToProcess: 
LocalStream
): 
Promise<LocalStream>

Starts processing audio in the provided local audio stream.

Parameters

Returns

stop

Copy URL
stop(): 
Promise<void>

Stops the audio processor.

Returns

  • type:

    Promise<void>

updateSourceStream

Copy URL
updateSourceStream(streamToProcess: 
LocalStream
): 
Promise<LocalStream>

Updates the local audio stream.

Parameters

Returns

Throws

AudioProcessorNotInitialized

Props

bypass

Copy URL
bypass: 
boolean

Whether the audio processor should pass AudioProcessor.originalStream directy to AudioProcessor.processedStream without any processing.

id

Copy URL
id: 
string

Audio processor id.

originalStream

Copy URL
originalStream: 
null | LocalStream

Local audio stream with unprocessed audio.

processedStream

Copy URL
processedStream: 
null | LocalStream

Local audio stream with processed audio.

state

Copy URL
state: 
ReadonlyWatchable<AudioProcessorState>

Watchable property that allows getting the audio processor state.