1. Epic GamesDeveloper
  3. SAudioSliderBase

SAudioSliderBase

Slate audio sliders that wrap [SSlider](API\Runtime\Slate\Widgets\Input\SSlider) and provides additional audio specific functionality.

API > API/Plugins > API/Plugins/AudioWidgets

Inheritance Hierarchy

References

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

Syntax

class SAudioSliderBase : public SAudioInputWidget

Remarks

Slate audio sliders that wrap SSlider and provides additional audio specific functionality. This is a nativized version of the previous Audio Fader widget.

Variables

  Type Name Description
Protected variable TAttribute< TOptional< FVector2D > > DesiredSizeOverride Optional override for desired size.
Protected variable TSharedPtr< SAudioTextBox > Label  
Protected variable TAttribute< FSlateColor > LabelBackgroundColor Various colors.
Public variable FOnFloatValueChanged OnValueChanged Holds a delegate that is executed when the slider's value changed.
Public variable FOnFloatValueChanged OnValueCommitted Holds a delegate that is executed when the slider's value is committed (mouse capture ends).
Protected variable TAttribute< EOrientation > Orientation Holds the slider's orientation.
Protected variable FVector2D OutputRange Range for output, currently only used for frequency sliders and sliders without curves.
Protected variable TSharedPtr< SSlider > Slider Widget components.
Protected variable TAttribute< FSlateColor > SliderBackgroundColor  
Protected variable TSharedPtr< SImage > SliderBackgroundImage  
Protected variable TAttribute< FSlateColor > SliderBarColor  
Protected variable TAttribute< FSlateColor > SliderThumbColor  
Protected variable TAttribute< float > SliderValueAttribute Holds the slider's current linear value, from 0.0 - 1.0f.
Protected variable const FAudioSliderStyle * Style  
Protected variable TAttribute< FSlateColor > WidgetBackgroundColor  
Protected variable TSharedPtr< SImage > WidgetBackgroundImage  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

Construct ( const SAudioSliderBase::FArguments& InDeclaration
)

 Construct the widget.
Public function Virtual const float

GetOutputValueForText ( const float InSliderValue
)

  
Public function Virtual const float

GetSliderValueForText ( const float OutputValue
)

  
Public function void

SetOrientation ( EOrientation InOrientation
)

  
Public function void

SetShowLabelOnlyOnHover ( const bool bShowLabelOnlyOnHover
)

  
Public function void

SetSliderBackgroundColor ( FSlateColor InSliderBackgroundColor
)

  
Public function void

SetSliderBarColor ( FSlateColor InSliderBarColor
)

  
Public function void

SetSliderThumbColor ( FSlateColor InSliderThumbColor
)

  
Public function void

SetValueTextReadOnly ( const bool bIsReadOnly
)

  
Public function void

SetWidgetBackgroundColor ( FSlateColor InWidgetBackgroundColor
)

  

Overridden from SAudioInputWidget

  Type Name Description
Public function Virtual const float

GetOutputValue ( const float InSliderValue
)

  
Public function Virtual const float

GetSliderValue ( const float OutputValue
)

  
Public function Virtual void

SetDesiredSizeOverride ( const FVector2D DesiredSize
)

  
Public function Virtual void Text label functions.
Public function Virtual void

SetOutputRange ( const FVector2D Range
)

  
Public function Virtual void

SetShowUnitsText ( const bool bShowUnitsText
)

  
Public function Virtual void

SetSliderValue ( float InSliderValue
)

 Set the slider's linear (0-1 normalized) value.
Public function Virtual void

SetUnitsText ( const FText Units
)

  
Public function Virtual void

SetUnitsTextReadOnly ( const bool bIsReadOnly
)

  

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.

Classes

  Type Name Description
Public struct FArguments    

Constants

Name Description
NormalizedLinearSliderRange  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page