Navigation
API > API/Runtime > API/Runtime/AudioAnalyzer
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().
| Name | UAudioAnalyzer |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioAnalyzer/Classes/AudioAnalyzer.h |
| Include Path | #include "AudioAnalyzer.h" |
Syntax
UCLASS (Abstract, EditInlineNew, BlueprintType, MinimalAPI)
class UAudioAnalyzer : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAudioAnalyzer
Derived Classes
UAudioAnalyzer derived class hierarchy
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FResultId | int32 | ID to keep track of results. | AudioAnalyzer.h |
| FResultSharedPtr | TSharedPtr< Audio::IAnalyzerResult, ESPMode::ThreadSafe > | Thread safe shared point to result object. | AudioAnalyzer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioBus | TObjectPtr< UAudioBus > | The UAudioBus which is analyzed in real-time. | AudioAnalyzer.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnalysisBuffer | TArray< float > | Scratch buffer used for copying data from patch output and fed to analysis task. | AudioAnalyzer.h | |
| AnalysisTask | TSharedPtr< FAsyncTask< FAudioAnalyzeTask > > | Analysis task. | AudioAnalyzer.h | |
| AnalyzerControls | TSharedPtr< Audio::IAnalyzerControls > | The analyzer controls that can be modified real-time. | AudioAnalyzer.h | |
| AnalyzerFacade | TUniquePtr< Audio::FAnalyzerFacade > | The analyzer facade used for async tasks. | AudioAnalyzer.h | |
| AnalyzerFactory | Audio::IAnalyzerFactory * | The analyzer factory to use. | AudioAnalyzer.h | |
| AudioAnalyzerSubsystem | TObjectPtr< UAudioAnalyzerSubsystem > | Audio analysis subsystem used with this audio analyzer. | AudioAnalyzer.h |
|
| AudioMixerSampleRate | int32 | The sample of the audio renderer. | AudioAnalyzer.h | |
| NumBusChannels | int32 | The number of channels for the audio bus. | AudioAnalyzer.h | |
| PatchOutputStrongPtr | Audio::FPatchOutputStrongPtr | Output patch for retrieving audio from audio bus for analysis. | AudioAnalyzer.h | |
| ResultsInternal | TUniquePtr< Audio::IAnalyzerResult > | Cached results of previous analysis task. Can be invalid. | AudioAnalyzer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
AudioAnalyzer.h | ||
virtual void BroadcastResults() |
Function to broadcast results. | AudioAnalyzer.h | |
virtual TSharedPtr< Audio::IAnalyzerControls > GetAnalyzerControls() |
Implementations can override this method to create controls objects specific for their analyzer. | AudioAnalyzer.h | |
virtual TUniquePtr< Audio::IAnalyzerSettings > GetSettings
(
const int32 InSampleRate, |
Implementations can override this method to create settings objects specific for their analyzer. | AudioAnalyzer.h | |
void StartAnalyzing
(
const UObject* WorldContextObject, |
Starts analyzing audio from the given audio bus. | AudioAnalyzer.h |
|
void StartAnalyzing
(
UWorld* InWorld, |
Starts analyzing using the given world. | AudioAnalyzer.h | |
void StartAnalyzing
(
const Audio::FDeviceId InAudioDeviceId, |
AudioAnalyzer.h | ||
void StopAnalyzing
(
const UObject* WorldContextObject |
Stops analyzing audio. | AudioAnalyzer.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetAnalyzerFactoryName() |
Subclasses must override this method in order to inform this object which AnalyzerFactory to use for analysis | AudioAnalyzer.h | |
TUniquePtr< ResultType > GetResults() |
AudioAnalyzer.h |