FMicrosoftSpatialSound

Implementation of [IAudioSpatialization](API\Runtime\AudioExtensions\IAudioSpatialization) for Microsoft Spatial Sound API.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IAudioSpatialization

FRunnable

FMicrosoftSpatialSound

References

Module

MicrosoftSpatialSound

Header

/Engine/Plugins/Runtime/MicrosoftSpatialAudio/Source/MicrosoftSpatialSound/Public/MicrosoftSpatialSoundPlugin.h

Include

#include "MicrosoftSpatialSoundPlugin.h"

Syntax

class FMicrosoftSpatialSound :
    public IAudioSpatialization,
    protected FRunnable

Remarks

Implementation of IAudioSpatialization for Microsoft Spatial Sound API.

Constructors

Name Description

Public function

FMicrosoftSpatialSound()

Destructors

Name Description

Public function

~FMicrosoftSpatialSound()

Overridden from IAudioSpatialization

Name Description

Public function Virtual

void

 

Initialize

(
    const FAudioPluginInitializationPar...
)

Begin IAudioSpatialization interface

Public function Virtual Const

bool

 

IsSpatializationEffectInitialized()

Returns whether or not the spatialization effect has been initialized

Public function Virtual

void

 

OnInitSource

(
    const uint32 SourceId,
    const FName& AudioComponentUserId,
    USpatializationPluginSourceSettings...
)

Called when a source is assigned to a voice.

Public function Virtual

void

 

OnReleaseSource

(
    const uint32 SourceId
)

Called when a source is done playing and is released.

Public function Virtual

void

 

ProcessAudio

(
    const FAudioPluginSourceInputData&...,
    FAudioPluginSourceOutputData& Outp...
)

Processes audio with the given input and output data structs.

Public function Virtual

void

 

Shutdown()

Shuts down the audio plugin.

Overridden from FRunnable

Name Description

Public function Virtual

uint32

 

Run()

End of IAudioSpatialization interface Begin FRunnable