UNiagaraDataInterfaceAudioSpectrum

Data Interface allowing sampling of recent audio spectrum.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Niagara

Header

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

Include

#include "NiagaraDataInterfaceAudioSpectrum.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Audio", Meta=(DisplayName="Audio Spectrum"))
class UNiagaraDataInterfaceAudioSpectrum : public UNiagaraDataInterfaceAudioSubmix

Remarks

Data Interface allowing sampling of recent audio spectrum.

Variables

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

Name Description

Public function

UNiagaraDataInterfaceAudioSpectrum

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

GetNumChannels

(
    FVectorVMContext& Context
)

Public function

void

 

GetSpectrumValue

(
    FVectorVMContext& Context
)

VM function overrides:

Overridden from UNiagaraDataInterface

Name Description

Public function Virtual Const

bool

 

CanExecuteOnTarget

(
    ENiagaraSimTarget Target
)

Protected function Virtual Const

bool

 

CopyToInternal

(
    UNiagaraDataInterface* Destina...
)

Public function Virtual Const

bool

 

Equals

(
    const UNiagaraDataInterface* O...
)

Determines if this DataInterface is the same as another.

Public function Virtual

bool

 

GetFunctionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    const FNiagaraDataInterfaceGenerate...,
    int FunctionInstanceIndex,
    FString& OutHLSL
)

Public function Virtual

void

 

GetFunctions

Gets all the available functions for this data interface.

Public function Virtual

void

 

GetParameterDefinitionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    FString& OutHLSL
)

Public function Virtual

void

 

GetVMExternalFunction

(
    const FVMExternalFunctionBindingInf...,
    void* InstanceData,
    FVMExternalFunction& OutFunc
)

Returns the delegate for the passed function signature.

Overridden from UNiagaraDataInterfaceBase

Name Description

Public function Virtual

void

 

BindParameters

(
    FNiagaraDataInterfaceParametersCS&...,
    const FNiagaraDataInterfaceGPUParam...,
    const FShaderParameterMap& Paramet...
)

Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method

Public function Virtual Const

FNiagaraData...

 

CreateComputeParameters()

Constructs the correct CS parameter type for this DI (if any).

Public function Virtual Const

const FTypeL...

 

GetComputeParametersTypeDesc()

Public function Virtual Const

void

 

SetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Public function Virtual Const

void

 

UnsetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

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

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