1. Epic GamesDeveloper
  3. SAudioMeter

SAudioMeter

A Slate slider control is a linear scale and draggable handle.

API > API/Plugins > API/Plugins/AudioWidgets

Inheritance Hierarchy

References

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

Syntax

class SAudioMeter : public SLeafWidget

Remarks

A Slate slider control is a linear scale and draggable handle.

Variables

  Type Name Description
Protected variable TAttribute< FSlateColor > BackgroundColor Various colors.
Public variable bool bIsActiveTimerRegistered Is the active timer registered to refresh the meter channel info.
Protected variable TAttribute< FSlateColor > MeterBackgroundColor  
Protected variable TAttribute< TArray< FMeterChannelInfo > > MeterChannelInfoAttribute  
Protected variable TAttribute< FSlateColor > MeterClippingColor  
Protected variable TAttribute< FSlateColor > MeterPeakColor  
Protected variable TAttribute< FSlateColor > MeterScaleColor  
Protected variable TAttribute< FSlateColor > MeterScaleLabelColor  
Protected variable TAttribute< FSlateColor > MeterValueColor  
Protected variable EOrientation Orientation Holds the slider's orientation.
Protected variable const FAudioMeterStyle * Style Holds the style passed to the widget upon construction.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Construct ( const SAudioMeter::FArguments& InDeclaration
)

 Construct the widget.
Public function Const TArray< FMeterChannelInfo >  
Protected function Const float Returns the scale height based off font size and hash height.
Public function void

SetBackgroundColor ( FSlateColor InBackgroundColor
)

  
Public function void

SetMeterBackgroundColor ( FSlateColor InMeterBackgroundColor
)

  
Public function void

SetMeterChannelInfo ( const TAttribute< TArray< FMeterChannelInfo >>& InMeterChannelInfo
)

  
Public function void

SetMeterClippingColor ( FSlateColor InMeterPeakColor
)

  
Public function void

SetMeterPeakColor ( FSlateColor InMeterPeakColor
)

  
Public function void

SetMeterScaleColor ( FSlateColor InMeterScaleColor
)

  
Public function void

SetMeterScaleLabelColor ( FSlateColor InMeterScaleLabelColor
)

  
Public function void

SetMeterValueColor ( FSlateColor InMeterValueColor
)

  
Public function void

SetOrientation ( EOrientation InOrientation
)

 Set the Orientation attribute

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual Const bool Recomputes the volatility of the widget.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Overwritten from SWidget.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page