1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceAudioSpectrum

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 UNiagaraDataInterfaceAudioSubmix

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceAudioSpectrum ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceAudioSpectrum.h  

Classes

Name Remarks
FShaderParameters  

Constants

Name Type Remarks Include Path
GetNumChannelsFunctionName const FName   NiagaraDataInterfaceAudioSpectrum.h
GetSpectrumFunctionName const FName VM function names. NiagaraDataInterfaceAudioSpectrum.h
GetSpectrumName const FString Global variable prefixes. NiagaraDataInterfaceAudioSpectrum.h
NumChannelsName const FString   NiagaraDataInterfaceAudioSpectrum.h
ResolutionName const FString   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")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GetNumChannels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioSpectrum.h  

void GetSpectrumValue ( FVectorVMExternalFunctionContext& Context
)

 VM function overrides: NiagaraDataInterfaceAudioSpectrum.h  

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 bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceAudioSpectrum.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. 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  
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 PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraDataInterfaceAudioSpectrum.h  

virtual void PostInitProperties()

   NiagaraDataInterfaceAudioSpectrum.h  

virtual void PostLoad()

   NiagaraDataInterfaceAudioSpectrum.h  

Protected

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