FNiagaraDataInterfaceProxySpectrum::GetSpectrumValue

Sample value from the spectrum buffer.

Windows
MacOS
Linux

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioSpectrum.h

Include

#include "NiagaraDataInterfaceAudioSpectrum.h"

Source

/Engine/Plugins/FX/Niagara/Source/Niagara/Private/NiagaraDataInterfaceAudioSpectrum.cpp

Syntax

float GetSpectrumValue
(
    float InNormalizedPositionInSpectrum,
    int32 InChannelIndex
)

Remarks

Sample value from the spectrum buffer.

Returns

Amplitude at this position. 0.0 corresponds to the nosie floor, while 1.0 corresponds to full volume. Some values may exceed 1.0.

Parameters

Parameter

Description

InNormalizedPositionInSpectrum

Value between 0 and 1 which represents the relative frequency in the spectrum. 0 corresponds to the MinimumFrequency, 1 corresponds to the MaximumFrequency. Values between 0 and 1 correspond to logarithmically spaced frequencys in-between the limits.

InChannelIndex

The index of the audio channel to sample.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss