Navigation
API > API/Plugins > API/Plugins/AudioWidgets
Owns an analyzer and a corresponding Slate widget for displaying the resulting spectra. Can either create an Audio Bus to analyze, or analyze the given Bus.
| Name | FAudioSpectrogram |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioSpectrogram.h |
| Include Path | #include "AudioSpectrogram.h" |
Syntax
class FAudioSpectrogram : public AudioWidgets::IAudioAnalyzerRackUnit
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioSpectrogram
(
const FAudioSpectrogramParams& Params |
AudioSpectrogram.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAudioSpectrogram() |
AudioSpectrogram.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RackUnitTypeInfo | const FAudioAnalyzerRackUnitTypeInfo | AudioSpectrogram.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveAnalyzerType | TOptional< EAudioSpectrumAnalyzerType > | AudioSpectrogram.h | ||
| ActiveTimer | TSharedPtr< FActiveTimerHandle > | AudioSpectrogram.h | ||
| AnalyzerType | TAttribute< EAudioSpectrumAnalyzerType > | AudioSpectrogram.h | ||
| AudioBus | TStrongObjectPtr< UAudioBus > | The audio bus used for analysis. | AudioSpectrogram.h | |
| AudioDeviceId | Audio::FDeviceId | AudioSpectrogram.h | ||
| bUseExternalAudioBus | bool | AudioSpectrogram.h | ||
| ConstantQAnalyzer | TStrongObjectPtr< UConstantQAnalyzer > | AudioSpectrogram.h | ||
| ConstantQResultsDelegateHandle | FDelegateHandle | AudioSpectrogram.h | ||
| ConstantQSettings | TStrongObjectPtr< UConstantQSettings > | AudioSpectrogram.h | ||
| ContextMenuExtension | TSharedPtr< const FExtensionBase > | AudioSpectrogram.h | ||
| CQTAnalyzerFFTSize | TAttribute< EConstantQFFTSizeEnum > | AudioSpectrogram.h | ||
| FFTAnalyzerFFTSize | TAttribute< EFFTSize > | AudioSpectrogram.h | ||
| OnAnalyzerTypeMenuEntryClicked | FOnAnalyzerTypeMenuEntryClicked | AudioSpectrogram.h | ||
| OnCQTAnalyzerFFTSizeMenuEntryClicked | FOnCQTAnalyzerFFTSizeMenuEntryClicked | AudioSpectrogram.h | ||
| OnFFTAnalyzerFFTSizeMenuEntryClicked | FOnFFTAnalyzerFFTSizeMenuEntryClicked | AudioSpectrogram.h | ||
| SpectrumAnalysisSettings | TStrongObjectPtr< USynesthesiaSpectrumAnalysisSettings > | Analyzer settings. | AudioSpectrogram.h | |
| SpectrumAnalyzer | TStrongObjectPtr< USynesthesiaSpectrumAnalyzer > | Audio analyzer objects. | AudioSpectrogram.h | |
| SpectrumResultsDelegateHandle | FDelegateHandle | Handles for results delegate for analyzers. | AudioSpectrogram.h | |
| Widget | TSharedPtr< SAudioSpectrogram > | Slate widget for spectrum display | AudioSpectrogram.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAudioBus * GetAudioBus() |
AudioSpectrogram.h | ||
TSharedRef< SWidget > GetWidget() |
AudioSpectrogram.h | ||
void Init
(
int32 InNumChannels, |
AudioSpectrogram.h |
Overridden from IAudioAnalyzerRackUnit
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetAudioBusInfo
(
const FAudioBusInfo& AudioBusInfo |
If the Audio Bus to analyze changes (due to channel count change), handle this here. | AudioSpectrogram.h | |
virtual TSharedRef< SDockTab > SpawnTab
(
const FSpawnTabArgs& Args |
Spawn the actual analyzer Widget in a DockTab. | AudioSpectrogram.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildAnalyzerTypeSubMenu
(
FMenuBuilder& SubMenu |
AudioSpectrogram.h | ||
void BuildFFTSizeSubMenu
(
FMenuBuilder& SubMenu |
AudioSpectrogram.h | ||
void ExtendSpectrumPlotContextMenu
(
FMenuBuilder& MenuBuilder |
AudioSpectrogram.h | ||
void OnConstantQResults
(
UConstantQAnalyzer* InSpectrumAnalyzer, |
AudioSpectrogram.h | ||
void OnSpectrumResults
(
USynesthesiaSpectrumAnalyzer* InSpectrumAnalyzer, |
AudioSpectrogram.h | ||
void StartAnalyzing
(
const EAudioSpectrumAnalyzerType InAnalyzerType |
AudioSpectrogram.h | ||
void StopAnalyzing() |
AudioSpectrogram.h | ||
EActiveTimerReturnType Update
(
double InCurrentTime, |
AudioSpectrogram.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< IAudioAnalyzerRackUnit > MakeRackUnit
(
const FAudioAnalyzerRackUnitConstructParams& Params |
AudioSpectrogram.h |