Navigation
API > API/Plugins > API/Plugins/MicrosoftSpatialSound
Implementation of IAudioSpatialization for Microsoft Spatial Sound API.
| Name | FMicrosoftSpatialSound |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MicrosoftSpatialAudio/Source/MicrosoftSpatialSound/Public/MicrosoftSpatialSoundPlugin.h |
| Include Path | #include "MicrosoftSpatialSoundPlugin.h" |
Syntax
class FMicrosoftSpatialSound :
public IAudioSpatialization ,
protected FRunnable
Inheritance Hierarchy
- FRunnable → FMicrosoftSpatialSound
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMicrosoftSpatialSound() |
MicrosoftSpatialSoundPlugin.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMicrosoftSpatialSound() |
MicrosoftSpatialSoundPlugin.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | bool | MicrosoftSpatialSoundPlugin.h | ||
| bIsRendering | FThreadSafeBool | If the spatial audio render thread is running. | MicrosoftSpatialSoundPlugin.h | |
| CommandQueue | TQueue< TFunction< void()> > | Command queue. | MicrosoftSpatialSoundPlugin.h | |
| InitializationParams | FAudioPluginInitializationParams | MicrosoftSpatialSoundPlugin.h | ||
| MaxDynamicObjects | uint32 | The max dynamic objects. | MicrosoftSpatialSoundPlugin.h | |
| MinFramesRequiredPerObjectUpdate | uint32 | The minimum amount of frames which need to be queued before processing audio objects. | MicrosoftSpatialSoundPlugin.h | |
| Objects | TArray< FSpatialSoundSourceObjectData > | Array of spatial sound source objects. | MicrosoftSpatialSoundPlugin.h | |
| SAC | SpatialAudioClient * | MicrosoftSpatialSoundPlugin.h | ||
| SpatialAudioRenderThread | FRunnableThread * | The spatial audio render thread. | MicrosoftSpatialSoundPlugin.h | |
| SpatialSoundCritSect | FCriticalSection | The rendering critical section. | MicrosoftSpatialSoundPlugin.h |
Functions
Public
Overridden from IAudioSpatialization
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
const FAudioPluginInitializationParams InitializationParams |
Begin IAudioSpatialization interface | MicrosoftSpatialSoundPlugin.h | |
virtual bool IsSpatializationEffectInitialized() |
MicrosoftSpatialSoundPlugin.h | ||
virtual void OnInitSource
(
const uint32 SourceId, |
MicrosoftSpatialSoundPlugin.h | ||
virtual void OnReleaseSource
(
const uint32 SourceId |
MicrosoftSpatialSoundPlugin.h | ||
virtual void ProcessAudio
(
const FAudioPluginSourceInputData& InputData, |
MicrosoftSpatialSoundPlugin.h | ||
virtual void Shutdown() |
MicrosoftSpatialSoundPlugin.h |
Overridden from FRunnable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 Run() |
End of IAudioSpatialization interface Begin FRunnable | MicrosoftSpatialSoundPlugin.h |