#include <SpectrumAnalyzer.h>

Public Types
enum class	EMetric : uint8 { Magnitude , Power , Decibel }

Public Attributes
EMetric	Metric = EMetric::Decibel

float	DecibelNoiseFloor = -40.f

bool	bDoNormalize = true

bool	bDoAutoRange = true

float	AutoRangeReleaseTimeInSeconds = 30.f

float	AutoRangeAttackTimeInSeconds = 1.f

Detailed Description

Settings for band extractor.

Member Enumeration Documentation

◆ EMetric

enum class Audio::FSpectrumBandExtractorSettings::EMetric : uint8

strong

Metric for output band values.

Enumerator
Magnitude	Return the magnitude spectrum value.
Power	Return the power spectrum value.
Decibel	Return the decibel spectrum value. Decibels are calculated with 0dB equal to 1.f magnitude.

Member Data Documentation

◆ AutoRangeAttackTimeInSeconds

float Audio::FSpectrumBandExtractorSettings::AutoRangeAttackTimeInSeconds = 1.f

Time in seconds for autorange to reach 99% of a larger range.

◆ AutoRangeReleaseTimeInSeconds

float Audio::FSpectrumBandExtractorSettings::AutoRangeReleaseTimeInSeconds = 30.f

Time in seconds for autorange to reach 99% of a smaller range.

◆ bDoAutoRange

bool Audio::FSpectrumBandExtractorSettings::bDoAutoRange = true

If true and bDoNormalize is true, then values will be scaled between 0 and 1 based upon relatively recent minimum and maximum values.

◆ bDoNormalize

bool Audio::FSpectrumBandExtractorSettings::bDoNormalize = true

If true, all values are scaled and clamped between 0.0 and 1.f. In the case of Decibels, 0.0 corresponds to the decibel noise floor and 1.f to 0dB. If bDoAutoRange is true, then values are relatively to recent maximum and minimums regardless of the metric used.

◆ DecibelNoiseFloor

float Audio::FSpectrumBandExtractorSettings::DecibelNoiseFloor = -40.f

If the metric is Decibel, this is the minimum decibel value allowed.

◆ Metric

EMetric Audio::FSpectrumBandExtractorSettings::Metric = EMetric::Decibel

Metric used to calculate return value.

The documentation for this struct was generated from the following file:

Engine/Source/Runtime/SignalProcessing/Public/DSP/SpectrumAnalyzer.h

Public Types

Public Attributes