UAudioAnalyzer

[UAudioAnalyzer](API\Runtime\AudioAnalyzer\UAudioAnalyzer)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AudioAnalyzer

Header

/Engine/Source/Runtime/AudioAnalyzer/Classes/AudioAnalyzer.h

Include

#include "AudioAnalyzer.h"

Syntax

class UAudioAnalyzer : public UObject

Remarks

UAudioAnalyzer

UAudioAnalyzer performs analysis on an audio bus using specific settings and exposes the results via blueprints.

Subclasses of UAudioAnalyzer must implement GetAnalyzerFactoryName() to associate the UAudioAnalyzer asset with an IAudioAnalyzerFactory implementation.

To support blueprint access, subclasses can implement UFUNCTIONs to expose the data returned by GetResult().

Variables

Name Description

Public variable

TObjectPtr< UAu...

 

AudioBus

The UAudioBus which is analyzed in real-time.

Protected variable

int32

 

NumFramesPerBufferToAnalyze

How many frames of audio to wait before analyzing the audio.

Functions

Name Description

Public function Virtual

void

 

BroadcastResults()

Function to broadcast results.

Protected function Virtual Const

FName

 

GetAnalyzerFactoryName()

Subclasses must override this method in order to inform this object which AnalyzerFactory to use for analysis

Protected function

TUniquePtr< ...

 

GetResults()

Public function Virtual Const

TUniquePtr< ...

 

GetSettings

(
    const int32 InSampleRate,
    const int32 InNumChannels
)

Implementations can override this method to create settings objects specific for their analyzer.

Public function

void

 

StartAnalyzing

(
    const UObject* WorldContextObj...,
    UAudioBus* AudioBusToAnalyze
)

Starts analyzing audio from the given audio bus.

Public function

void

 

StartAnalyzing

(
    UWorld* InWorld,
    UAudioBus* AudioBusToAnalyze
)

Starts analyzing using the given world.

Public function

void

 

StopAnalyzing

(
    const UObject* WorldContextObj...
)

Stops analyzing audio.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Typedefs

Name

Description

FResultId

ID to keep track of results.

FResultSharedPtr

Thread safe shared point to result object.