UNiagaraDataInterfaceAudioSpectrum

Data Interface allowing sampling of recent audio spectrum.

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of recent audio spectrum.

   
Name UNiagaraDataInterfaceAudioSpectrum
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioSpectrum.h
Include Path #include "NiagaraDataInterfaceAudioSpectrum.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceAudioSpectrum ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceAudioSpectrum.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MaximumFrequency float The maximum frequency represented in the spectrum. NiagaraDataInterfaceAudioSpectrum.h
  • EditAnywhere
  • Category="Spectrum"
  • Meta=(ClampMin="20.0", ClampMax="20000.0")
MinimumFrequency float The minimum frequency represented in the spectrum. NiagaraDataInterfaceAudioSpectrum.h
  • EditAnywhere
  • Category="Spectrum"
  • Meta=(ClampMin="20.0", ClampMax="20000.0")
NoiseFloorDb float The decibel level considered as silence. This is used to scale the output of the spectrum. NiagaraDataInterfaceAudioSpectrum.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Spectrum"
  • Meta=(ClampMin="-120.0", ClampMax="0.0")
Resolution int32 The number of spectrum samples to pass to the GPU NiagaraDataInterfaceAudioSpectrum.h
  • EditAnywhere
  • Category="Spectrum"
  • Meta=(ClampMin="16", ClampMax="1024")
Submix TObjectPtr< USoundSubmix > The audio submix where analyzed. NiagaraDataInterfaceAudioSpectrum.h
  • EditAnywhere
  • Category="Audio"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GetNumChannels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioSpectrum.h  

void GetSpectrumValue ( FVectorVMExternalFunctionContext& Context
)

 VM function overrides: NiagaraDataInterfaceAudioSpectrum.h  

Public Virtual

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceAudioSpectrum.h  

virtual ETickingGroup CalculateTickGroup ( const void* PerInstanceData
) const

   NiagaraDataInterfaceAudioSpectrum.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceAudioSpectrum.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceAudioSpectrum.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceAudioSpectrum.h  

virtual void GetCommonHLSL ( FString& OutHLSL
)

 Allows data interfaces to provide common functionality that will be shared across interfaces on that type. NiagaraDataInterfaceAudioSpectrum.h  

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

   NiagaraDataInterfaceAudioSpectrum.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceAudioSpectrum.h  

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

 Returns the delegate for the passed function signature. NiagaraDataInterfaceAudioSpectrum.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceAudioSpectrum.h  

virtual bool HasTickGroupPrereqs()

   NiagaraDataInterfaceAudioSpectrum.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceAudioSpectrum.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceAudioSpectrum.h  

virtual bool PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceAudioSpectrum.h  

virtual void ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this. NiagaraDataInterfaceAudioSpectrum.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceAudioSpectrum.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceAudioSpectrum.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceAudioSpectrum.h  

Protected Virtual

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceAudioSpectrum.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceAudioSpectrum.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page