Navigation
API > API/Plugins > API/Plugins/AudioWidgets
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.
| Name | UAudioMeter |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMeter.h |
| Include Path | #include "AudioMeter.h" |
Syntax
UCLASS (MinimalAPI)
class UAudioMeter : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UAudioMeter
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAudioMeter
(
const FObjectInitializer& ObjectInitializer |
AudioMeter.h |
Classes
| Name | Remarks |
|---|---|
| FGetMeterChannelInfo |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundColor | FLinearColor | The color to draw the background. | AudioMeter.h |
|
| MeterBackgroundColor | FLinearColor | The color to draw the meter background. | AudioMeter.h |
|
| MeterChannelInfo | TArray< FMeterChannelInfo > | The current meter value to display. | AudioMeter.h |
|
| MeterChannelInfoDelegate | FGetMeterChannelInfo | A bindable delegate to allow logic to drive the value of the meter | AudioMeter.h | |
| MeterClippingColor | FLinearColor | The color to draw the meter clipping value. | AudioMeter.h |
|
| MeterPeakColor | FLinearColor | The color to draw the meter peak value. | AudioMeter.h |
|
| MeterScaleColor | FLinearColor | The color to draw the meter scale hashes. | AudioMeter.h |
|
| MeterScaleLabelColor | FLinearColor | The color to draw the meter scale label. | AudioMeter.h |
|
| MeterValueColor | FLinearColor | The color to draw the meter value. | AudioMeter.h |
|
| Orientation | TEnumAsByte< EOrientation > | The slider's orientation. | AudioMeter.h |
|
| WidgetStyle | FAudioMeterStyle | The audio meter style | AudioMeter.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FMeterChannelInfo > GetMeterChannelInfo() |
Gets the current linear value of the meter. | AudioMeter.h |
|
void SetBackgroundColor
(
FLinearColor InValue |
Sets the background color | AudioMeter.h |
|
void SetMeterBackgroundColor
(
FLinearColor InValue |
Sets the meter background color | AudioMeter.h |
|
void SetMeterChannelInfo
(
const TArray< FMeterChannelInfo >& InMeterChannelInfo |
Sets the current meter values. | AudioMeter.h |
|
void SetMeterClippingColor
(
FLinearColor InValue |
Sets the meter clipping color | AudioMeter.h |
|
void SetMeterPeakColor
(
FLinearColor InValue |
Sets the meter peak color | AudioMeter.h |
|
void SetMeterScaleColor
(
FLinearColor InValue |
Sets the meter scale color | AudioMeter.h |
|
void SetMeterScaleLabelColor
(
FLinearColor InValue |
Sets the meter scale color | AudioMeter.h |
|
void SetMeterValueColor
(
FLinearColor InValue |
Sets the meter value color | AudioMeter.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
AudioMeter.h | ||
virtual void SynchronizeProperties() |
AudioMeter.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
AudioMeter.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FMeterChannelInfo > K2_Gate_MeterChannelInfo() |
AudioMeter.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
AudioMeter.h |