1. Epic GamesDeveloper
  3. AudioWidgets

AudioWidgets

API > API/Plugins

   
Name AudioWidgets
Type Runtime
Part of Plugins AudioWidgets
Location /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/
Module Build Rules AudioWidgets.Build.cs

Classes

Name Remarks
FAudioAnalyzerRack Manages display of audio analyzer rack units.
FAudioColorMapper Helper class for normalizing and applying a colormapping to unnormalized data.
FAudioMeter  
FAudioOscilloscope  
FAudioSpectrogram Owns an analyzer and a corresponding Slate widget for displaying the resulting spectra.
FAudioSpectrogramViewport Maintains a history of spectrogram frames, and presents their visualization by implementing ISlateViewport.
FAudioSpectrumAnalyzer Owns an analyzer and a corresponding Slate widget for displaying the resulting spectrum.
FAudioSpectrumPlotScaleInfo Utility class for converting between spectrum data and local/absolute screen space.
FAudioVectorscope  
FAudioWidgetsModule  
FAudioWidgetsStyle Slate style set that defines all the styles for audio widgets
FFixedSampledSequenceGridData  
FOnAudioRadialSliderValueChangedEvent  
FOnButtonPressedChangedEvent  
FOnKnobValueChangedEvent  
FOnSliderFloatValueChangedEvent  
FSparseSampledSequenceTransportCoordinator  
FWaveformAudioSamplesDataProvider  
SAudioFrequencyRadialSlider An Audio Radial Slider widget with default logarithmic conversion intended to be used for frequency (Hz).
SAudioFrequencySlider An Audio Slider widget intended to be used for frequency output, with output frequency range but no customizable curves.
SAudioInputWidget Abstract class for use by audio sliders and knobs that consists of a visual representation of a float value and a text label.
SAudioMaterialButton A simple slate that renders button in single material and modifies the material on pressed state change.
SAudioMaterialEnvelope A simple slate that renders envelope curve in a single material and modifies the material on value change.
SAudioMaterialKnob A simple slate that renders a knob in single material and modifies the material on value change.
SAudioMaterialLabeledKnob Wraps SAudioMaterialKnob and adds Label text that will show a value text.
SAudioMaterialLabeledSlider Wraps SAudioMaterialSlider and adds Label text that will show a value text.
SAudioMaterialMeter A simple slate that renders the meter in single material and modifies the material on value change.
SAudioMaterialSlider A simple slate that renders slider in single material and modifies the material on value change.
SAudioMeter A widget that displays audio channel's levels.
SAudioMeterBase  
SAudioOscilloscopePanelWidget  
SAudioRadialSlider Slate audio radial sliders that wrap SRadialSlider and provides additional audio specific functionality.
SAudioSlider An Audio Slider widget with customizable curves.
SAudioSliderBase Slate audio sliders that wrap SSlider and provides additional audio specific functionality.
SAudioSpectrogram Slate Widget for rendering a time-frequency representation of a series of audio power spectra.
SAudioSpectrumPlot Slate Widget for plotting an audio power spectrum, with linear or log frequency scale, and decibels sound levels.
SAudioTextBox  
SAudioVectorscopePanelWidget  
SAudioVolumeRadialSlider An Audio Radial Slider widget with default conversion for volume (dB).
SAudioVolumeSlider An Audio Slider widget intended to be used for volume output, with output decibel range but no customizable curves.
SFixedSampledSequenceRuler  
SFixedSampledSequenceVectorViewer  
SFixedSampledSequenceViewer  
SFixedSampledSequenceViewerPanel  
SPlayheadOverlay  
SSampledSequenceValueGridOverlay  
STriggerThresholdLineWidget  
UAudioFrequencyRadialSlider An audio slider widget, for use with frequency.
UAudioFrequencySlider An audio slider widget, for use with frequency.
UAudioMaterialButton A simple widget that shows a button Button is rendered by using material instead of texture.
UAudioMaterialButtonWidgetStyle  
UAudioMaterialEnvelope A simple widget that shows a envelope curve Depending on given AudioMaterialEnvelopeSetings Rendered by using material instead of texture.
UAudioMaterialKnob A simple widget that shows a turning Knob that allows you to control the value between 0..1.
UAudioMaterialKnobWidgetStyle  
UAudioMaterialMeter Meter is rendered by using material instead of texture.* No Children
UAudioMaterialMeterWidgetStyle  
UAudioMaterialSlider A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.
UAudioMaterialSliderWidgetStyle  
UAudioMeter An audio meter widget.
UAudioOscilloscope An oscilloscope UMG widget.Supports displaying waveforms from incoming audio samples.
UAudioRadialSlider An audio radial slider widget.
UAudioSlider An audio slider widget with customizable curves.
UAudioSliderBase An audio slider widget.
UAudioVectorscope A vectorscope UMG widget.
UAudioVolumeRadialSlider An audio slider widget, for use with volume.
UAudioVolumeSlider An audio slider widget with default customizable curves for volume (dB).

Structs

Name Remarks
F2DLineCoordinates  
FAudioAnalyzerRackUnitConstructParams Parameters for the FOnMakeAudioAnalyzerRackUnit delegate.
FAudioAnalyzerRackUnitTypeInfo Static type descriptor data for a rack unit type.
FAudioBusInfo FAudioBusInfo encapsulates the required info that describes the audio bus that is to be analyzed.
FAudioMaterialButtonStyle Represents the appearance of an Audio Material Button
FAudioMaterialEnvelopeSettings  
FAudioMaterialEnvelopeStyle Represents the appearance of an Audio Material Envelope
FAudioMaterialKnobStyle Represents the appearance of an Audio Material Knob
FAudioMaterialMeterStyle Represents the appearance of an Audio Material Meter
FAudioMaterialSliderStyle Represents the appearance of an Audio Material Slider
FAudioMaterialWidgetStyle Base for the appearance of an Audio Material Slates
FAudioMeterDefaultColorStyle  
FAudioMeterStyle Represents the appearance of an SAudioMeter
FAudioOscilloscopePanelStyle Represents the appearance of an SAudioOscilloscopePanelWidget
FAudioPowerSpectrumData The audio spectrum data to plot.
FAudioRadialSliderStyle Represents the appearance of an Audio Radial Slider
FAudioSliderStyle Represents the appearance of an Audio Slider
FAudioSpectrogramFrameData Struct for passing spectrum data for one frame of the spectrogram
FAudioSpectrogramParams Constructor parameters for the analyzer.
FAudioSpectrogramViewportRenderParams Parameters for the spectrogram viewport.
FAudioSpectrumAnalyzerParams Constructor parameters for the analyzer.
FAudioSpectrumPlotStyle Represents the appearance of an SAudioSpectrumPlot
FAudioTextBoxStyle Represents the appearance of an Audio Text Box
FAudioUnitProcessor Processor to allow output and display of different Audio Units.
FAudioVectorscopePanelStyle Represents the appearance of an SAudioVectorscopePanelWidget
FDimensionSlot Represents a dimensional slot in which samples, sample bins or a grid can be drawn
FFixedSampledSequenceGridMetrics  
FFixedSampledSequenceView  
FFixedSampleSequenceRulerStyle Represents the appearance of a Sampled Sequence Time Ruler
FFrequencyProcessor  
FGridData DrawCoordinates: Coordinates of different grid lines PositionRatios: the Ratio of each grid line position in relationship to the main axis length
FLoudnessMeterRackUnitSettings  
FLoudnessMetricDisplayOptions  
FMeterChannelInfo  
FPlayheadOverlayStyle Represents the appearance of a Waveform Viewer Overlay style
FSampledSequenceDrawingParams  
FSampledSequenceValueGridOverlayStyle Represents the appearance of a Sampled Sequence Value Grid Overlay
FSampledSequenceVectorViewerStyle Represents the appearance of a trigger threshold line
FSampledSequenceViewerStyle Represents the appearance of a Sampled Sequence Viewer
FSpectrogramRackUnitSettings  
FSpectrumAnalyzerRackUnitSettings  
FTriggerThresholdLineStyle Represents the appearance of a trigger threshold line
FVariablePrecisionNumericInterface Taken from PropertyEditor/VariablePrecisionNumericInterface.h Allow more precision as the numbers get closer to zero
FVolumeProcessor  

Interfaces

Name Remarks
IAudioAnalyzerRackUnit Interface for something that can be used in an analyzer rack.
IFixedSampledSequenceGridService  
IFixedSampledSequenceViewProvider  
IFixedSampledSequenceViewReceiver  
ISparseSampledSequenceTransportCoordinator  

Typedefs

Name Type Remarks Include Path
FGetAudioSpectrumData TBaseDelegate_NoParams< FAudioPowerSpectrumData >   SAudioSpectrumPlot.h
FOnAnalysisPeriodChanged TMulticastDelegate_OneParam< void, const float >   SAudioOscilloscopePanelWidget.h
FOnAnalyzerTypeMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrumAnalyzerType >   AudioSpectrumAnalyzer.h
FOnBallisticsMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrumAnalyzerBallistics >   AudioSpectrumAnalyzer.h
FOnCQTAnalyzerFFTSizeMenuEntryClicked TBaseDelegate_OneParam< void, EConstantQFFTSizeEnum >   AudioSpectrumAnalyzer.h
FOnDataViewGenerated TMulticastDelegate_TwoParams< void, FFixedSampledSequenceView, const uint32 >   WaveformAudioSamplesDataProvider.h
FOnDisplayAxisLabelsButtonToggled TBaseDelegate_NoParams< void >   SAudioSpectrumPlot.h
FOnDisplayRangeUpdated TMulticastDelegate_OneParam< void, const TRange< double > >   SparseSampledSequenceTransportCoordinator.h
FOnFFTAnalyzerFFTSizeMenuEntryClicked TBaseDelegate_OneParam< void, EFFTSize >   AudioSpectrumAnalyzer.h
FOnFocusPointMoved TMulticastDelegate_OneParam< void, const float >   SparseSampledSequenceTransportCoordinator.h
FOnFocusPointScrubUpdate TMulticastDelegate_TwoParams< void, const float, const bool >   SparseSampledSequenceTransportCoordinator.h
FOnFrequencyAxisPixelBucketModeMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrumPlotFrequencyAxisPixelBucketMode >   SAudioSpectrumPlot.h
FOnFrequencyAxisScaleMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrumPlotFrequencyAxisScale >   SAudioSpectrumPlot.h
FOnMakeAudioAnalyzerRackUnit TBaseDelegate_OneParam< TSharedRef< IAudioAnalyzerRackUnit >, const FAudioAnalyzerRackUnitConstructParams & >   AudioAnalyzerRack.h
FOnNewTimeRulerStyle TMulticastDelegate_OneParam< void, FFixedSampleSequenceRulerStyle >   AudioOscilloscopePanelStyle.h
FOnNewValueGridOverlayStyle TMulticastDelegate_OneParam< void, FSampledSequenceValueGridOverlayStyle >   AudioOscilloscopePanelStyle.h
FOnNewValueGridOverlayStyle TMulticastDelegate_OneParam< void, FSampledSequenceValueGridOverlayStyle >   AudioVectorscopePanelStyle.h
FOnNewVectorViewerStyle TMulticastDelegate_OneParam< void, FSampledSequenceVectorViewerStyle >   AudioVectorscopePanelStyle.h
FOnNewWaveformViewerStyle TMulticastDelegate_OneParam< void, FSampledSequenceViewerStyle >   AudioOscilloscopePanelStyle.h
FOnSelectedChannelChanged TMulticastDelegate_OneParam< void, const int32 >   SAudioOscilloscopePanelWidget.h
FOnSpectrogramColorMapMenuEntryClicked TBaseDelegate_OneParam< void, EAudioColorGradient >   SAudioSpectrogram.h
FOnSpectrogramFrequencyAxisPixelBucketModeMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrogramFrequencyAxisPixelBucketMode >   SAudioSpectrogram.h
FOnSpectrogramFrequencyAxisScaleMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrogramFrequencyAxisScale >   SAudioSpectrogram.h
FOnSpectrogramOrientationMenuEntryClicked TBaseDelegate_OneParam< void, EOrientation >   SAudioSpectrogram.h
FOnTiltSpectrumMenuEntryClicked TBaseDelegate_OneParam< void, EAudioSpectrumPlotTilt >   SAudioSpectrumPlot.h
FOnTimeUnitMenuSelection TMulticastDelegate_OneParam< void, const ESampledSequenceDisplayUnit >   SFixedSampledSequenceRuler.h
FOnTimeWindowValueChanged TMulticastDelegate_OneParam< void, const float >   SAudioVectorscopePanelWidget.h
FOnTimeWindowValueChanged TMulticastDelegate_OneParam< void, const float >   SAudioOscilloscopePanelWidget.h
FOnTriggerModeChanged TMulticastDelegate_OneParam< void, const EAudioOscilloscopeTriggerMode >   SAudioOscilloscopePanelWidget.h
FOnTriggerThresholdChanged TMulticastDelegate_OneParam< void, const float >   SAudioOscilloscopePanelWidget.h
FOnWaveformEditorGridUpdated TMulticastDelegate_NoParams< void >   FixedSampledSequenceGridData.h
SampleRange TRange< float >   SFixedSampledSequenceViewer.h
WidgetMouseInputFunction FReply(SWidget::*   AudioWidgetsUtils.h

Enums

Public

Name Remarks
EAudioColorGradient  
EAudioMaterialEnvelopeType Envelope curve types A: Attack D: Decay S: Sustain R: Release
EAudioOscilloscopeTriggerMode  
EAudioPanelLayoutType  
EAudioRadialSliderLayout  
EAudioSpectrogramFrequencyAxisPixelBucketMode  
EAudioSpectrogramFrequencyAxisScale  
EAudioSpectrumAnalyzerBallistics  
EAudioSpectrumAnalyzerType  
EAudioSpectrumPlotFrequencyAxisPixelBucketMode  
EAudioSpectrumPlotFrequencyAxisScale  
EAudioSpectrumPlotTilt  
EAudioUnitsValueType  
ESampledSequenceDisplayUnit  
EXAxisLabelsUnit  
EYAxisLabelsUnit  
SampledSequenceDrawingUtils::ESampledSequenceDrawOrientation Params for drawing sequences of samples/sample bins
SampledSequenceValueGridOverlay::EGridDivideMode  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FCursorReply AudioWidgetsUtils::RouteCursorQuery ( const FPointerEvent& CursorEvent,
TArrayView< const TSharedPtr< SWidget > > WidgetsStack,
const bool bReverse
)

 Propagates a cursor query through an array of widget until that input is handled or all the elements have been iterated AudioWidgetsUtils.h  

FReply AudioWidgetsUtils::RouteMouseInput ( WidgetMouseInputFunction InputFunction,
const FPointerEvent& MouseEvent,
TArrayView< TSharedPtr< SWidget > > WidgetsStack,
const bool bReverse
)

 Propagates mouse input through an array of widget until that input is handled or all the elements have been iterated AudioWidgetsUtils.h  

void SampledSequenceDrawingUtils::GenerateEvenlySplitGridForGeometry ( TArray< FGridData >& OutGridData,
const FGeometry& InAllottedGeometry,
const uint16 NDimensions,
const uint32 NumGridDivisions,
const FSampledSequenceDrawingParams Params
)

 Generates an evenly divided grid from a given geometry, following the orientation provided in the Params struct argument. SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GenerateEvenlySplitGridForLine ( TArray< double >& OutDrawCoordinates,
TArray< float >& OutLinePositionRatios,
const float LineLength,
const uint32 NumGridDivisions,
bool bEmptyOutArrays
)

   SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GenerateMidpointSplitGridForGeometry ( TArray< FGridData >& OutGridData,
const FGeometry& InAllottedGeometry,
const uint16 NDimensions,
const uint32 DivisionDepth,
const FSampledSequenceDrawingParams Params
)

 Generates a midline divided grid from a given geometry, following the orientation provided in the Params struct argument. SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GenerateMidpointSplitGridForLine ( TArray< double >& OutDrawCoordinates,
TArray< float >& OutLinePositionRatios,
const float LineLength,
const uint32 DivisionDepth,
bool bEmptyOutArrays
)

   SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GenerateSampleBinsCoordinatesForGeometry ( TArray< F2DLineCoordinates >& OutDrawCoordinates,
const FGeometry& InAllottedGeometry,
const TArray< TRange< float > >& InSampleBins,
const uint16 NDimensions,
const FSampledSequenceDrawingParams Params
)

 Generates an array of coordinates to draw binned samples as vertical lines. SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GenerateSequencedSamplesCoordinatesForGeometry ( TArray< FVector2D >& OutDrawCoordinates,
TArrayView< const float > InSampleData,
const FGeometry& InAllottedGeometry,
const uint16 NDimensions,
const FFixedSampledSequenceGridMetrics InGridMetrics,
const FSampledSequenceDrawingParams Params
)

 Generates an array of coordinates to draw single samples in succession horizontally. SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GroupInterleavedSampledTSIntoMinMaxBins ( TArray< TRange< SamplesType > >& OutBins,
const uint32 NumDesiredBins,
const SamplesType* RawDataPtr,
const uint32 TotalNumSamples,
const uint32 SampleRate,
const uint16 NDimensions,
const float StartTime,
float EndTime
)

 Groups samples of a time series into an equal number of desired bins. SampledSequenceDrawingUtils.h  

void SampledSequenceDrawingUtils::GroupInterleavedSamplesIntoMinMaxBins ( TArray< TRange< SamplesType > >& OutBins,
const uint32 NumDesiredBins,
const SamplesType* RawDataPtr,
const uint32 TotalNumSamples,
const uint16 NDimensions,
const double StartRatio,
double EndRatio
)

 Groups samples evenly into a number of desired bins. SampledSequenceDrawingUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page