Insert APM Effect
Inserts the Audio Processing Module (APM) at the given index. APM provides echo cancellation, noise suppression, high-pass filtering, transient suppression and automatic gain control; configure it with Set APM Config.
- Node type: Callable function. Has execution pins and runs when it is reached in the event graph.
- Target: Odin Pipeline
- Menu category: Odin › Audio Pipeline
- C++:
UOdinPipeline::InsertApmEffect
note
Index is shifting subsequent effects. An index of 0 inserts at the beginning of the pipeline.
The playback format describes the samples fed into the echo-cancellation reverse stream. In this plugin that source is the UE main submix, so the defaults (0 = current audio mixer sample rate, stereo) are the right choice unless the reverse stream is fed manually with a different format.
Inputs
| Name | Type | Description |
|---|---|---|
| Target | Odin Pipeline | The pipeline. |
| Index | Integer | Position in the pipeline; 0 inserts at the beginning. |
| Sample Rate | Integer | The playback sample rate for the APM effect. 0 uses the current audio mixer sample rate. Default: 0. |
| Stereo | Boolean | A boolean indicating whether the APM effect should use stereo (true) or mono (false) mode. Default: true. |
Outputs
| Name | Type | Description |
|---|---|---|
| Effect Id | Integer | ID of the inserted effect, -1 on failure. |