1. Epic GamesDeveloper
  3. UAudioOscilloscope

UAudioOscilloscope

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

API > API/Plugins > API/Plugins/AudioWidgets

Inheritance Hierarchy

References

   
Module AudioWidgets
Header /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioOscilloscopeUMG.h
Include #include "AudioOscilloscopeUMG.h"

Syntax

UCLASS ()  
class UAudioOscilloscope : public UWidget

Remarks

An oscilloscope UMG widget.

Supports displaying waveforms from incoming audio samples.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EYAxisLabelsUnit AmplitudeGridLabelsUnit Define the amplitude grid labels unit.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float AnalysisPeriodMs The analysis period in milliseconds.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< UAudioBus > AudioBus The audio bus used to obtain audio samples for the oscilloscope
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowAmplitudeGrid Show/Hide the amplitude grid.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowAmplitudeLabels Show/Hide the amplitude labels.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowTimeGrid Show/Hide the time grid.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowTriggerThresholdLine Show/Hide the trigger threshold line.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FAudioOscilloscopePanelStyle OscilloscopeStyle The oscilloscope panel style
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAudioPanelLayoutType PanelLayoutType Show/Hide advanced panel layout.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EXAxisLabelsUnit TimeGridLabelsUnit Define the time grid labels unit.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float TimeWindowMs The time window in milliseconds.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float TriggerThreshold The trigger threshold position in the Y axis.

Constructors

  Type Name Description
Public function  

UAudioOscilloscope ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Starts the oscilloscope processing.
Public function UFunction BlueprintCallable, Category void Stops the oscilloscope processing.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FGetOscilloscopeAudioSamples    

Constants

Name Description
DummyMaxNumSamples  
DummyNumChannels  
DummySampleRate Dummy waveform data to display if audio bus is not set.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page