1. Epic GamesDeveloper
  3. UAudioOscilloscope

UAudioOscilloscope

An oscilloscope UMG widget. Supports displaying waveforms from incoming audio samples.

API > API/Plugins > API/Plugins/AudioWidgets

An oscilloscope UMG widget.

Supports displaying waveforms from incoming audio samples.

   
Name UAudioOscilloscope
Type class
Header File /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioOscilloscopeUMG.h
Include Path #include "AudioOscilloscopeUMG.h"

Syntax

UCLASS (MinimalAPI)  
class UAudioOscilloscope : public UWidget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAudioOscilloscope ( const FObjectInitializer& ObjectInitializer
)

   AudioOscilloscopeUMG.h  

Classes

Name Remarks
FGetOscilloscopeAudioSamples  

Constants

Name Type Remarks Include Path
DummyMaxNumSamples int32   AudioOscilloscopeUMG.h
DummyNumChannels int32   AudioOscilloscopeUMG.h
DummySampleRate uint32 Dummy waveform data to display if audio bus is not set. AudioOscilloscopeUMG.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AmplitudeGridLabelsUnit EYAxisLabelsUnit Define the amplitude grid labels unit. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
AnalysisPeriodMs float The analysis period in milliseconds. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(UIMin=10, UIMax=1000, ClampMin=10, ClampMax=1000)
AudioBus TObjectPtr< UAudioBus > The audio bus used to obtain audio samples for the oscilloscope AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(DesignerRebuild="True")
bShowAmplitudeGrid bool Show/Hide the amplitude grid. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
bShowAmplitudeLabels bool Show/Hide the amplitude labels. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
bShowTimeGrid bool Show/Hide the time grid. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
ChannelToAnalyze int32 The channel to analyze with the oscilloscope (only available if PanelLayoutType is set to "Advanced"). AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(EditCondition="PanelLayoutType == EAudioPanelLayoutType::Advanced", EditConditionHides)
MaxTimeWindowMs float The max time window in milliseconds. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(UIMin=10.0, UIMax=5000.0, ClampMin=10.0, ClampMax=5000.0)
OscilloscopeStyle FAudioOscilloscopePanelStyle The oscilloscope panel style AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Style"
  • Meta=(DisplayName="Style")
PanelLayoutType EAudioPanelLayoutType Show/Hide advanced panel layout. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(DesignerRebuild="True")
TimeGridLabelsUnit EXAxisLabelsUnit Define the time grid labels unit. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
TimeWindowMs float The time window in milliseconds. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(UIMin=10.0, ClampMin=10.0)
TriggerMode EAudioOscilloscopeTriggerMode The trigger detection behavior. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(EditCondition="CanTriggeringBeSet()", EditConditionHides)
TriggerThreshold float The trigger threshold position in the Y axis. AudioOscilloscopeUMG.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Oscilloscope Values"
  • Meta=(UIMin=1, UIMax=1, ClampMin=1, ClampMax=1, EditCondition="CanTriggeringBeSet() && TriggerMode != EAudioOscilloscopeTriggerMode::None", EditConditionHides)

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioSamplesDataProvider TSharedPtr< AudioWidgets::FWaveformAudioSamplesDataProvider > The underlying audio samples data provider. AudioOscilloscopeUMG.h  
DummyAudioSamples TArray< float >   AudioOscilloscopeUMG.h  
DummyDataView FFixedSampledSequenceView   AudioOscilloscopeUMG.h  
NumChannels int32   AudioOscilloscopeUMG.h  
OscilloscopePanelWidget TSharedPtr< SAudioOscilloscopePanelWidget > Native Slate Widget. AudioOscilloscopeUMG.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void StartProcessing()

 Starts the oscilloscope processing. AudioOscilloscopeUMG.h
  • BlueprintCallable
  • Category="Audio Widgets| Oscilloscope"

void StopProcessing()

 Stops the oscilloscope processing. AudioOscilloscopeUMG.h
  • BlueprintCallable
  • Category="Audio Widgets| Oscilloscope"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   AudioOscilloscopeUMG.h  

virtual void SynchronizeProperties()

   AudioOscilloscopeUMG.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   AudioOscilloscopeUMG.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page