Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AudioExtensions > IAudioSpatialization

Light Theme

Dark Theme

IAudioSpatialization

[IAudioSpatialization](API\Runtime\AudioExtensions\IAudioSpatialization)

Windows

MacOS

Linux

Inheritance Hierarchy

IAudioSpatialization

	FITDSpatialization
	FMicrosoftSpatialSound

References

Module	AudioExtensions
Header	/Engine/Source/Runtime/AudioExtensions/Public/IAudioExtensionPlugin.h
Include	#include "IAudioExtensionPlugin.h"

Syntax

class IAudioSpatialization

Remarks

IAudioSpatialization

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.

Destructors

	Name	Description
	~IAudioSpatialization()	Virtual destructor

Functions

	Name	Description
bool	CreateSpatializationEffect ( uint32 SourceId )	Creates an audio spatialization effect.
void *	GetSpatializationEffect ( uint32 SourceId )	Returns the spatialization effect for the given voice id.
void	GetSpatializationParameters ( uint32 SourceId, FSpatializationParams& OutParams )	DEPRECATED: Gets the spatialization effect parameters.
void	Initialize ( const FAudioPluginInitializationPar... )	Initializes the spatialization plugin with the given buffer length.
void	InitializeSpatializationEffect ( uint32 BufferLength )	DEPRECATED: Initializes the spatialization effect with the given buffer length.
bool	IsSpatializationEffectInitialized()	Returns whether or not the spatialization effect has been initialized
void	OnAllSourcesProcessed()	Called when all sources have finished processing.
void	OnDeviceShutdown ( FAudioDevice* AudioDevice )
void	OnInitSource ( const uint32 SourceId, const FName& AudioComponentUserId, USpatializationPluginSourceSettings... )	Called when a source is assigned to a voice.
void	OnReleaseSource ( const uint32 SourceId )	Called when a source is done playing and is released.
void	ProcessAudio ( const FAudioPluginSourceInputData&..., FAudioPluginSourceOutputData& Outp... )	Processes audio with the given input and output data structs.
void	ProcessSpatializationForVoice ( uint32 SourceId, float* InSamples, float* OutSamples )	DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream, assumes the parameters have already been set before processing.
void	ProcessSpatializationForVoice ( uint32 SourceId, float* InSamples, float* OutSamples, const FVector& Position )	DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream.
void	SetSpatializationParameters ( uint32 SourceId, const FSpatializationParams& Param... )	DEPRECATED: sets the spatialization effect parameters.
void	Shutdown()	Shuts down the audio plugin.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss