1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceAudioSpectrum

UNiagaraDataInterfaceAudioSpectrum

Data Interface allowing sampling of recent audio spectrum.

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Audio", Meta&61;&40;DisplayName&61;"Audio Spectrum"&41;, MinimalAPI&41;  
class UNiagaraDataInterfaceAudioSpectrum : public UNiagaraDataInterfaceAudioSubmix

Remarks

Data Interface allowing sampling of recent audio spectrum.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta float MaximumFrequency The maximum frequency represented in the spectrum.
Public variable UProperty Category, EditAnywhere, Meta float MinimumFrequency The minimum frequency represented in the spectrum.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NoiseFloorDb The decibel level considered as silence. This is used to scale the output of the spectrum.
Public variable UProperty Category, EditAnywhere, Meta int32 Resolution The number of spectrum samples to pass to the GPU

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

GetNumChannels ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetSpectrumValue ( FVectorVMExternalFunctionContext& Context
)

 VM function overrides:

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual bool

GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

  
Public function Virtual void Gets all the available functions for this data interface.
Public function Virtual void  
Public function Virtual void

GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature.
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Public class FShaderParameters    

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page