Navigation
API > API/Runtime > API/Runtime/AudioAnalyzer
Inheritance Hierarchy
- UObject
- UAudioAnalyzer
- UConstantQAnalyzer
- ULoudnessAnalyzer
- UMeterAnalyzer
- USynesthesiaSpectrumAnalyzer
References
| Module | AudioAnalyzer |
| Header | /Engine/Source/Runtime/AudioAnalyzer/Classes/AudioAnalyzer.h |
| Include | #include "AudioAnalyzer.h" |
Syntax
UCLASS (Abstract, EditInlineNew, BlueprintType, MinimalAPI)
class UAudioAnalyzer : public UObject
Remarks
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
| Type | Name | Description | |
|---|---|---|---|
   |
TObjectPtr< UAudioBus > | AudioBus | The UAudioBus which is analyzed in real-time. |
 |
int32 | NumFramesPerBufferToAnalyze | How many frames of audio to wait before analyzing the audio. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
|
  |
void | Function to broadcast results. | |
   |
TSharedPtr< Audio::IAnalyzerControls > | Implementations can override this method to create controls objects specific for their analyzer. | |
   |
FName | Subclasses must override this method in order to inform this object which AnalyzerFactory to use for analysis | |
 |
TUniquePtr< ResultType > | GetResults () |
|
   |
TUniquePtr< Audio::IAnalyzerSettings > | GetSettings
(
const int32 InSampleRate, |
Implementations can override this method to create settings objects specific for their analyzer. |
    |
void | StartAnalyzing
(
const UObject* WorldContextObject, |
Starts analyzing audio from the given audio bus. |
 |
void | StartAnalyzing
(
UWorld* InWorld, |
Starts analyzing using the given world. |
 |
void | StartAnalyzing
(
const Audio::FDeviceId InAudioDeviceId, |
|
    |
void | StopAnalyzing
(
const UObject* WorldContextObject |
Stops analyzing audio. |
Typedefs
| Name | Description |
|---|---|
| FResultId | ID to keep track of results. |
| FResultSharedPtr | Thread safe shared point to result object. |