Navigation
API > API/Plugins > API/Plugins/AudioWidgets
A vectorscope UMG widget.
Supports displaying waveforms in 2D (Left channel X axis, Right channel Y axis) from incoming audio samples.
| Name | UAudioVectorscope |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioVectorscopeUMG.h |
| Include Path | #include "AudioVectorscopeUMG.h" |
Syntax
UCLASS (MinimalAPI)
class UAudioVectorscope : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UAudioVectorscope
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAudioVectorscope
(
const FObjectInitializer& ObjectInitializer |
AudioVectorscopeUMG.h |
Classes
| Name | Remarks |
|---|---|
| FGetVectorscopeAudioSamples |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AnalysisPeriodMs | float | AudioVectorscopeUMG.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioBus | TObjectPtr< UAudioBus > | The audio bus used to obtain audio samples for the vectorscope | AudioVectorscopeUMG.h |
|
| bShowGrid | bool | Show/Hide the vectorscope grid. | AudioVectorscopeUMG.h |
|
| DisplayPersistenceMs | float | For how long the audio samples should persist in the screen (in milliseconds). | AudioVectorscopeUMG.h |
|
| GridDivisions | int32 | The number of grid divisions. | AudioVectorscopeUMG.h |
|
| MaxDisplayPersistenceMs | float | The max where the audio samples should persist in the screen (in milliseconds). | AudioVectorscopeUMG.h |
|
| PanelLayoutType | EAudioPanelLayoutType | Show/Hide advanced panel layout. | AudioVectorscopeUMG.h |
|
| Scale | float | The scale for the displayed audio samples. | AudioVectorscopeUMG.h |
|
| VectorscopeStyle | FAudioVectorscopePanelStyle | The vectorscope panel style | AudioVectorscopeUMG.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioSamplesDataProvider | TSharedPtr< AudioWidgets::FWaveformAudioSamplesDataProvider > | The underlying audio samples data provider. | AudioVectorscopeUMG.h | |
| DummyAudioSamples | TArray< float > | Dummy waveform data to display if audio bus is not set. | AudioVectorscopeUMG.h | |
| DummyDataView | FFixedSampledSequenceView | AudioVectorscopeUMG.h | ||
| VectorscopePanelWidget | TSharedPtr< SAudioVectorscopePanelWidget > | Native Slate Widget. | AudioVectorscopeUMG.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void StartProcessing() |
Starts the vectorscope processing. | AudioVectorscopeUMG.h |
|
void StopProcessing() |
Stops the vectorscope processing. | AudioVectorscopeUMG.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
AudioVectorscopeUMG.h | ||
virtual void SynchronizeProperties() |
AudioVectorscopeUMG.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
AudioVectorscopeUMG.h |