FParameterInterface | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/AudioExtensions

Interface for parameterizing data provided to or coming from an executable audio unit (ex. Sound like a MetaSoundSource, arbitrary DSP graph like a MetaSoundPatch, etc.). Can be used generically for processing either logically at a control or Game Thread tick rate (ex. SoundCues), or by an underlying DSP operation via the Audio Render Thread or delegated task (ex. MetaSounds, custom SoundGenerator, etc.)


Name	FParameterInterface
Type	struct
Header File	/Engine/Source/Runtime/AudioExtensions/Public/IAudioParameterInterfaceRegistry.h
Include Path	#include "IAudioParameterInterfaceRegistry.h"

Syntax

struct FParameterInterface

Constructors

Name	Remarks	Include Path
FParameterInterface ()		IAudioParameterInterfaceRegistry.h
FParameterInterface ( FName InName, const FVersion& InVersion )	Constructor used for parameter interface not limited to any particular UClass types.	IAudioParameterInterfaceRegistry.h
FParameterInterface ( FName InName, const FVersion& InVersion, const UClass& InClass )		IAudioParameterInterfaceRegistry.h

Structs

Name	Remarks
FClassOptions	Options used to restrict a corresponding UClass that interface may be applied to.
FEnvironmentVariable	Read-only variable that cannot be modified by the sound instance, and maybe shared amongst instances.
FInput
FOutput
FVersion	Version of interface (higher numbers are more recent)

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
NamePrivate	FName		IAudioParameterInterfaceRegistry.h
VersionPrivate	FVersion		IAudioParameterInterfaceRegistry.h

Functions

Public

Name	Remarks	Include Path
TArray< const UClass * > FindSupportedUClasses()		IAudioParameterInterfaceRegistry.h
const TArray< FEnvironmentVariable > & GetEnvironment()	Returns read-only array of environment variables.	IAudioParameterInterfaceRegistry.h
const TArray< FInput > & GetInputs()	Returns read-only array of inputs.	IAudioParameterInterfaceRegistry.h
FName GetName()		IAudioParameterInterfaceRegistry.h
const TArray< FOutput > & GetOutputs()	Returns read-only array of outputs.	IAudioParameterInterfaceRegistry.h
const UClass & GetType()		IAudioParameterInterfaceRegistry.h
const TArray< FClassOptions > & GetUClassOptions ()	If specified, options used to restrict a corresponding UClass that interface may be applied to.	IAudioParameterInterfaceRegistry.h
const FVersion & GetVersion()		IAudioParameterInterfaceRegistry.h

Navigation