UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ISoundParameterControllerInterface Class Referenceabstract

#include <SoundParameterControllerInterface.h>

+ Inheritance diagram for ISoundParameterControllerInterface:

Public Member Functions

ENGINE_API void ResetParameters () override
 
ENGINE_API void SetTriggerParameter (FName InName) override
 
ENGINE_API void SetBoolParameter (FName InName, bool InBool) override
 
ENGINE_API void SetBoolArrayParameter (FName InName, const TArray< bool > &InValue) override
 
ENGINE_API void SetIntParameter (FName InName, int32 InInt) override
 
ENGINE_API void SetIntArrayParameter (FName InName, const TArray< int32 > &InValue) override
 
ENGINE_API void SetFloatParameter (FName InName, float InFloat) override
 
ENGINE_API void SetFloatArrayParameter (FName InName, const TArray< float > &InValue) override
 
ENGINE_API void SetStringParameter (FName InName, const FString &InValue) override
 
ENGINE_API void SetStringArrayParameter (FName InName, const TArray< FString > &InValue) override
 
ENGINE_API void SetObjectParameter (FName InName, UObject *InValue) override
 
ENGINE_API void SetObjectArrayParameter (FName InName, const TArray< UObject * > &InValue) override
 
ENGINE_API void SetParameter (FAudioParameter &&InValue) override
 
ENGINE_API void SetParameters (TArray< FAudioParameter > &&InValues) override
 
ENGINE_API void SetParameters_Blueprint (const TArray< FAudioParameter > &InValues) override
 
virtual FAudioDeviceGetAudioDevice () const =0
 
virtual uint64 GetInstanceOwnerID () const =0
 
virtual TArray< FAudioParameter > & GetInstanceParameters ()=0
 
virtual USoundBaseGetSound ()=0
 
virtual bool IsPlaying () const =0
 
virtual bool GetDisableParameterUpdatesWhilePlaying () const =0
 
- Public Member Functions inherited from IAudioParameterControllerInterface
template<typename DataType >
void SetParameter (FName InName, DataType &&)=delete
 
template<>
void SetParameter (FName InName, bool &&InBool)
 
template<>
void SetParameter (FName InName, float &&InFloat)
 
template<>
void SetParameter (FName InName, int32 &&InInteger)
 
template<>
void SetParameter (FName InName, FString &&InString)
 
template<>
void SetParameter (FName InName, UObject *&&InObject)
 
template<>
void SetParameter (FName InName, TArray< bool > &&InBools)
 
template<>
void SetParameter (FName InName, TArray< float > &&InFloats)
 
template<>
void SetParameter (FName InName, TArray< int32 > &&InIntegers)
 
template<>
void SetParameter (FName InName, TArray< FString > &&InStrings)
 
template<>
void SetParameter (FName InName, TArray< UObject * > &&InObjects)
 

Member Function Documentation

◆ GetAudioDevice()

virtual FAudioDevice * ISoundParameterControllerInterface::GetAudioDevice ( ) const
pure virtual

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

◆ GetDisableParameterUpdatesWhilePlaying()

virtual bool ISoundParameterControllerInterface::GetDisableParameterUpdatesWhilePlaying ( ) const
pure virtual

◆ GetInstanceOwnerID()

virtual uint64 ISoundParameterControllerInterface::GetInstanceOwnerID ( ) const
pure virtual

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

◆ GetInstanceParameters()

virtual TArray< FAudioParameter > & ISoundParameterControllerInterface::GetInstanceParameters ( )
pure virtual

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

◆ GetSound()

virtual USoundBase * ISoundParameterControllerInterface::GetSound ( )
pure virtual

Returns the USoundBase used to initialize instance parameters to update.

◆ IsPlaying()

virtual bool ISoundParameterControllerInterface::IsPlaying ( ) const
pure virtual

◆ ResetParameters()

void ISoundParameterControllerInterface::ResetParameters ( )
overridevirtual

◆ SetBoolArrayParameter()

void ISoundParameterControllerInterface::SetBoolArrayParameter ( FName  InName,
const TArray< bool > &  InValue 
)
overridevirtual

◆ SetBoolParameter()

void ISoundParameterControllerInterface::SetBoolParameter ( FName  InName,
bool  InBool 
)
overridevirtual

◆ SetFloatArrayParameter()

void ISoundParameterControllerInterface::SetFloatArrayParameter ( FName  InName,
const TArray< float > &  InValue 
)
overridevirtual

◆ SetFloatParameter()

void ISoundParameterControllerInterface::SetFloatParameter ( FName  InName,
float  InFloat 
)
overridevirtual

◆ SetIntArrayParameter()

void ISoundParameterControllerInterface::SetIntArrayParameter ( FName  InName,
const TArray< int32 > &  InValue 
)
overridevirtual

◆ SetIntParameter()

void ISoundParameterControllerInterface::SetIntParameter ( FName  InName,
int32  InInt 
)
overridevirtual

◆ SetObjectArrayParameter()

void ISoundParameterControllerInterface::SetObjectArrayParameter ( FName  InName,
const TArray< UObject * > &  InValue 
)
overridevirtual

◆ SetObjectParameter()

void ISoundParameterControllerInterface::SetObjectParameter ( FName  InName,
UObject InValue 
)
overridevirtual

◆ SetParameter()

void ISoundParameterControllerInterface::SetParameter ( FAudioParameter &&  InValue)
overridevirtual

◆ SetParameters()

void ISoundParameterControllerInterface::SetParameters ( TArray< FAudioParameter > &&  InValues)
overridevirtual

◆ SetParameters_Blueprint()

void ISoundParameterControllerInterface::SetParameters_Blueprint ( const TArray< FAudioParameter > &  InValues)
overridevirtual

◆ SetStringArrayParameter()

void ISoundParameterControllerInterface::SetStringArrayParameter ( FName  InName,
const TArray< FString > &  InValue 
)
overridevirtual

◆ SetStringParameter()

void ISoundParameterControllerInterface::SetStringParameter ( FName  InName,
const FString &  InValue 
)
overridevirtual

◆ SetTriggerParameter()

void ISoundParameterControllerInterface::SetTriggerParameter ( FName  InName)
overridevirtual

The documentation for this class was generated from the following files: