Navigation
API > API/Runtime > API/Runtime/Engine
Class which tracks array of active sound pointers for concurrency management
| Name | FConcurrencyGroup |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundConcurrency.h |
| Include Path | #include "Sound/SoundConcurrency.h" |
Syntax
class FConcurrencyGroup
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FConcurrencyGroup
(
FConcurrencyGroupID GroupID, |
Constructor for the max concurrency active sound entry. | Sound/SoundConcurrency.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveSounds | TArray< FActiveSound * > | Array of active sounds for this concurrency group. | Sound/SoundConcurrency.h | |
| GroupID | FConcurrencyGroupID | Sound/SoundConcurrency.h | ||
| LastTimePlayed | float | When a sound last played on this concurrency group. | Sound/SoundConcurrency.h | |
| ObjectID | FConcurrencyObjectID | Sound/SoundConcurrency.h | ||
| Settings | FSoundConcurrencySettings | Sound/SoundConcurrency.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddActiveSound
(
FActiveSound& ActiveSound |
Adds an active sound to the active sound array. | Sound/SoundConcurrency.h | |
bool CanPlaySoundNow
(
float InCurrentTime |
Whether or not a sound would be rate limited if it tried to play right now. | Sound/SoundConcurrency.h | |
void CullSoundsDueToMaxConcurrency() |
Sorts the active sound if concurrency settings require culling post playback | Sound/SoundConcurrency.h | |
const TArray< FActiveSound * > & GetActiveSounds() |
Returns the active sounds array. | Sound/SoundConcurrency.h | |
FConcurrencyGroupID GetGroupID() |
Returns the id of the concurrency group | Sound/SoundConcurrency.h | |
const int32 GetNextGeneration() |
Returns the current generation (effectively, the number of concurrency sound instances active) | Sound/SoundConcurrency.h | |
FConcurrencyObjectID GetObjectID() |
Returns the parent object ID | Sound/SoundConcurrency.h | |
const FSoundConcurrencySettings & GetSettings() |
Returns the settings associated with the group | Sound/SoundConcurrency.h | |
bool IsEmpty() |
Determines if the group is full. | Sound/SoundConcurrency.h | |
bool IsFull() |
Determines if the group is full. | Sound/SoundConcurrency.h | |
void RemoveActiveSound
(
FActiveSound& ActiveSound |
Removes an active sound from the active sound array. | Sound/SoundConcurrency.h | |
void SetLastTimePlayed
(
float InLastTimePlayed |
Sets when the last time a sound was played on this concurrency group. | Sound/SoundConcurrency.h | |
void UpdateGeneration
(
FActiveSound* NewActiveSound |
Updates volume based on distance generation if set as VolumeScaleMode | Sound/SoundConcurrency.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FConcurrencyGroupID GenerateNewID() |
Sound/SoundConcurrency.h |