SAudioSliderBase

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected variable

TAttribute< TOp...

 

DesiredSizeOverride

Optional override for desired size.

Protected variable

TSharedPtr< SAu...

 

Label

Protected variable

TAttribute< FSl...

 

LabelBackgroundColor

Various colors.

Public variable

FOnFloatValueCh...

 

OnValueChanged

Holds a delegate that is executed when the slider's value changed.

Public variable

FOnFloatValueCh...

 

OnValueCommitted

Holds a delegate that is executed when the slider's value is committed (mouse capture ends).

Protected variable

TAttribute< EOr...

 

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< SSl...

 

Slider

Widget components.

Protected variable

TAttribute< FSl...

 

SliderBackgroundColor

Protected variable

TSharedPtr< SIm...

 

SliderBackgroundImage

Protected variable

TAttribute< FSl...

 

SliderBarColor

Protected variable

TAttribute< FSl...

 

SliderThumbColor

Protected variable

const FAudioSli...

 

Style

Protected variable

TAttribute< flo...

 

ValueAttribute

Holds the slider's current linear value, from 0.0 - 1.0f.

Protected variable

TAttribute< FSl...

 

WidgetBackgroundColor

Protected variable

TSharedPtr< SIm...

 

WidgetBackgroundImage

Constructors

Name Description

Public function

SAudioSliderBase()

Destructors

Name Description

Public function Virtual

~SAudioSliderBase()

Functions

Name Description

Public function Virtual

void

 

Construct

(
    const SAudioSliderBase::FArguments ...
)

Construct the widget.

Public function Virtual

const float

 

GetLinValueForText

(
    const float OutputValue
)

Public function Virtual

const float

 

GetOutputValueForText

(
    const float LinValue
)

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

Name Description

Public function Virtual

const float

 

GetLinValue

(
    const float OutputValue
)

Public function Virtual

const float

 

GetOutputValue

(
    const float LinValue
)

Public function Virtual

void

 

SetDesiredSizeOverride

(
    const FVector2D DesiredSize
)

Public function Virtual

void

 

SetLabelBackgroundColor

(
    FSlateColor InColor
)

Text label functions.

Public function Virtual

void

 

SetOutputRange

(
    const FVector2D Range
)

Public function Virtual

void

 

SetShowUnitsText

(
    const bool bShowUnitsText
)

Public function Virtual

void

 

SetUnitsText

(
    const FText Units
)

Public function Virtual

void

 

SetUnitsTextReadOnly

(
    const bool bIsReadOnly
)

Public function Virtual

void

 

SetValue

(
    float LinValue
)

Set the slider's linear (0-1 normalized) value.

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Classes

Name

Description

Public struct

FArguments

Constants

Name

Description

LinearRange