FConcurrencyGroup

Class which tracks array of active sound pointers for concurrency management

Windows
MacOS
Linux

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

Name Description

Public function

FConcurrencyGroup

(
    FConcurrencyGroupID GroupID,
    const FConcurrencyHandle& Concurre...
)

Constructor for the max concurrency active sound entry.

Functions

Name Description

Public function

void

 

AddActiveSound

(
    FActiveSound& ActiveSound
)

Adds an active sound to the active sound array.

Public function

void

 

CullSoundsDueToMaxConcurrency()

Sorts the active sound if concurrency settings require culling post playback

Public function Static

FConcurrency...

 

GenerateNewID()

Public function Const

const TArray...

 

GetActiveSounds()

Returns the active sounds array.

Public function Const

FConcurrency...

 

GetGroupID()

Returns the id of the concurrency group

Public function Const

const int32

 

GetNextGeneration()

Returns the current generation (effectively, the number of concurrency sound instances active)

Public function Const

FConcurrency...

 

GetObjectID()

Returns the parent object ID

Public function Const

const FSound...

 

GetSettings()

Returns the settings associated with the group

Public function Const

bool

 

IsEmpty()

Determines if the group is full.

Public function Const

bool

 

IsFull()

Determines if the group is full.

Public function

void

 

RemoveActiveSound

(
    FActiveSound& ActiveSound
)

Removes an active sound from the active sound array.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss