UAudioAnalyzerNRT

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AudioAnalyzer

Header

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

Include

#include "AudioAnalyzerNRT.h"

Syntax

class UAudioAnalyzerNRT : public UAudioAnalyzerAssetBase

Remarks

UAudioAnalyzerNRT

UAudioAnalyzerNRT applies an analyzer to a sound using specific settings, stores the results and exposes them via blueprints.

Subclasses of UAudioAnalyzerNRT must implement GetAnalyzerNRTFactoryName() to associate the UAudioAnalyzerNRT with an IAudioAnalyzerNRTFactory implementation.

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

Variables

Name Description

Public variable

float

 

DurationInSeconds

The duration of the analyzed audio in seconds.

Public variable

TObjectPtr< USo...

 

Sound

The USoundWave which is analyzed.

Functions

Name Description

Public function

void

 

AnalyzeAudio()

Performs the analaysis of the audio

Protected function Virtual Const

FName

 

GetAnalyzerNRTFactoryName()

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

Public function

TSharedPtr< ...

 

GetResult()

Returns the result object generated by the associated IAudioAnalyzerNRTFactory.

Public function Const

TSharedPtr< ...

 

GetResult()

Returns the result object generated by the associated IAudioAnalyzerNRTFactory.

Public function Virtual Const

TUniquePtr< ...

 

GetSettings

(
    const float InSampleRate,
    const int32 InNumChannels
)

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

Protected function

void

 

RemoveSettingsDelegate

(
    UAudioAnalyzerNRTSettings* InS...
)

This removes the existing delegate handle from the current settings object

Public function

void

 

SetResult

(
    FResultSharedPtr NewResult
)

Public function

void

 

SetResultIfLatest

(
    FResultSharedPtr NewResult,
    FResultId InResultId
)

This will only store the result if the passed InResultId matches the CurrentResultId.

Protected function

void

 

SetSettingsDelegate

(
    UAudioAnalyzerNRTSettings* InS...
)

This sets the AnalyzeAudio callback to the delegate in settings.

Public function Virtual

bool

 

ShouldEventTriggerAnalysis

(
    FPropertyChangedEvent& PropertyCha...
)

Returns true when the PropertyChangeEvent is due to update SoundWave or Settings.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a UPROPERTY of this class is edited.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

Called before a UPROPERTY of this class is edited.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Performs serialization of results.

Typedefs

Name

Description

FResultId

ID to keep track of results.

FResultSharedPtr

Thread safe shared point to result object.