Skip to main content

Make ODIN APM Settings

Make ODIN APM Settings

Creates an APM settings object that can be used to construct a local room handle.

Inputs

NameTypeDescription
Enable Voice Activity DetectionbooleanWhen enabled, ODIN will analyze the audio input signal using smart voice detection algorithm to determine the presence of speech. You can define both the probability required to start and stop transmitting.
Attack ProbabilityfloatVoice probability value when the VAD should engage.
Release ProbabilityfloatVoice probability value when the VAD should disengage. It's recommended to keep this value 0.1 lower than the attack probability.
Enable Volume GatebooleanWhen enabled, the volume gate will measure the volume of the input audio signal, thus deciding when a user is speaking loud enough to transmit voice data. You can define both the root mean square power (dBFS) for when the gate should engage and disengage.
Attack Loudness (D BFS)floatRoot mean square power (dBFS) when the volume gate should engage.
Release Loudness (D BFS)floatRoot mean square power (dBFS) when the volume gate should disengage. It's recommended to keep this value 10 lower than the attack loudness.
Echo CancellerbooleanWhen enabled, aligns the original and the reverse audio stream to negate the output inside the input, resulting in effective echo cancellation
High Pass FilterbooleanWhen enabled, the high-pass filter will remove low-frequency content from the input audio signal, thus making it sound cleaner and more focused.
Pre AmplifierbooleanWhen enabled, the preamplifier will boost the signal of sensitive microphones by taking really weak audio signals and making them louder.
Noise SuppressionenumWhen enabled, the noise suppressor will remove distracting background noise from the input audio signal. You can control the aggressiveness of the suppression. Increasing the level will reduce the noise level at the expense of a higher speech distortion.
Transient SuppressionbooleanWhen enabled, the transient suppressor will try to detect and attenuate keyboard clicks.
Gain ControllerbooleanWhen enabled, the gain controller will automatically bring the signal to an appropriate range. This means input signals with low volume will be amplified and high volume will be limited.

Outputs

NameTypeDescription
Return ValueobjectThe constructed APM settings object.