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