ISoundParameterControllerInterface

[UObject](API\Runtime\CoreUObject\UObject\UObject) interface for all object types that are controlling parameter values sent to sound instances (i.e. sources)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Audio/SoundParameterControllerInterface.h

Include

#include "Audio/SoundParameterControllerInterface.h"

Syntax

class ISoundParameterControllerInterface : public IAudioParameterControllerInterface

Remarks

UObject interface for all object types that are controlling parameter values sent to sound instances (i.e. sources)

Functions

Name Description

Public function Const

FAudioDevice...

 

GetAudioDevice()

Returns the active audio device to use for this component based on whether or not the component is playing in a world.

Public function Const

bool

 

GetDisableParameterUpdatesWhilePlaying()

Public function Const

uint64

 

GetInstanceOwnerID()

Returns the id of the sound owner's instance associated with the parameter interface.

Public function

TArray< FAud...

 

GetInstanceParameters()

Returns the Game Thread copy of parameters to modify in place.

Public function

USoundBase &...

 

GetSound()

Returns the USoundBase used to initialize instance parameters to update.

Public function Const

bool

 

IsPlaying()

Overridden from IAudioParameterControllerInterface

Name Description

Public function Virtual

void

 

ResetParameters()

Resets all parameters to their original values.

Public function Virtual

void

 

SetBoolArrayParameter

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

Sets a named Boolean Array.

Public function Virtual

void

 

SetBoolParameter

(
    FName InName,
    bool InBool
)

Sets a named Boolean.

Public function Virtual

void

 

SetFloatArrayParameter

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

Sets a named Float Array.

Public function Virtual

void

 

SetFloatParameter

(
    FName InName,
    float InFloat
)

Sets a named Float.

Public function Virtual

void

 

SetIntArrayParameter

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

Sets a named Int32 Array.

Public function Virtual

void

 

SetIntParameter

(
    FName InName,
    int32 InInt
)

Sets a named Int32.

Public function Virtual

void

 

SetObjectArrayParameter

(
    FName InName,
    const TArray< UObject* >& InV...
)

Sets a named UObject Array.

Public function Virtual

void

 

SetObjectParameter

(
    FName InName,
    UObject* InValue
)

Sets a named UObject.

Public function Virtual

void

 

SetParameter

(
    FAudioParameter&& InValue
)

Sets a named parameter to the given parameter structure value.

Public function Virtual

void

 

SetParameters

(
    TArray< FAudioParameter >&& InValu...
)

Sets an array of parameters as a batch.

Public function Virtual

void

 

SetStringArrayParameter

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

Sets a named String Array.

Public function Virtual

void

 

SetStringParameter

(
    FName InName,
    const FString& InValue
)

Sets a named String.

Public function Virtual

void

 

SetTriggerParameter

(
    FName InName
)

Executes a named trigger.