#include <SoundConcurrency.h>

Public Member Functions
	FConcurrencyGroup (FConcurrencyGroupID GroupID, const FConcurrencyHandle &ConcurrencyHandle)

const TArray< FActiveSound * > &	GetActiveSounds () const

FConcurrencyGroupID	GetGroupID () const

const int32	GetNextGeneration () const

const FSoundConcurrencySettings &	GetSettings () const

FConcurrencyObjectID	GetObjectID () const

bool	IsEmpty () const

bool	IsFull () const

void	AddActiveSound (FActiveSound &ActiveSound)

void	RemoveActiveSound (FActiveSound &ActiveSound)

void	UpdateGeneration (FActiveSound *NewActiveSound=nullptr)

void	CullSoundsDueToMaxConcurrency ()

void	SetLastTimePlayed (float InLastTimePlayed)

bool	CanPlaySoundNow (float InCurrentTime) const

Static Public Member Functions
static FConcurrencyGroupID	GenerateNewID ()

Detailed Description

Class which tracks array of active sound pointers for concurrency management

Constructor & Destructor Documentation

◆ FConcurrencyGroup()

FConcurrencyGroup::FConcurrencyGroup	(	FConcurrencyGroupID	GroupID,
		const FConcurrencyHandle &	ConcurrencyHandle
	)

Constructor for the max concurrency active sound entry.

Member Function Documentation

◆ AddActiveSound()

void FConcurrencyGroup::AddActiveSound ( FActiveSound & ActiveSound )

Adds an active sound to the active sound array.

◆ CanPlaySoundNow()

bool FConcurrencyGroup::CanPlaySoundNow ( float InCurrentTime ) const

Whether or not a sound would be rate limited if it tried to play right now.

◆ CullSoundsDueToMaxConcurrency()

void FConcurrencyGroup::CullSoundsDueToMaxConcurrency ( )

Sorts the active sound if concurrency settings require culling post playback

◆ GenerateNewID()

FConcurrencyGroupID FConcurrencyGroup::GenerateNewID ( )

static

◆ GetActiveSounds()

const TArray< FActiveSound * > & FConcurrencyGroup::GetActiveSounds ( ) const

Returns the active sounds array.

◆ GetGroupID()

FConcurrencyGroupID FConcurrencyGroup::GetGroupID ( ) const

Returns the id of the concurrency group

◆ GetNextGeneration()

const int32 FConcurrencyGroup::GetNextGeneration ( ) const

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

◆ GetObjectID()

FConcurrencyObjectID FConcurrencyGroup::GetObjectID ( ) const

Returns the parent object ID

◆ GetSettings()

const FSoundConcurrencySettings & FConcurrencyGroup::GetSettings ( ) const

Returns the settings associated with the group

◆ IsEmpty()

bool FConcurrencyGroup::IsEmpty ( ) const

Determines if the group is full.

◆ IsFull()

bool FConcurrencyGroup::IsFull ( ) const

Determines if the group is full.

◆ RemoveActiveSound()

void FConcurrencyGroup::RemoveActiveSound ( FActiveSound & ActiveSound )

Removes an active sound from the active sound array.

◆ SetLastTimePlayed()

void FConcurrencyGroup::SetLastTimePlayed ( float InLastTimePlayed )

inline

Sets when the last time a sound was played on this concurrency group.

◆ UpdateGeneration()

void FConcurrencyGroup::UpdateGeneration ( FActiveSound * NewActiveSound = nullptr )

Updates volume based on distance generation if set as VolumeScaleMode

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Engine/Classes/Sound/SoundConcurrency.h
Engine/Source/Runtime/Engine/Private/SoundConcurrency.cpp

Public Member Functions

Static Public Member Functions