Navigation
API > API/Runtime > API/Runtime/AudioExtensions
This class represents instances of a plugin that will process spatialization for a stream of audio. Currently used to process a mono-stream through an HRTF spatialization algorithm into a stereo stream. This algorithm contains an audio effect assigned to every VoiceId (playing sound instance). It assumes the effect is updated in the audio engine update loop with new position information.
| Name | IAudioSpatialization |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioExtensions/Public/IAudioExtensionPlugin.h |
| Include Path | #include "IAudioExtensionPlugin.h" |
Syntax
class IAudioSpatialization
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAudioSpatialization() |
Virtual destructor | IAudioExtensionPlugin.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CreateSpatializationEffect
(
uint32 SourceId |
Creates an audio spatialization effect. | IAudioExtensionPlugin.h | |
virtual void * GetSpatializationEffect
(
uint32 SourceId |
Returns the spatialization effect for the given voice id. | IAudioExtensionPlugin.h | |
virtual void GetSpatializationParameters
(
uint32 SourceId, |
DEPRECATED: Gets the spatialization effect parameters. | IAudioExtensionPlugin.h | |
virtual void Initialize
(
const FAudioPluginInitializationParams InitializationParams |
Initializes the spatialization plugin with the given buffer length. | IAudioExtensionPlugin.h | |
virtual void InitializeSpatializationEffect
(
uint32 BufferLength |
DEPRECATED: Initializes the spatialization effect with the given buffer length. | IAudioExtensionPlugin.h | |
virtual bool IsSpatializationEffectInitialized() |
Returns whether or not the spatialization effect has been initialized | IAudioExtensionPlugin.h | |
virtual void OnAllSourcesProcessed() |
Called when all sources have finished processing. | IAudioExtensionPlugin.h | |
virtual void OnDeviceShutdown
(
FAudioDevice* AudioDevice |
IAudioExtensionPlugin.h | ||
virtual void OnInitSource
(
const uint32 SourceId, |
Called when a source is assigned to a voice. | IAudioExtensionPlugin.h | |
virtual void OnInitSource
(
const uint32 SourceId, |
IAudioExtensionPlugin.h | ||
virtual void OnReleaseSource
(
const uint32 SourceId |
Called when a source is done playing and is released. | IAudioExtensionPlugin.h | |
virtual void ProcessAudio
(
const FAudioPluginSourceInputData& InputData, |
Processes audio with the given input and output data structs. | IAudioExtensionPlugin.h | |
virtual void ProcessSpatializationForVoice
(
uint32 SourceId, |
DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream, assumes the parameters have already been set before processing. | IAudioExtensionPlugin.h | |
virtual void ProcessSpatializationForVoice
(
uint32 SourceId, |
DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream. | IAudioExtensionPlugin.h | |
virtual void SetSpatializationParameters
(
uint32 SourceId, |
DEPRECATED: sets the spatialization effect parameters. | IAudioExtensionPlugin.h | |
virtual void Shutdown() |
Shuts down the audio plugin. | IAudioExtensionPlugin.h |