1. Epic GamesDeveloper
  3. UAudioParameterComponent

UAudioParameterComponent

[UAudioParameterComponent](API\Plugins\AudioGameplay\UAudioParameterComponent) - Can be used to set/store audio parameters and automatically dispatch them (through ActorSoundParameterInterface) to any sounds played by the component's Owner Actor

API > API/Plugins > API/Plugins/AudioGameplay

UAudioParameterComponent - Can be used to set/store audio parameters and automatically dispatch them (through ActorSoundParameterInterface) to any sounds played by the component's Owner Actor

   
Name UAudioParameterComponent
Type class
Header File /Engine/Plugins/AudioGameplay/Source/AudioGameplay/Public/AudioParameterComponent.h
Include Path #include "AudioParameterComponent.h"

Syntax

UCLASS (MinimalAPI, BlueprintType,  
       HideCategories=(Object, ActorComponent, Physics, Rendering, Mobility, LOD),  
       Meta=(BlueprintSpawnableComponent))  
class UAudioParameterComponent :  
    public UAudioGameplayComponent ,  
    public IAudioParameterControllerInterface ,  
    public IActorSoundParameterInterface

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnParameterChanged FOnParameterChanged End IAudioParameterControllerInterface AudioParameterComponent.h
  • BlueprintAssignable

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveComponents TArray< TWeakObjectPtr< UAudioComponent > >   AudioParameterComponent.h
  • Transient
Parameters TArray< FAudioParameter >   AudioParameterComponent.h
  • EditDefaultsOnly
  • Category="Parameters"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void GetActorSoundParams_Implementation ( TArray< FAudioParameter >& Params
) const

 Begin IActorSoundParameterInterface AudioParameterComponent.h  

const TArray< FAudioParameter > & GetParameters()

   AudioParameterComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Parameters

Overridden from IAudioParameterControllerInterface

Name Remarks Include Path Unreal Specifiers

virtual void ResetParameters()

 End IActorSoundParameterInterface Begin IAudioParameterControllerInterface AudioParameterComponent.h  

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

   AudioParameterComponent.h  

virtual void SetBoolParameter ( FName InName,
bool InValue
)

   AudioParameterComponent.h  

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

   AudioParameterComponent.h  

virtual void SetFloatParameter ( FName InName,
float InValue
)

   AudioParameterComponent.h  

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

   AudioParameterComponent.h  

virtual void SetIntParameter ( FName InName,
int32 InInt
)

   AudioParameterComponent.h  

virtual void SetObjectArrayParameter ( FName InName,
const TArray< UObject* >& InValue
)

   AudioParameterComponent.h  

virtual void SetObjectParameter ( FName InName,
UObject* InValue
)

   AudioParameterComponent.h  

virtual void SetParameter ( FAudioParameter&& InValue
)

   AudioParameterComponent.h  

virtual void SetParameters ( TArray< FAudioParameter >&& InValues
)

   AudioParameterComponent.h  

virtual void SetParameters_Blueprint ( const TArray< FAudioParameter >& InParameters
)

   AudioParameterComponent.h  

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

   AudioParameterComponent.h  

virtual void SetStringParameter ( FName InName,
const FString& InValue
)

   AudioParameterComponent.h  

virtual void SetTriggerParameter ( FName InName
)

   AudioParameterComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page