SoundConcurrency.h File Reference

#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/PerPlatformProperties.h"
#include "SoundConcurrency.generated.h"

Go to the source code of this file.

Classes
struct	FSoundConcurrencySettings
class	USoundConcurrency
struct	FConcurrencyHandle
struct	FConcurrencySoundData
class	FConcurrencyGroup
struct	FSoundInstanceEntry
struct	FOwnerConcurrencyMapEntry
class	FSoundConcurrencyManager

Namespaces
namespace	EMaxConcurrentResolutionRule

Typedefs
using	FConcurrencyGroupID = uint32
using	FConcurrencyObjectID = uint32
using	FSoundOwnerObjectID = uint32
using	FSoundObjectID = uint32
typedef TMap< FConcurrencyGroupID, FConcurrencyGroup * >	FConcurrencyGroups
typedef TMap< FConcurrencyObjectID, FConcurrencyGroupID >	FConcurrencyMap
typedef TMap< FSoundOwnerObjectID, FOwnerConcurrencyMapEntry >	FOwnerConcurrencyMap
typedef TMap< FSoundOwnerObjectID, FSoundInstanceEntry >	FOwnerPerSoundConcurrencyMap
typedef TMap< FSoundObjectID, FConcurrencyGroupID >	FPerSoundToActiveSoundsMap

Enumerations
enum	EMaxConcurrentResolutionRule::Type : int {   EMaxConcurrentResolutionRule::PreventNew , EMaxConcurrentResolutionRule::StopOldest , EMaxConcurrentResolutionRule::StopFarthestThenPreventNew , EMaxConcurrentResolutionRule::StopFarthestThenOldest ,   EMaxConcurrentResolutionRule::StopLowestPriority , EMaxConcurrentResolutionRule::StopQuietest , EMaxConcurrentResolutionRule::StopLowestPriorityThenPreventNew , EMaxConcurrentResolutionRule::UMETA =(Hidden) }
enum class	EConcurrencyVolumeScaleMode { Default = 0 , Distance , Priority }
enum class	EConcurrencyMode : uint8 { Group , Owner , OwnerPerSound , Sound }

Functions
ENGINE_API	DECLARE_LOG_CATEGORY_EXTERN (LogAudioConcurrency, Log, All)

Typedef Documentation

FConcurrencyGroupID

using FConcurrencyGroupID = uint32

Sound concurrency group ID.

FConcurrencyGroups

typedef TMap<FConcurrencyGroupID, FConcurrencyGroup*> FConcurrencyGroups

FConcurrencyMap

typedef TMap<FConcurrencyObjectID, FConcurrencyGroupID> FConcurrencyMap

Type for mapping an object id to a concurrency entry.

FConcurrencyObjectID

using FConcurrencyObjectID = uint32

Sound concurrency unique object IDs.

FOwnerConcurrencyMap

typedef TMap<FSoundOwnerObjectID, FOwnerConcurrencyMapEntry> FOwnerConcurrencyMap

Maps owners to concurrency maps

FOwnerPerSoundConcurrencyMap

typedef TMap<FSoundOwnerObjectID, FSoundInstanceEntry> FOwnerPerSoundConcurrencyMap

Maps owners to sound instances

FPerSoundToActiveSoundsMap

typedef TMap<FSoundObjectID, FConcurrencyGroupID> FPerSoundToActiveSoundsMap

Maps sound object ids to active sound array for global concurrency limiting

FSoundObjectID

using FSoundObjectID = uint32

Sound instance (USoundBase) object ID.

FSoundOwnerObjectID

using FSoundOwnerObjectID = uint32

Sound owner object IDs

Enumeration Type Documentation

EConcurrencyMode

enum class EConcurrencyMode : uint8

strong

How the concurrency request is handled by the concurrency manager

Enumerator
Group
Owner
OwnerPerSound
Sound

EConcurrencyVolumeScaleMode

enum class EConcurrencyVolumeScaleMode

strong

Enumerator
Default
Distance
Priority

Function Documentation

DECLARE_LOG_CATEGORY_EXTERN()

ENGINE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogAudioConcurrency	,
		Log	,
		All
	)