1. Epic GamesDeveloper
  3. UAudioVectorscope

UAudioVectorscope

A vectorscope UMG widget.

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

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
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(DesignerRebuild="True")
bShowGrid bool Show/Hide the vectorscope grid. AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
DisplayPersistenceMs float For how long the audio samples should persist in the screen (in milliseconds). AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(UIMin=10.0, ClampMin=10.0)
GridDivisions int32 The number of grid divisions. AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(UIMin=1, UIMax=6, ClampMin=1, ClampMax=6)
MaxDisplayPersistenceMs float The max where the audio samples should persist in the screen (in milliseconds). AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(UIMin=10.0, UIMax=500.0, ClampMin=10.0, ClampMax=500.0)
PanelLayoutType EAudioPanelLayoutType Show/Hide advanced panel layout. AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(DesignerRebuild="True")
Scale float The scale for the displayed audio samples. AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Vectorscope Values"
  • Meta=(UIMin=0.0, UIMax=1.0, ClampMin=0.0, ClampMax=1.0)
VectorscopeStyle FAudioVectorscopePanelStyle The vectorscope panel style AudioVectorscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Style"
  • Meta=(DisplayName="Style")

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
  • BlueprintCallable
  • Category="Audio Widgets| Vectorscope"

void StopProcessing()

 Stops the vectorscope processing. AudioVectorscopeUMG.h
  • BlueprintCallable
  • Category="Audio Widgets| Vectorscope"

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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page