Skip to main content
Version: 2.x

Audio Pipeline

Nodes to build the audio pipeline of an encoder or decoder: insert, configure, reorder and remove effects.

Functions​

NodeTypeDescription
Append Activity EffectCallable functionCreates a Activity Effect and adds it at the end of the pipeline.
Append Clone EffectCallable functionCreates a Clone Effect and adds it at the end of the pipeline.
Append Mute EffectCallable functionCreates a Mute Effect and adds it at the end of the pipeline.
Append Rms EffectCallable functionCreates a RMS Effect and adds it at the end of the pipeline.
Append Volume EffectCallable functionCreates a Volume Effect and adds it at the end of the pipeline.
Create Activity EffectCallable functionCreates a Activity Effect and inserts it into the pipeline at the given index.
Create Clone EffectCallable functionCreates a Clone Effect and inserts it into the pipeline at the given index.
Create Mute EffectCallable functionCreates a Mute Effect and inserts it into the pipeline at the given index.
Create Rms EffectCallable functionCreates a RMS Effect and inserts it into the pipeline at the given index.
Create Volume EffectCallable functionCreates a Volume Effect and inserts it into the pipeline at the given index.
Get APM ConfigPure functionRetrieves the APM configuration for an effect.
Get Effect CountPure functionRetrieves the total number of effects currently in the audio pipeline.
Get Effect IdPure functionReturns the unique ID of the effect at the specified index.
Get Effect IndexPure functionSearches the specified audio pipeline for the effect with the specified effect_id and returns its current index.
Get Effect TypePure functionReturns the type of an effect in the pipeline (VAD, APM, VI or Custom).
Get VAD ConfigPure functionRetrieves the VAD configuration for an effect.
Get VI ConfigPure functionRetrieves the configuration for a VI effect identified by effect_id from the specified audio pipeline.
Insert APM EffectCallable functionInserts the Audio Processing Module (APM) at the given index.
Insert Custom EffectCallable functionInserts a user-defined custom effect at the specified index in the audio pipeline.
Insert VAD EffectCallable functionInserts a Voice Activity Detection (VAD) effect at the given index.
Insert VI EffectCallable functionInserts a Voice Isolation (VI) effect into the audio pipeline at the specified index and returns a unique effect identifier.
Move EffectCallable functionReorders the audio pipeline by moving an effect to a new index.
Remove EffectCallable functionRemoves an effect from the pipeline by its ID.
Set APM ConfigCallable functionUpdates the configuration of an existing APM effect.
Set VAD ConfigCallable functionUpdates the configuration of an existing VAD effect.
Set VI ConfigCallable functionUpdates the configuration settings of the VI effect identified by effect_id in the specified audio pipeline.
Update APM PlaybackCallable functionUpdates the specified APM effect's sample buffer for processing the reverse (playback) audio stream.

Events​

EventRaised byDescription
On Apm Config ChangedOdin PipelineRaised when the configuration of an APM effect in this pipeline changes through Set APM Config.