Navigation
API > API/Plugins > API/Plugins/AudioWidgets
Inheritance Hierarchy
- FSlateControlledConstruction
- TSharedFromThis
- SWidget
- SCompoundWidget
- SAudioInputWidget
- SAudioSliderBase
- SAudioFrequencySlider
- SAudioSlider
- SAudioVolumeSlider
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 | |
|---|---|---|---|
| TAttribute< TOptional< FVector2D > > | DesiredSizeOverride | Optional override for desired size. | |
| TSharedPtr< SAudioTextBox > | Label | ||
| TAttribute< FSlateColor > | LabelBackgroundColor | Various colors. | |
| FOnFloatValueChanged | OnValueChanged | Holds a delegate that is executed when the slider's value changed. | |
| FOnFloatValueChanged | OnValueCommitted | Holds a delegate that is executed when the slider's value is committed (mouse capture ends). | |
| TAttribute< EOrientation > | Orientation | Holds the slider's orientation. | |
| FVector2D | OutputRange | Range for output, currently only used for frequency sliders and sliders without curves. | |
| TSharedPtr< SSlider > | Slider | Widget components. | |
| TAttribute< FSlateColor > | SliderBackgroundColor | ||
| TSharedPtr< SImage > | SliderBackgroundImage | ||
| TAttribute< FSlateColor > | SliderBarColor | ||
| TAttribute< FSlateColor > | SliderThumbColor | ||
| TAttribute< float > | SliderValueAttribute | Holds the slider's current linear value, from 0.0 - 1.0f. | |
| const FAudioSliderStyle * | Style | ||
| TAttribute< FSlateColor > | WidgetBackgroundColor | ||
| TSharedPtr< SImage > | WidgetBackgroundImage |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Construct
(
const SAudioSliderBase::FArguments& InDeclaration |
Construct the widget. | |
| const float | GetOutputValueForText
(
const float InSliderValue |
||
| const float | GetSliderValueForText
(
const float OutputValue |
||
| void | SetOrientation
(
EOrientation InOrientation |
||
| void | SetShowLabelOnlyOnHover
(
const bool bShowLabelOnlyOnHover |
||
| void | SetSliderBackgroundColor
(
FSlateColor InSliderBackgroundColor |
||
| void | SetSliderBarColor
(
FSlateColor InSliderBarColor |
||
| void | SetSliderThumbColor
(
FSlateColor InSliderThumbColor |
||
| void | SetValueTextReadOnly
(
const bool bIsReadOnly |
||
| void | SetWidgetBackgroundColor
(
FSlateColor InWidgetBackgroundColor |
Overridden from SAudioInputWidget
| Type | Name | Description | |
|---|---|---|---|
| const float | GetOutputValue
(
const float InSliderValue |
||
| const float | GetSliderValue
(
const float OutputValue |
||
| void | SetDesiredSizeOverride
(
const FVector2D DesiredSize |
||
| void | SetLabelBackgroundColor
(
FSlateColor InColor |
Text label functions. | |
| void | SetOutputRange
(
const FVector2D Range |
||
| void | SetShowUnitsText
(
const bool bShowUnitsText |
||
| void | SetSliderValue
(
float InSliderValue |
Set the slider's linear (0-1 normalized) value. | |
| void | SetUnitsText
(
const FText Units |
||
| void | SetUnitsTextReadOnly
(
const bool bIsReadOnly |
Overridden from SWidget
| Type | Name | Description | |
|---|---|---|---|
| FVector2D | ComputeDesiredSize
(
float LayoutScaleMultiplier |
Compute the ideal size necessary to display this widget. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FArguments |
Constants
| Name | Description |
|---|---|
| NormalizedLinearSliderRange |