1. Epic GamesDeveloper
  3. FAudioMeter

FAudioMeter

API > API/Plugins > API/Plugins/AudioWidgets

   
Name FAudioMeter
Type class
Header File /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMeter.h
Include Path #include "AudioMeter.h"

Syntax

class FAudioMeter : public AudioWidgets::IAudioAnalyzerRackUnit

Constructors

Name Remarks Include Path Unreal Specifiers

FAudioMeter ( int32 InNumChannels,
UWorld& InWorld,
TObjectPtr< UAudioBus > InExternalAudioBus
)

   AudioMeter.h  

FAudioMeter ( const int32 InNumChannels,
const Audio::FDeviceId InAudioDeviceId,
TObjectPtr< UAudioBus > InExternalAudioBus,
const FAudioMeterDefaultColorStyle* AudioMeterColorStyle
)

   AudioMeter.h  

FAudioMeter ( const int32 InNumChannels,
const Audio::FDeviceId InAudioDeviceId,
const FAudioMaterialMeterStyle& AudioMaterialMeterStyle,
TObjectPtr< UAudioBus > InExternalAudioBus
)

   AudioMeter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAudioMeter()

   AudioMeter.h  

Constants

Name Type Remarks Include Path
RackUnitTypeInfo const FAudioAnalyzerRackUnitTypeInfo   AudioMeter.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Analyzer TStrongObjectPtr< UMeterAnalyzer > Metasound analyzer object. AudioMeter.h  
AudioBus TStrongObjectPtr< UAudioBus > The audio bus used for analysis. AudioMeter.h  
bUseExternalAudioBus bool   AudioMeter.h  
ChannelInfo TArray< FMeterChannelInfo > Cached channel info for the meter. AudioMeter.h  
ResultsDelegateHandle FDelegateHandle Handle for results delegate for MetaSound meter analyzer. AudioMeter.h  
Settings TStrongObjectPtr< UMeterSettings > Meter settings. AudioMeter.h  
Widget TSharedPtr< SAudioMeterBase > MetaSound Output Meter widget AudioMeter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UAudioBus * GetAudioBus()

   AudioMeter.h  
  AudioMeter.h  
  AudioMeter.h  

void Init ( int32 InNumChannels,
UWorld& InWorld,
TObjectPtr< UAudioBus > InExternalAudioBus
)

   AudioMeter.h  

void Init ( const int32 InNumChannels,
const Audio::FDeviceId InAudioDeviceId,
TObjectPtr< UAudioBus > InExternalAudioBus
)

   AudioMeter.h  

Overridden from IAudioAnalyzerRackUnit

Name Remarks Include Path Unreal Specifiers

virtual void SetAudioBusInfo ( const FAudioBusInfo& AudioBusInfo
)

 If the Audio Bus to analyze changes (due to channel count change), handle this here. AudioMeter.h  

virtual TSharedRef< SDockTab > SpawnTab ( const FSpawnTabArgs& Args
) const

 Spawn the actual analyzer Widget in a DockTab. AudioMeter.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnMeterOutput ( UMeterAnalyzer* InMeterAnalyzer,
int32 ChannelIndex,
const FMeterResults& InMeterResults
)

   AudioMeter.h  

Static

Name Remarks Include Path Unreal Specifiers
  AudioMeter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page