SAudioMeter

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected variable

TAttribute< FSl...

 

BackgroundColor

Various colors.

Public variable

bool

 

bIsActiveTimerRegistered

Is the active timer registered to refresh the meter channel info.

Protected variable

TAttribute< FSl...

 

MeterBackgroundColor

Protected variable

TAttribute< TAr...

 

MeterChannelInfoAttribute

Protected variable

TAttribute< FSl...

 

MeterClippingColor

Protected variable

TAttribute< FSl...

 

MeterPeakColor

Protected variable

TAttribute< FSl...

 

MeterScaleColor

Protected variable

TAttribute< FSl...

 

MeterScaleLabelColor

Protected variable

TAttribute< FSl...

 

MeterValueColor

Protected variable

EOrientation

 

Orientation

Holds the slider's orientation.

Protected variable

const FAudioMet...

 

Style

Holds the style passed to the widget upon construction.

Constructors

Name Description

Public function

SAudioMeter()

Functions

Name Description

Public function

void

 

Construct

(
    const SAudioMeter::FArguments& InD...
)

Construct the widget.

Public function Const

TArray< FMet...

 

GetMeterChannelInfo()

Protected function Const

float

 

GetScaleHeight()

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< FMeterCha...
)

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

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float
)

Overwritten from SWidget.

Public function Virtual Const

bool

 

ComputeVolatility()

Recomputes the volatility of the widget.

Public function Virtual Const

int32

 

OnPaint

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

Overwritten from SWidget.

Classes

Name

Description

Public struct

FArguments