1. Epic GamesDeveloper
  3. FAudioMeterStyle

FAudioMeterStyle

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

API > API/Plugins > API/Plugins/AudioWidgets

Inheritance Hierarchy

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FAudioMeterStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an SAudioMeter

Variables

  Type 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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static const FAudioMeterStyle &  
Public function FAudioMeterStyle &

SetBackgroundImage ( const FSlateBrush& InBackgroundImage
)

  
Public function FAudioMeterStyle &

SetDecibelsPerHash ( float InDecibelsPerHash
)

  
Public function FAudioMeterStyle &

SetFont ( const FName& InFontName,
uint16 InSize
)

  
Public function FAudioMeterStyle &

SetFont ( const FSlateFontInfo& InFont
)

  
Public function FAudioMeterStyle &

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

  
Public function FAudioMeterStyle &

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

  
Public function FAudioMeterStyle &

SetFont ( const ANSICHAR* InFontName,
uint16 InSize
)

  
Public function FAudioMeterStyle &

SetFont ( const WIDECHAR* InFontName,
uint16 InSize
)

  
Public function FAudioMeterStyle &

SetFont ( const FString& InFontName,
uint16 InSize
)

  
Public function FAudioMeterStyle &

SetFontName ( const FName& InFontName
)

  
Public function FAudioMeterStyle &

SetFontName ( const FString& InFontName
)

  
Public function FAudioMeterStyle &

SetFontName ( const WIDECHAR* InFontName
)

  
Public function FAudioMeterStyle &

SetFontName ( const ANSICHAR* InFontName
)

  
Public function FAudioMeterStyle &

SetFontSize ( uint16 InSize
)

  
Public function FAudioMeterStyle &

SetMeterBackgroundImage ( const FSlateBrush& InMeterBackgroundImage
)

  
Public function FAudioMeterStyle &

SetMeterPadding ( const FVector2D& InMeterPadding
)

  
Public function FAudioMeterStyle &

SetMeterPeakImage ( const FSlateBrush& InMeterPeakImage
)

  
Public function FAudioMeterStyle &

SetMeterSize ( const FVector2D& InMeterSize
)

  
Public function FAudioMeterStyle &

SetMeterValueBackgroundImage ( const FSlateBrush& InMeterValueBackgroundImage
)

  
Public function FAudioMeterStyle &

SetMeterValueImage ( const FSlateBrush& InMeterValueImage
)

  
Public function FAudioMeterStyle &

SetMeterValuePadding ( float InMeterValuePadding
)

  
Public function FAudioMeterStyle &

SetPeakValueWidth ( float InPeakValueWidth
)

  
Public function FAudioMeterStyle &

SetScaleHashHeight ( float InScaleHashHeight
)

  
Public function FAudioMeterStyle &

SetScaleHashOffset ( float InScaleHashOffset
)

  
Public function FAudioMeterStyle &

SetScaleHashWidth ( float InScaleHashWidth
)

  
Public function FAudioMeterStyle &

SetScaleSide ( bool bInScaleSide
)

  
Public function FAudioMeterStyle &

SetShowScale ( bool bInShowScale
)

  
Public function FAudioMeterStyle &

SetTypefaceFontName ( const FName& InTypefaceFontName
)

  
Public function FAudioMeterStyle &

SetValueRangeDb ( const FVector2D& InValueRangeDb
)

  
Public function void Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

  Type Name Description
Public function Virtual Const void

GetResources ( TArray< const FSlateBrush* >& OutBrushes
)

 Gets the brush resources associated with this style.
Public function Virtual Const const FName Gets the name of this style.This method must be implemented by inherited structures.

Constants

Name Description
TypeName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page