1. Epic GamesDeveloper
  3. AudioWidgets

AudioWidgets

API > API/Plugins

Classes

  Type Name Description
Public struct F2DLineCoordinates    
Public class FAudioMeter    
Public struct UStruct BlueprintType FAudioMeterStyle Represents the appearance of an SAudioMeter  
Public struct UStruct BlueprintType FAudioRadialSliderStyle Represents the appearance of an Audio Radial Slider  
Public struct UStruct BlueprintType FAudioSliderStyle Represents the appearance of an Audio Slider  
Public struct UStruct BlueprintType FAudioTextBoxStyle Represents the appearance of an Audio Text Box  
Public class FAudioWidgetsModule    
Public class FAudioWidgetsStyle Slate style set that defines all the styles for audio widgets  
Public struct FDimensionSlot Represents a dimensional slot in which samples, sample bins or a grid can be drawn  
Public class FFixedSampledSequenceGridData    
Public struct FFixedSampledSequenceGridMetrics    
Public struct FFixedSampledSequenceView    
Public struct UStruct BlueprintType FFixedSampleSequenceRulerStyle Represents the appearance of a Sampled Sequence Time Ruler  
Public struct FGridData DrawCoordinates: Coordinates of different grid lines PositionRatios: the Ratio of each grid line position in relationship to the main axis length  
Public struct UStruct BlueprintType FMeterChannelInfo    
Public class FOnAudioRadialSliderValueChangedEvent    
Public struct UStruct BlueprintType FPlayheadOverlayStyle Represents the appearance of a Waveform Viewer Overlay style  
Public struct FSampledSequenceDrawingParams    
Public struct UStruct BlueprintType FSampledSequenceValueGridOverlayStyle Represents the appearance of a Sampled Sequence Value Grid Overlay  
Public struct UStruct BlueprintType FSampledSequenceViewerStyle Represents the appearance of a Sampled Sequence Viewer  
Public class FSparseSampledSequenceTransportCoordinator    
Public class IFixedSampledSequenceGridService    
Public class IFixedSampledSequenceViewProvider    
Public class IFixedSampledSequenceViewReceiver    
Public class ISparseSampledSequenceTransportCoordinator    
Public class SAudioFrequencyRadialSlider An Audio Radial Slider widget with default logarithmic conversion intended to be used for frequency (Hz).  
Public class SAudioFrequencySlider An Audio Slider widget intended to be used for frequency output, with output frequency range but no customizable curves.  
Public class SAudioInputWidget Abstract class for use by audio sliders and knobs that consists of a visual representation of a float value and a text label.  
Public class SAudioMeter A Slate slider control is a linear scale and draggable handle.  
Public class SAudioRadialSlider Slate audio radial sliders that wrap SRadialSlider and provides additional audio specific functionality.  
Public class SAudioSlider An Audio Slider widget with customizable curves.  
Public class SAudioSliderBase Slate audio sliders that wrap SSlider and provides additional audio specific functionality.  
Public class SAudioTextBox    
Public class SAudioVolumeRadialSlider An Audio Radial Slider widget with default conversion for volume (dB).  
Public class SAudioVolumeSlider An Audio Slider widget intended to be used for volume output, with output decibel range but no customizable curves.  
Public class SFixedSampledSequenceRuler    
Public class SFixedSampledSequenceViewer    
Public class SFixedSampledSequenceViewerPanel    
Public class SPlayheadOverlay    
Public class SSampledSequenceValueGridOverlay    
Public class UClass UAudioFrequencyRadialSlider An audio slider widget, for use with frequency.  
Public class UClass UAudioFrequencySlider An audio slider widget, for use with frequency.  
Public class UClass UAudioMeter An audio meter widget.  
Public class UClass UAudioRadialSlider An audio radial slider widget.  
Public class UClass UAudioSlider An audio slider widget with customizable curves.  
Public class UClass Abstract UAudioSliderBase An audio slider widget.  
Public class UClass UAudioVolumeRadialSlider An audio slider widget, for use with volume.  
Public class UClass UAudioVolumeSlider An audio slider widget with default customizable curves for volume (dB).  

Typedefs

Name Description
FOnDisplayRangeUpdated  
FOnFocusPointMoved  
FOnFocusPointScrubUpdate  
FOnTimeUnitMenuSelection  
FOnWaveformEditorGridUpdated  
SampleRange  
WidgetMouseInputFunction  

Enums

  Type Name Description
Public enum UEnum EAudioRadialSliderLayout    
Public enum ESampledSequenceDisplayUnit    
Public enum SampledSequenceDrawingUtils::ESampledSequenceDrawOrientation Params for drawing sequences of samples/sample bins  
Public enum SampledSequenceValueGridOverlay::EGridDivideMode    

Functions

  Type Name Description
Public function 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
Public function 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
Public function bool

operator== ( const FMeterChannelInfo& lhs,
const FMeterChannelInfo& rhs
)

  
Public function 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.
Public function void

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

  
Public function 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.
Public function void

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

  
Public function 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.
Public function 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.
Public function 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.
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page