1. Epic GamesDeveloper
  3. UAudioComponentGroup

UAudioComponentGroup

Automatic Handler for voices and parameters across any number of AudioComponents

API > API/Plugins > API/Plugins/AudioGameplay

Automatic Handler for voices and parameters across any number of AudioComponents

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

Syntax

UCLASS (MinimalAPI, BlueprintType, DefaultToInstanced)  
class UAudioComponentGroup :  
    public USceneComponent,  
    public IAudioParameterControllerInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAudioComponentGroup ( const FObjectInitializer& ObjectInitializer
)

   AudioComponentGroup.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UAudioComponentGroup()

   AudioComponentGroup.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnKilled FSoundGroupChanged   AudioComponentGroup.h
  • BlueprintAssignable
OnStopped FSoundGroupChanged   AudioComponentGroup.h
  • BlueprintAssignable
OnUnvirtualized FSoundGroupChanged   AudioComponentGroup.h
  • BlueprintAssignable
OnVirtualized FSoundGroupChanged   AudioComponentGroup.h
  • BlueprintAssignable

Functions

Public

Name Remarks Include Path Unreal Specifiers

UAudioComponent * AddComponent()

   AudioComponentGroup.h  

void AddExtension ( TScriptInterface< IAudioComponentGroupExtension > NewExtension
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void AddExternalComponent ( UAudioComponent* ComponentToAdd
)

 Allow an externally created AudioComponent to share parameters with this SoundGroup. AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

virtual void BeginPlay()

   AudioComponentGroup.h  

void BroadcastEvent ( const FName EventName
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void BroadcastKill()

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void BroadcastStopAll()

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void DisableVirtualization()

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void EnableVirtualization()

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

bool GetBoolParamValue ( const FName ParamName
) const

   AudioComponentGroup.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category=AudioComponentGroup

float GetFloatParamValue ( const FName ParamName
) const

   AudioComponentGroup.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category=AudioComponentGroup

UAudioComponent * GetNextAvailableComponent()

 Component interaction. AudioComponentGroup.h  

const TArray< FAudioParameter > & GetParams()

   AudioComponentGroup.h  

FString GetStringParamValue ( const FName ParamName
) const

   AudioComponentGroup.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category=AudioComponentGroup

bool IsPlayingAny()

   AudioComponentGroup.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category=AudioComponentGroup

bool IsVirtualized()

   AudioComponentGroup.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category=AudioComponentGroup

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

   AudioComponentGroup.h  

void RemoveComponent ( const UAudioComponent* InComponent
)

   AudioComponentGroup.h  

void RemoveExtension ( TScriptInterface< IAudioComponentGroupExtension > NewExtension
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void RemoveExternalComponent ( UAudioComponent* ComponentToRemove
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

UAudioComponent * ResetComponent ( UAudioComponent* Component
) const

   AudioComponentGroup.h  

void SetLowPassFilter ( const float InFrequency
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void SetPitchMultiplier ( const float InPitch
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void SetVolumeMultiplier ( const float InVolume
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void StopSound ( USoundBase* Sound,
const float FadeTime
)

 Stop all instances of this Sound on any internal or external components. AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void SubscribeToBool ( const FName ParamName,
FBoolParamCallback Delegate
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void SubscribeToEvent ( const FName EventName,
FSoundCallback Delegate
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void SubscribeToStringParam ( const FName ParamName,
FStringParamCallback Delegate
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

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

   AudioComponentGroup.h  

void UnsubscribeObject ( const UObject* Object
)

 Remove any string, event, and bool subscriptions that are bound to this object AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

void UpdateExtensions ( const float DeltaTime
)

   AudioComponentGroup.h  

Overridden from IAudioParameterControllerInterface

Name Remarks Include Path Unreal Specifiers

virtual void ResetParameters()

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

virtual void SetBoolParameter ( FName InName,
bool InBool
)

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

virtual void SetFloatParameter ( FName InName,
float InFloat
)

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

virtual void SetIntParameter ( FName InName,
int32 InInt
)

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

virtual void SetObjectParameter ( FName InName,
UObject* InValue
)

   AudioComponentGroup.h  

virtual void SetParameter ( FAudioParameter&& InValue
)

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

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

   AudioComponentGroup.h  

virtual void SetTriggerParameter ( FName InName
)

   AudioComponentGroup.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ApplyModifiers ( UAudioComponent* Component,
const FAudioComponentModifier& Modifier
) const

   AudioComponentGroup.h  

void ApplyParams ( UAudioComponent* Component
) const

   AudioComponentGroup.h  

void ExecuteBoolParamSubscriptions ( const FAudioParameter& BoolParam
)

   AudioComponentGroup.h  

void ExecuteEventSubscriptions ( const FName EventName
)

   AudioComponentGroup.h  

void ExecuteStringParamSubscriptions ( const FAudioParameter& StringParam
)

   AudioComponentGroup.h  

float GetComponentVolume()

   AudioComponentGroup.h  

const FAudioParameter * GetParamInternal ( const FName ParamName
) const

   AudioComponentGroup.h  

void UpdateComponentParameters()

   AudioComponentGroup.h  

Static

Name Remarks Include Path Unreal Specifiers

static UAudioComponentGroup * StaticGetOrCreateComponentGroup ( AActor* Actor
)

   AudioComponentGroup.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category=AudioComponentGroup

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page