Developer Documentation

ApmEffect

Inherits from: PiplineEffect

public class ApmEffect : PiplineEffect, IPiplineEffect

VoiceActivity effect for Odin

Constructors

NameDescription
ApmEffect(OdinPipelineHandle, UInt32)Internal effect constructor, use UInt32%2cSystem

Static Methods

NameDescription
CreateInsert a apm effect in the specified pipline and sets the apm config

Properties

NameDescription
ConfigAudio processing configuration
EchoCancellerIdicates whether the ApmConfig setting is enabled
HighPassFilterIdicates whether the ApmConfig setting is enabled
PreAmplifierIdicates whether the ApmConfig setting is enabled
NoiseSuppressionLevelIdicates the level of noise suppression ApmConfig setting by default
TransientSuppressorIdicates whether the ApmConfig setting is enabled
GainControllerIdicates whether the ApmConfig setting is enabled
SamplerateOutput decoder samplerate
IsStereoOutput decoder channel flag

Public Methods

NameDescription
UpdateEffectConfigSet audio processing configuration
SetApmConfigSet managed audio processing configuration
SetVadConfigNot supported
GetVadConfigNot supported

Inherited Properties

NameDescription
IdEffect id
IndexEffect index
ParentPipeline handle

Inherited Methods

NameDescription
GetEffectIndexGet native effect index
GetEffectTypeGet native effect NativeBindings
GetVadConfigGet native voice activity config
SetApmConfigSet native audio processing config
SetApmStreamDelaySet native audio processing delay
SetVadConfigSet native voice activity config
UpdateApmPlaybackSend samples for native audio processing