1. Epic GamesDeveloper
  3. UAudioMeter

UAudioMeter

An audio meter widget.

API > API/Plugins > API/Plugins/AudioWidgets

Inheritance Hierarchy

References

   
Module AudioWidgets
Header /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMeter.h
Include #include "AudioMeter.h"

Syntax

UCLASS&40;&41;  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FLinearColor BackgroundColor The color to draw the background.
Protected variable TArray< FMeterChannelInfo > K2_Cache_MeterChannelInfo  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FLinearColor MeterBackgroundColor The color to draw the meter background.
Public variable UProperty Category, EditAnywhere TArray< FMeterChannelInfo > MeterChannelInfo The current meter value to display.
Public variable UProperty FGetMeterChannelInfo 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< SAudioMeter > MyAudioMeter Native Slate Widget
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< EOrientation > Orientation The slider's orientation.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FAudioMeterStyle WidgetStyle The audio meter style

Constructors

  Type Name Description
Public function  

UAudioMeter ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category TArray< FMeterChannelInfo > Gets the current linear value of the meter.
Protected function TArray< FMeterChannelInfo >  
Public function UFunction BlueprintCallable, Category void Sets the background color
Public function UFunction BlueprintCallable, Category void Sets the meter background color
Public function UFunction BlueprintCallable, Category void

SetMeterChannelInfo ( const TArray< FMeterChannelInfo >& InMeterChannelInfo
)

 Sets the current meter values.
Public function UFunction BlueprintCallable, Category void Sets the meter clipping color
Public function UFunction BlueprintCallable, Category void Sets the meter peak color
Public function UFunction BlueprintCallable, Category void Sets the meter scale color
Public function UFunction BlueprintCallable, Category void Sets the meter scale color
Public function UFunction BlueprintCallable, Category void Sets the meter value color

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FGetMeterChannelInfo    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page