FAudioMeterStyle

Represents the appearance of an [SAudioMeter](API\Plugins\AudioWidgets\SAudioMeter)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateWidgetStyle

FAudioMeterStyle

References

Module

AudioWidgets

Header

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

Include

#include "AudioMeterStyle.h"

Syntax

USTRUCT(BlueprintType)
struct FAudioMeterStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an SAudioMeter

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateBrush

 

BackgroundImage

Image to use to represent the background.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bScaleSide

Which side to show the scale. If vertical, true means left side, false means right side. If horizontal, true means above, false means below.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bShowScale

Whether or not to show the decibel scale alongside the meter.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

int32

 

DecibelsPerHash

How wide to draw the decibel scale, if it's enabled.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateFontInfo

 

Font

Font family and size to be used when displaying the meter scale.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateBrush

 

MeterBackgroundImage

Image to use to represent the meter background.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FVector2D

 

MeterPadding

How much padding to add around the meter.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateBrush

 

MeterPeakImage

Image to use to represent the meter peak.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FVector2D

 

MeterSize

How thick to draw the meter.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateBrush

 

MeterValueBackgroundImage

Image to use to draw behind the meter value.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FSlateBrush

 

MeterValueImage

Image to use to represent the meter value.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

MeterValuePadding

How much padding to add around the meter value.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

PeakValueWidth

How wide to draw the peak value indicator.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

ScaleHashHeight

The height of each hash mark.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

ScaleHashOffset

Offset for the hashes.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

ScaleHashWidth

The width of each hash mark.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FVector2D

 

ValueRangeDb

The minimum and maximum value to display in dB (values are clamped in this range)

Constructors

Name Description

Public function

FAudioMeterStyle()

Destructors

Name Description

Public function Virtual

~FAudioMeterStyle()

Functions

Name Description

Public function Static

const FAudio...

 

GetDefault()

Public function

FAudioMeterS...

 

SetBackgroundImage

(
    const FSlateBrush& InBackgroundIma...
)

Public function

FAudioMeterS...

 

SetDecibelsPerHash

(
    float InDecibelsPerHash
)

Public function

FAudioMeterS...

 

SetFont

(
    const FName& InFontName,
    uint16 InSize
)

Public function

FAudioMeterS...

 

SetFont

(
    const FSlateFontInfo& InFont
)

Public function

FAudioMeterS...

 

SetFont

(
    const UObject* InFontObject,
    const int32 InSize,
    const FName& InTypefaceFontName
)

Public function

FAudioMeterS...

 

SetFont

(
    TSharedPtr< const FCompositeFont > ...,
    const int32 InSize,
    const FName& InTypefaceFontName
)

Public function

FAudioMeterS...

 

SetFont

(
    const ANSICHAR* InFontName,
    uint16 InSize
)

Public function

FAudioMeterS...

 

SetFont

(
    const WIDECHAR* InFontName,
    uint16 InSize
)

Public function

FAudioMeterS...

 

SetFont

(
    const FString& InFontName,
    uint16 InSize
)

Public function

FAudioMeterS...

 

SetFontName

(
    const FName& InFontName
)

Public function

FAudioMeterS...

 

SetFontName

(
    const FString& InFontName
)

Public function

FAudioMeterS...

 

SetFontName

(
    const WIDECHAR* InFontName
)

Public function

FAudioMeterS...

 

SetFontName

(
    const ANSICHAR* InFontName
)

Public function

FAudioMeterS...

 

SetFontSize

(
    uint16 InSize
)

Public function

FAudioMeterS...

 

SetMeterBackgroundImage

(
    const FSlateBrush& InMeterBackgrou...
)

Public function

FAudioMeterS...

 

SetMeterPadding

(
    const FVector2D& InMeterPadding
)

Public function

FAudioMeterS...

 

SetMeterPeakImage

(
    const FSlateBrush& InMeterPeakImag...
)

Public function

FAudioMeterS...

 

SetMeterSize

(
    const FVector2D& InMeterSize
)

Public function

FAudioMeterS...

 

SetMeterValueBackgroundImage

(
    const FSlateBrush& InMeterValueBac...
)

Public function

FAudioMeterS...

 

SetMeterValueImage

(
    const FSlateBrush& InMeterValueIma...
)

Public function

FAudioMeterS...

 

SetMeterValuePadding

(
    float InMeterValuePadding
)

Public function

FAudioMeterS...

 

SetPeakValueWidth

(
    float InPeakValueWidth
)

Public function

FAudioMeterS...

 

SetScaleHashHeight

(
    float InScaleHashHeight
)

Public function

FAudioMeterS...

 

SetScaleHashOffset

(
    float InScaleHashOffset
)

Public function

FAudioMeterS...

 

SetScaleHashWidth

(
    float InScaleHashWidth
)

Public function

FAudioMeterS...

 

SetScaleSide

(
    bool bInScaleSide
)

Public function

FAudioMeterS...

 

SetShowScale

(
    bool bInShowScale
)

Public function

FAudioMeterS...

 

SetTypefaceFontName

(
    const FName& InTypefaceFontName
)

Public function

FAudioMeterS...

 

SetValueRangeDb

(
    const FVector2D& InValueRangeDb
)

Public function

void

 

UnlinkColors()

Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

Name Description

Public function Virtual Const

void

 

GetResources

(
    TArray< const FSlateBrush* >&...
)

Gets the brush resources associated with this style.

Public function Virtual Const

const FName

 

GetTypeName()

Gets the name of this style.

This method must be implemented by inherited structures.

Constants

Name

Description

TypeName