the unique customer identifier provided by SDK vendor.
This call will destroy the audio graph and worker along with all resources.
Ability to clear all models from local cache
Ability to configure sdk execution environment
configuration object
Get the output MediaStreamTrack object with denoise applied for further use.
Get Customer ID provided by vendor.
This object remains permanent throughout the entire lifetime of the SDK instance. When a new stream is provided as the source for processing, the SDK replaces the audio track within this MediaStream.
pass onError callback to ErrorBus
callback function that takes ErrorObject as its first argument.
Ability to preload all required resourses specified in config. This functionality make the initialization faster. Should be started after all configs are passet to sdk.config
This call starts applying noise reduction effects to the configured audio track. This should be called only after the onReady callback has been triggered.
Ability to pass an AudioContext to the SDK. We use it to process audio frames in the Audio Worklet. If a context is not passed, the SDK will create a new context internally.
Set denoise power at runtime. Available only for the balanced preset.
the number parameter with range 0.0-1.0
Changes the denoise preset in real-time. Available presets:
The preset to use. Default is 'balanced'
. Available options: 'speed'
, 'balanced'
, 'quality'
.
The sample rate to use. Default is 32000
. Available options: 16000
, 32000
, 44100
, 48000
.
'speed'
and 'quality'
presets are supported only with a sample rate of 16000
.setPreset
was called).This call stops applying noise reduction effects to the configured audio track and bypasses the original audio to the output. So, if you need to disable effects, you can just call stop and not touch the main logic related to WebRTC and MediaStreams. You can enable it again at any time by calling sdk.run().
Set the AudioTrack object to be the source of audio frames for processing. This call recreates the entire processing pipeline and loads all required resources. Once everything is loaded, the SDK calls the onReady callback.
the source MediaStreamTrack object.
Set the MediaStream object to be the source of audio frames for processing. This call recreates the entire processing pipeline and loads all required resources. Once everything is loaded, the SDK calls the onReady callback.
the source MediaStream object.
Generated using TypeDoc
Initiation of main SDK instance.