UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FAudioParameter Struct Referenceabstract

#include <AudioParameter.h>

Public Member Functions

 FAudioParameter ()=default
 
 FAudioParameter (FName InName)
 
 FAudioParameter (FName InName, float InValue)
 
 FAudioParameter (FName InName, bool InValue)
 
 FAudioParameter (FName InName, int32 InValue)
 
 FAudioParameter (FName InName, UObject *InValue)
 
 FAudioParameter (FName InName, const FString &InValue)
 
 FAudioParameter (FName InName, const TArray< float > &InValue)
 
 FAudioParameter (FName InName, TArray< float > &&InValue)
 
 FAudioParameter (FName InName, const TArray< bool > &InValue)
 
 FAudioParameter (FName InName, TArray< bool > &&InValue)
 
 FAudioParameter (FName InName, const TArray< int32 > &InValue)
 
 FAudioParameter (FName InName, TArray< int32 > &&InValue)
 
 FAudioParameter (FName InName, const TArray< UObject * > &InValue)
 
 FAudioParameter (FName InName, const TArray< FString > &InValue)
 
 FAudioParameter (FName InName, TArray< FString > &&InValue)
 
 FAudioParameter (FName InName, EAudioParameterType Type)
 
AUDIOEXTENSIONS_API void Merge (const FAudioParameter &InParameter, bool bInTakeName=true, bool bInTakeType=true, bool bInMergeArrayTypes=false)
 
 FAudioParameter (FAudioParameter &&InParameter)=default
 
 FAudioParameter (const FAudioParameter &InParameter)=default
 
FAudioParameter & operator= (const FAudioParameter &InParameter)=default
 
FAudioParameter & operator= (FAudioParameter &&InParameter)=default
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Float)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Float"), Category=AudioParameter) float FloatParam=0.f
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Bool)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Boolean"), Category=AudioParameter) bool BoolParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Int)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Integer || ParamType == EAudioParameterType::NoneArray"), Category=AudioParameter) int32 IntParam=0
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Object)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Object"), Category=AudioParameter) TObjectPtr< UObject > ObjectParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (String)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::String"), Category=AudioParameter) FString StringParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Float Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::FloatArray"), Category=AudioParameter) TArray< float > ArrayFloatParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Bool Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::BooleanArray"), Category=AudioParameter) TArray< bool > ArrayBoolParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Int Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::IntegerArray"), Category=AudioParameter) TArray< int32 > ArrayIntParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (Object Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::ObjectArray"), Category=AudioParameter) TArray< TObjectPtr< UObject > > ArrayObjectParam
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, meta=(DisplayName="Value (String Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::StringArray"), Category=AudioParameter) TArray< FString > ArrayStringParam
 

Static Public Member Functions

static FAudioParameter CreateDefaultArray (FName InName, int32 InNum)
 
static AUDIOEXTENSIONS_API void Merge (TArray< FAudioParameter > &&InParams, TArray< FAudioParameter > &OutParams)
 
static const FAudioParameter * FindParam (const TArray< FAudioParameter > &InParams, FName InParamName)
 
static FAudioParameter * FindOrAddParam (TArray< FAudioParameter > &OutParams, FName InParamName)
 

Public Attributes

FName ParamName
 
EAudioParameterType ParamType = EAudioParameterType::None
 
FName TypeName
 
TArray< TSharedPtr< Audio::IProxyData > > ObjectProxies
 

Constructor & Destructor Documentation

◆ FAudioParameter() [1/19]

FAudioParameter::FAudioParameter ( )
default

◆ FAudioParameter() [2/19]

FAudioParameter::FAudioParameter ( FName  InName)
inline

◆ FAudioParameter() [3/19]

FAudioParameter::FAudioParameter ( FName  InName,
float  InValue 
)
inline

◆ FAudioParameter() [4/19]

FAudioParameter::FAudioParameter ( FName  InName,
bool  InValue 
)
inline

◆ FAudioParameter() [5/19]

FAudioParameter::FAudioParameter ( FName  InName,
int32  InValue 
)
inline

◆ FAudioParameter() [6/19]

FAudioParameter::FAudioParameter ( FName  InName,
UObject *  InValue 
)
inline

◆ FAudioParameter() [7/19]

FAudioParameter::FAudioParameter ( FName  InName,
const FString &  InValue 
)
inline

◆ FAudioParameter() [8/19]

FAudioParameter::FAudioParameter ( FName  InName,
const TArray< float > &  InValue 
)
inline

◆ FAudioParameter() [9/19]

FAudioParameter::FAudioParameter ( FName  InName,
TArray< float > &&  InValue 
)
inline

◆ FAudioParameter() [10/19]

FAudioParameter::FAudioParameter ( FName  InName,
const TArray< bool > &  InValue 
)
inline

◆ FAudioParameter() [11/19]

FAudioParameter::FAudioParameter ( FName  InName,
TArray< bool > &&  InValue 
)
inline

◆ FAudioParameter() [12/19]

FAudioParameter::FAudioParameter ( FName  InName,
const TArray< int32 > &  InValue 
)
inline

◆ FAudioParameter() [13/19]

FAudioParameter::FAudioParameter ( FName  InName,
TArray< int32 > &&  InValue 
)
inline

◆ FAudioParameter() [14/19]

FAudioParameter::FAudioParameter ( FName  InName,
const TArray< UObject * > &  InValue 
)
inline

◆ FAudioParameter() [15/19]

FAudioParameter::FAudioParameter ( FName  InName,
const TArray< FString > &  InValue 
)
inline

◆ FAudioParameter() [16/19]

FAudioParameter::FAudioParameter ( FName  InName,
TArray< FString > &&  InValue 
)
inline

◆ FAudioParameter() [17/19]

FAudioParameter::FAudioParameter ( FName  InName,
EAudioParameterType  Type 
)
inline

◆ FAudioParameter() [18/19]

FAudioParameter::FAudioParameter ( FAudioParameter &&  InParameter)
default

◆ FAudioParameter() [19/19]

FAudioParameter::FAudioParameter ( const FAudioParameter &  InParameter)
default

Member Function Documentation

◆ CreateDefaultArray()

static FAudioParameter FAudioParameter::CreateDefaultArray ( FName  InName,
int32  InNum 
)
inlinestatic

◆ FindOrAddParam()

static FAudioParameter * FAudioParameter::FindOrAddParam ( TArray< FAudioParameter > &  OutParams,
FName  InParamName 
)
inlinestatic

◆ FindParam()

static const FAudioParameter * FAudioParameter::FindParam ( const TArray< FAudioParameter > &  InParams,
FName  InParamName 
)
inlinestatic

◆ Merge() [1/2]

void FAudioParameter::Merge ( const FAudioParameter &  InParameter,
bool  bInTakeName = true,
bool  bInTakeType = true,
bool  bInMergeArrayTypes = false 
)

◆ Merge() [2/2]

void FAudioParameter::Merge ( TArray< FAudioParameter > &&  InParams,
TArray< FAudioParameter > &  OutParams 
)
static

◆ operator=() [1/2]

FAudioParameter & FAudioParameter::operator= ( const FAudioParameter &  InParameter)
default

◆ operator=() [2/2]

FAudioParameter & FAudioParameter::operator= ( FAudioParameter &&  InParameter)
default

◆ UPROPERTY() [1/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Bool Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::BooleanArray"),
Category  = AudioParameter 
)

◆ UPROPERTY() [2/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Bool)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Boolean"),
Category  = AudioParameter 
)

◆ UPROPERTY() [3/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Float Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::FloatArray"),
Category  = AudioParameter 
)

◆ UPROPERTY() [4/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Float)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Float"),
Category  = AudioParameter 
)
pure virtual

◆ UPROPERTY() [5/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Int Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::IntegerArray"),
Category  = AudioParameter 
)

◆ UPROPERTY() [6/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Int)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Integer || ParamType == EAudioParameterType::NoneArray"),
Category  = AudioParameter 
)
pure virtual

◆ UPROPERTY() [7/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Object Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::ObjectArray"),
Category  = AudioParameter 
)

◆ UPROPERTY() [8/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (Object)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Object"),
Category  = AudioParameter 
)

◆ UPROPERTY() [9/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (String Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::StringArray"),
Category  = AudioParameter 
)

◆ UPROPERTY() [10/10]

FAudioParameter::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
meta  = (DisplayName="Value (String)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::String"),
Category  = AudioParameter 
)

Member Data Documentation

◆ ObjectProxies

TArray<TSharedPtr<Audio::IProxyData> > FAudioParameter::ObjectProxies

◆ ParamName

FName FAudioParameter::ParamName

◆ ParamType

EAudioParameterType FAudioParameter::ParamType = EAudioParameterType::None

◆ TypeName

FName FAudioParameter::TypeName
The documentation for this struct was generated from the following files: