UAudioMeter

An audio meter widget.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AudioWidgets

Header

/Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMeter.h

Include

#include "AudioMeter.h"

Syntax

UCLASS()
class UAudioMeter : public UWidget

Remarks

An audio meter widget.

Supports displaying a slower moving peak-hold value as well as the current meter value.

A clipping value is also displayed which shows a customizable color to indicate clipping.

Internal values are stored and interacted with as linear volume values.

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

BackgroundColor

The color to draw the background.

Protected variable

TArray< FMeterC...

 

K2_Cache_MeterChannelInfo

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterBackgroundColor

The color to draw the meter background.

Public variable UProperty Category, EditAnywhere

TArray< FMeterC...

 

MeterChannelInfo

The current meter value to display.

Public variable UProperty

FGetMeterChanne...

 

MeterChannelInfoDelegate

A bindable delegate to allow logic to drive the value of the meter

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterClippingColor

The color to draw the meter clipping value.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterPeakColor

The color to draw the meter peak value.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterScaleColor

The color to draw the meter scale hashes.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterScaleLabelColor

The color to draw the meter scale label.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

MeterValueColor

The color to draw the meter value.

Protected variable

TSharedPtr< SAu...

 

MyAudioMeter

Native Slate Widget

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

TEnumAsByte< EO...

 

Orientation

The slider's orientation.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FAudioMeterStyl...

 

WidgetStyle

The audio meter style

Constructors

Name Description

Public function

UAudioMeter

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

TArray< FMet...

 

GetMeterChannelInfo()

Gets the current linear value of the meter.

Protected function

TArray< FMet...

 

K2_Gate_MeterChannelInfo()

Public function UFunction BlueprintCallable, Category

void

 

SetBackgroundColor

(
    FLinearColor InValue
)

Sets the background color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterBackgroundColor

(
    FLinearColor InValue
)

Sets the meter background color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterChannelInfo

(
    const TArray< FMeterChannelInfo >&...
)

Sets the current meter values.

Public function UFunction BlueprintCallable, Category

void

 

SetMeterClippingColor

(
    FLinearColor InValue
)

Sets the meter clipping color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterPeakColor

(
    FLinearColor InValue
)

Sets the meter peak color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterScaleColor

(
    FLinearColor InValue
)

Sets the meter scale color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterScaleLabelColor

(
    FLinearColor InValue
)

Sets the meter scale color

Public function UFunction BlueprintCallable, Category

void

 

SetMeterValueColor

(
    FLinearColor InValue
)

Sets the meter value color

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Classes

Name

Description

Public class

FGetMeterChannelInfo