1. Epic GamesDeveloper
  3. FAudioParameter

FAudioParameter

API > API/Runtime > API/Runtime/AudioExtensions

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

Syntax

USTRUCT (BlueprintType )  
struct FAudioParameter

Constructors

Name Remarks Include Path Unreal Specifiers
  AudioParameter.h  

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

   AudioParameter.h  

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

 We can't move TArray into a TArray> since UE_OBJECT_PTR_GC_BARRIER was added. AudioParameter.h  

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

   AudioParameter.h  

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

   AudioParameter.h  

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

   AudioParameter.h  

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

   AudioParameter.h  

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

   AudioParameter.h  

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

   AudioParameter.h  

FAudioParameter ( FName InName,
const FString& InValue
)

   AudioParameter.h  

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

   AudioParameter.h  

FAudioParameter ( FName InName,
int32 InValue
)

   AudioParameter.h  

FAudioParameter ( FName InName,
bool InValue
)

   AudioParameter.h  

FAudioParameter ( FName InName,
float InValue
)

   AudioParameter.h  

FAudioParameter ( const FAudioParameter& InParameter
)

   AudioParameter.h  

FAudioParameter ( FAudioParameter&& InParameter
)

   AudioParameter.h  

FAudioParameter ( FName InName
)

   AudioParameter.h  
  AudioParameter.h  

FAudioParameter ( FName InName,
UObject* InValue
)

   AudioParameter.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrayBoolParam TArray< bool > Boolean value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Bool Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::BooleanArray")
  • Category=AudioParameter
ArrayFloatParam TArray< float > Array Float value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Float Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::FloatArray")
  • Category=AudioParameter
ArrayIntParam TArray< int32 > Integer value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Int Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::IntegerArray")
  • Category=AudioParameter
ArrayObjectParam TArray< TObjectPtr< UObject > > Object value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Object Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::ObjectArray")
  • Category=AudioParameter
ArrayStringParam TArray< FString > String value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (String Array)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::StringArray")
  • Category=AudioParameter
BoolParam bool Boolean value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Bool)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Boolean")
  • Category=AudioParameter
FloatParam float Float value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Float)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Float")
  • Category=AudioParameter
IntParam int32 Integer value of parameter. If set to 'Default Construct', value is number of array items to construct. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Int)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Integer || ParamType == EAudioParameterType::NoneArray")
  • Category=AudioParameter
ObjectParam TObjectPtr< UObject > Object value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (Object)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::None || ParamType == EAudioParameterType::Object")
  • Category=AudioParameter
ObjectProxies TArray< TSharedPtr< Audio::IProxyData > > Object proxies to be generated when parameter is passed to the AudioThread to represent ObjectParam/ArrayObjectParam safely. AudioParameter.h  
ParamName FName Name of the parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Name")
  • Category=AudioParameter
ParamType EAudioParameterType   AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Type")
  • Category=AudioParameter
StringParam FString String value of parameter. AudioParameter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Value (String)", DisplayAfter="ParamType", EditConditionHides, EditCondition="ParamType == EAudioParameterType::String")
  • Category=AudioParameter
TypeName FName Optional TypeName used to describe what constructed type this parameter should be initializing. AudioParameter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Merge ( const FAudioParameter& InParameter,
bool bInTakeName,
bool bInTakeType,
bool bInMergeArrayTypes
)

 Sets values specified by type field of the given parameter on this parameter. AudioParameter.h  

Static

Name Remarks Include Path Unreal Specifiers

static FAudioParameter CreateDefaultArray ( FName InName,
int32 InNum
)

 Static function to avoid int32 constructor collision. AudioParameter.h  

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

 Common find & add algorithm for default/legacy parameter system. AudioParameter.h  

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

 Common find algorithm for default/legacy parameter system. AudioParameter.h  

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

 Moves InParams to OutParams that are not already included. AudioParameter.h  

Operators

Name Remarks Include Path Unreal Specifiers

FAudioParameter & operator= ( const FAudioParameter& InParameter
)

   AudioParameter.h  
  AudioParameter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page