UNiagaraDataInterfaceAudioSpectrum

Data Interface allowing sampling of recent audio spectrum.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceAudioSubmix

UNiagaraDataInterfaceAudioSpectrum

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioSpectrum.h
Include	#include "NiagaraDataInterfaceAudioSpectrum.h"

Syntax

UCLASS(EditInlineNew, Category="Audio", Meta=(DisplayName="Audio Spectrum"))
class UNiagaraDataInterfaceAudioSpectrum : public UNiagaraDataInterfaceAudioSubmix

Remarks

Data Interface allowing sampling of recent audio spectrum.

Variables

	Name	Description
float	MaximumFrequency	The maximum frequency represented in the spectrum.
float	MinimumFrequency	The minimum frequency represented in the spectrum.
float	NoiseFloorDb	The decibel level considered as silence. This is used to scale the output of the spectrum.
int32	Resolution	The number of spectrum samples to pass to the GPU

Constructors

	Name	Description
	UNiagaraDataInterfaceAudioSpectrum ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	GetNumChannels ( FVectorVMExternalFunctionContext& ... )
	void	GetSpectrumValue ( FVectorVMExternalFunctionContext& ... )	VM function overrides:

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.

Overridden from UNiagaraDataInterfaceBase

	Name	Description
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Constants

Name	Description
GetNumChannelsFunctionName
GetSpectrumFunctionName	VM function names.
GetSpectrumName	Global variable prefixes.
NumChannelsName
ResolutionName