1. Epic GamesDeveloper
  3. UAudioComponentGroup

UAudioComponentGroup

Automatic Handler for voices and parameters across any number of AudioComponents

API > API/Plugins > API/Plugins/AudioGameplay

Inheritance Hierarchy

References

   
Module AudioGameplay
Header /Engine/Plugins/AudioGameplay/Source/AudioGameplay/Public/AudioComponentGroup.h
Include #include "AudioComponentGroup.h"

Syntax

UCLASS&40;BlueprintType, DefaultToInstanced&41;  
class UAudioComponentGroup :  
    public USceneComponent,  
    public IAudioParameterControllerInterface

Remarks

Automatic Handler for voices and parameters across any number of AudioComponents

Variables

  Type Name Description
Protected variable bool bIsVirtualized  
Protected variable TMap< FName, TArray< FBoolParamCallback > > BoolSubscriptions  
Protected variable FAudioComponentModifier CachedModifier Final values set last update
Protected variable UProperty Category visibleanywhere TArray< TObjectPtr< UAudioComponent > > Components  
Protected variable TMap< FName, TArray< FSoundCallback > > EventSubscriptions  
Protected variable UProperty Transient TArray< TScriptInterface< IAudioComponentGroupExtension > > Extensions  
Protected variable TArray< TWeakObjectPtr< UAudioComponent > > ExternalComponents Components managed externally that won't be used in the pool, but can still share parameters.
Protected variable FAudioComponentModifier GroupModifier Modifier set externally via BP functions.
Public variable UProperty BlueprintAssignable FSoundGroupChanged OnKilled  
Public variable UProperty BlueprintAssignable FSoundGroupChanged OnStopped  
Public variable UProperty BlueprintAssignable FSoundGroupChanged OnUnvirtualized  
Public variable UProperty BlueprintAssignable FSoundGroupChanged OnVirtualized  
Protected variable UProperty Transient TArray< FAudioParameter > ParamsToSet  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TArray< FAudioParameter > PersistentParams  
Protected variable TMap< FName, TArray< FStringParamCallback > > StringSubscriptions  

Constructors

  Type Name Description
Public function  

UAudioComponentGroup ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UAudioComponent *  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void Allow an externally created AudioComponent to share parameters with this SoundGroup.
Protected function Const void

ApplyModifiers ( UAudioComponent* Component,
const FAudioComponentModifier& Modifier
)

  
Protected function Const void

ApplyParams ( UAudioComponent* Component
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

BroadcastEvent ( const FName EventName
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Protected function void  
Protected function void

ExecuteEventSubscriptions ( const FName EventName
)

  
Protected function void  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic bool

GetBoolParamValue ( const FName ParamName
)

  
Protected function Const float  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic float

GetFloatParamValue ( const FName ParamName
)

  
Public function UAudioComponent * Component interaction.
Protected function Const const FAudioParameter *

GetParamInternal ( const FName ParamName
)

  
Public function const TArray< FAudioParameter > &  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic FString

GetStringParamValue ( const FName ParamName
)

  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic bool  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic bool  
Public function void

IterateComponents ( const TFunction< void(UAudioComponent*)> OnIterate
)

  
Public function void

RemoveComponent ( const UAudioComponent* InComponent
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void  
Public function Const UAudioComponent *  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetLowPassFilter ( const float InFrequency
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetPitchMultiplier ( const float InPitch
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetVolumeMultiplier ( const float InVolume
)

  
Public function Static UFunction BlueprintCallable, Category blueprintcosmetic UAudioComponentGroup *  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

StopSound ( USoundBase* Sound,
const float FadeTime
)

 Stop all instances of this Sound on any internal or external components.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SubscribeToBool ( const FName ParamName,
FBoolParamCallback Delegate
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SubscribeToEvent ( const FName EventName,
FSoundCallback Delegate
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SubscribeToStringParam ( const FName ParamName,
FStringParamCallback Delegate
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

UnsubscribeObject ( const UObject* Object
)

 Remove any string, event, and bool subscriptions that are bound to this object
Protected function void  
Public function void

UpdateExtensions ( const float DeltaTime
)

  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from IAudioParameterControllerInterface

  Type Name Description
Public function Virtual void 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* >& InValue
)

 Sets a named UObject Array.
Public function Virtual void

SetObjectParameter ( FName InName,
UObject* InValue
)

 Sets a named UObject.
Public function Virtual void Sets a named parameter to the given parameter structure value.
Public function Virtual void Sets an array of parameters as a batch.
Public function Virtual void

SetParameters_Blueprint ( const TArray< FAudioParameter >& InParameters
)

 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 Executes a named trigger.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page