Audio Effects

Nodes and properties of the built-in custom effects (activity, clone, mute, RMS, volume and generic speech-to-text) that can be inserted into an audio pipeline.

Functions

Node	Type	Description
Construct Activity Effect	Callable function	Creates an Activity Effect that is not part of a pipeline yet; add it with Insert Custom Effect.
Construct Clone Effect	Callable function	Creates a Clone Effect that is not part of a pipeline yet; add it with Insert Custom Effect.
Construct Generic STT Effect	Callable function	Creates a generic speech-to-text (STT) effect, a base for C++ integrations with REST speech-to-text services.
Construct Mute Effect	Callable function	Creates a Mute Effect that is not part of a pipeline yet; add it with Insert Custom Effect.
Construct RMS Effect	Callable function	Creates an RMS Effect that is not part of a pipeline yet; add it with Insert Custom Effect.
Construct Volume Effect	Callable function	Creates a Volume Effect that is not part of a pipeline yet; add it with Insert Custom Effect.
Detach Effect	Callable function	Removes the effect from the pipeline it was inserted into.

Events

Event	Raised by	Description
Activity Callback	Odin Activity Effect	Raised on the game thread when the audio passing through the effect switches between silent and active.
On Dispatch Clone Callback	Odin Clone Effect	Raised on the game thread with a copy of the audio samples that passed through the effect.
Post Response (Clone Effect)	Odin Clone Effect	Declared for effects derived from the Clone Effect; the built-in effect does not raise it.
Post Response (Generic STT Effect)	Odin Rest GSTTEffect	Raised with the body of the response when a request posted with PostRequest completes.

Properties

Variables that Blueprints can read (Get) and, where noted, write (Set) directly on an object of the class.

Property	Class	Type	Access	Description
Has Activity	Odin Activity Effect	Boolean	Get	True while the audio passing through the effect is active (not silent).
Sample Rate	Odin Clone Effect	Integer	Get/Set	Sample rate of the cloned audio.
Stereo	Odin Clone Effect	Boolean	Get/Set	True if the cloned audio is interleaved stereo.
Index	Odin Custom Effect	Integer	Get	Index of the effect in its pipeline.
Effect Id	Odin Custom Effect	Integer	Get	ID of the effect in its pipeline.
Mute Flag	Odin Mute Effect	Odin Mute Effect Options	Get/Set	Set marks the audio passing through the effect as silent (muted); Unset and None let it pass.
Sample Rate	Odin Rest GSTTEffect	Integer	Get/Set	Sample rate of the incoming audio.
Resample Rate	Odin Rest GSTTEffect	Integer	Get/Set	Sample rate the collected audio is resampled to.
Stereo	Odin Rest GSTTEffect	Boolean	Get/Set	True if the incoming audio is interleaved stereo.
Timer	Odin Rest GSTTEffect	Float	Get/Set	Seconds of audio to collect before it is handed on.
Rms Dbfs	Odin Rms Effect	Float	Get	Loudness of the last processed audio as RMS in dBFS.
Sample Scale	Odin Volume Effect	Float	Get/Set	Linear factor the samples are multiplied by, or the gain in decibels if Volume Log10 is set.
Scale Exponent	Odin Volume Effect	Float	Get/Set	Exponent applied to Sample Scale in linear mode.
Volume Log 10	Odin Volume Effect	Boolean	Get/Set	If set, SampleScale is a gain in decibels (e.g. -6 halves the amplitude) instead of a linear factor.