Navigation
API > API/Plugins > API/Plugins/AudioWidgets
Inheritance Hierarchy
References
| Module | AudioWidgets |
| Header | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioVectorscopeUMG.h |
| Include | #include "AudioVectorscopeUMG.h" |
Syntax
UCLASS ()
class UAudioVectorscope : public UWidget
Remarks
A vectorscope UMG widget.
Supports displaying waveforms in 2D (Left channel X axis, Right channel Y axis) from incoming audio samples.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
TObjectPtr< UAudioBus > | AudioBus | The audio bus used to obtain audio samples for the vectorscope |
    |
bool | bShowGrid | Show/Hide the vectorscope grid. |
    |
float | DisplayPersistenceMs | For how long the audio samples should persist in the screen (in milliseconds). |
    |
int32 | GridDivisions | The number of grid divisions. |
    |
float | MaxDisplayPersistenceMs | The max where the audio samples should persist in the screen (in milliseconds). |
    |
EAudioPanelLayoutType | PanelLayoutType | Show/Hide advanced panel layout. |
    |
float | Scale | The scale for the displayed audio samples. |
    |
FAudioVectorscopePanelStyle | VectorscopeStyle | The vectorscope panel style |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UAudioVectorscope
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | Starts the vectorscope processing. | |
   |
void | Stops the vectorscope processing. |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
  |
const FText | Gets the palette category of the widget | |
  |
void | Applies all properties to the native widget if possible. |
Overridden from UVisual
| Type | Name | Description | |
|---|---|---|---|
  |
void | ReleaseSlateResources
(
bool bReleaseChildren |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FGetVectorscopeAudioSamples |
Constants
| Name | Description |
|---|---|
| AnalysisPeriodMs |