1. Epic GamesDeveloper
  3. FAudioParameter

FAudioParameter

API > API/Runtime > API/Runtime/AudioExtensions

References

   
Module AudioExtensions
Header /Engine/Source/Runtime/AudioExtensions/Public/AudioParameter.h
Include #include "AudioParameter.h"

Syntax

struct FAudioParameter

Variables

  Type Name Description
Public variable TArray< bool > ArrayBoolParam Boolean value of parameter.
Public variable TArray< float > ArrayFloatParam Array Float value of parameter.
Public variable TArray< int32 > ArrayIntParam Integer value of parameter.
Public variable TArray< TObjectPtr< UObject > > ArrayObjectParam Object value of parameter.
Public variable TArray< FString > ArrayStringParam String value of parameter.
Public variable bool BoolParam Boolean value of parameter.
Public variable float FloatParam Float value of parameter.
Public variable int32 IntParam Integer value of parameter. If set to 'Default Construct', value is number of array items to construct.
Public variable TObjectPtr< UObject > ObjectParam Object value of parameter.
Public variable TArray< TSharedPtr< Audio::IProxyData > > ObjectProxies Object proxies to be generated when parameter is passed to the AudioThread to represent ObjectParam/ArrayObjectParam safely.
Public variable FName ParamName Name of the parameter.
Public variable EAudioParameterType ParamType  
Public variable FString StringParam String value of parameter.
Public variable FName TypeName Optional TypeName used to describe what constructed type this parameter should be initializing.

Constructors

  Type Name Description
Public function    
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

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

  
Public function  

FAudioParameter ( FName InName
)

  
Public function  

FAudioParameter ( FName InName,
EAudioParameterType Type
)

  
Public function  

FAudioParameter ( FAudioParameter&& InParameter
)

  
Public function  

FAudioParameter ( const FAudioParameter& InParameter
)

  
Public function  

FAudioParameter ( FName InName,
float InValue
)

  
Public function  

FAudioParameter ( FName InName,
bool InValue
)

  
Public function  

FAudioParameter ( FName InName,
int32 InValue
)

  
Public function  

FAudioParameter ( FName InName,
UObject* InValue
)

  
Public function  

FAudioParameter ( FName InName,
const FString& InValue
)

  

Functions

  Type Name Description
Public function Static FAudioParameter

CreateDefaultArray ( FName InName,
int32 InNum
)

 Static function to avoid int32 constructor collision.
Public function Static FAudioParameter *

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

 Common find & add algorithm for default/legacy parameter system.
Public function Static const FAudioParameter *

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

 Common find algorithm for default/legacy parameter system.
Public function Static void

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

 Moves InParams to OutParams that are not already included.
Public function void

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

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

Operators

  Type Name Description
Public function FAudioParameter &

operator= ( const FAudioParameter& InParameter
)

  
Public function FAudioParameter &

operator= ( FAudioParameter&& InParameter
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page