FAudioParameter

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioExtensions

Header

/Engine/Source/Runtime/AudioExtensions/Public/AudioParameter.h

Include

#include "AudioParameter.h"

Syntax

struct FAudioParameter

Variables

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< TObject...

 

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< UOb...

 

ObjectParam

Object value of parameter.

Public variable

TArray< Audio::...

 

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

EAudioParameter...

 

ParamType

Public variable

FString

 

StringParam

String value of parameter.

Constructors

Name Description

Public function

FAudioParameter()

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* >& InV...
)

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

(
    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

Name Description

Public function Static

FAudioParame...

 

CreateDefaultArray

(
    FName InName,
    int32 InNum
)

Static function to avoid int32 constructor collision.

Public function Static

FAudioParame...

 

FindOrAddParam

(
    TArray< FAudioParameter >& OutPara...,
    FName InParamName
)

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

Public function Static

const FAudio...

 

FindParam

(
    const TArray< FAudioParameter >& I...,
    FName InParamName
)

Common find algorithm for default/legacy parameter system.

Public function Static

void

 

Merge

(
    TArray< FAudioParameter >&& InPara...,
    TArray< FAudioParameter >& OutPara...
)

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

Name Description

Public function

FAudioParame...

 

operator=

(
    const FAudioParameter& InParameter
)

Public function

FAudioParame...

 

operator=

(
    FAudioParameter&& InParameter
)