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

Light Theme

Dark Theme

UAudioAnalyzerNRT

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAudioAnalyzerAsset

UAudioAnalyzerNRT

UAudioSynesthesiaNRT

References

Module	AudioAnalyzer
Header	/Engine/Source/Runtime/AudioAnalyzer/Classes/AudioAnalyzerNRT.h
Include	#include "AudioAnalyzerNRT.h"

Syntax

class UAudioAnalyzerNRT : public UAudioAnalyzerAsset

Remarks

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
	float	DurationInSeconds	The duration of the analyzed audio in seconds.
	USoundWave *...	Sound	The USoundWave which is analyzed.

Functions

	Name	Description
void	AnalyzeAudio()	Performs the analaysis of the audio
FName	GetAnalyzerNRTFactoryName()	Subclasses must override this method in order to inform this object which AnalyzerNRTFactory to use for analysis
TSharedPtr< ...	GetResult()	Returns the result object generated by the associated IAudioAnalyzerNRTFactory.
TSharedPtr< ...	GetResult()	Returns the result object generated by the associated IAudioAnalyzerNRTFactory.
TUniquePtr< ...	GetSettings ( const float InSampleRate, const int32 InNumChannels )	Implementations can override this method to create settings objects specific for their analyzer.
void	RemoveSettingsDelegate ( UAudioAnalyzerNRTSettings* InS... )	This removes the existing delegate handle from the current settings object
void	SetResult ( FResultSharedPtr NewResult )
void	SetResultIfLatest ( FResultSharedPtr NewResult, FResultId InResultId )	This will only store the result if the passed InResultId matches the CurrentResultId.
void	SetSettingsDelegate ( UAudioAnalyzerNRTSettings* InS... )	This sets the AnalyzeAudio callback to the delegate in settings.
bool	ShouldEventTriggerAnalysis ( FPropertyChangedEvent& PropertyCha... )	Returns true when the PropertyChangeEvent is due to update SoundWave or Settings.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a UPROPERTY of this class is edited.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	Called before a UPROPERTY of this class is edited.
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.

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

Take our survey

Dismiss