#include <SoundConcurrency.h>

Public Member Functions
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Concurrency, meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")) int32 MaxCount

	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category="Volume Scaling", meta=(DisplayName="Recover Time", DisplayAfter="bVolumeScaleCanRelease", EditCondition="bVolumeScaleCanRelease && VolumeScaleMode == EConcurrencyVolumeScaleMode::Default", EditConditionHides, UIMin="0.0", ClampMin="0.0", UIMax="10.0", ClampMax="1000000.0")) float VolumeScaleReleaseTime=0.5f

	FSoundConcurrencySettings ()

ENGINE_API int32	GetMaxCount () const

ENGINE_API bool	SetMaxCount (int32 InMaxCount)

ENGINE_API float	GetVolumeScale () const

ENGINE_API bool	IsEvictionSupported () const

Public Attributes
uint8	bLimitToOwner: 1 = 0

uint8	bVolumeScaleCanRelease: 1 = 0

TEnumAsByte< EMaxConcurrentResolutionRule::Type >	ResolutionRule = EMaxConcurrentResolutionRule::StopFarthestThenOldest

float	RetriggerTime = 0.0f

EConcurrencyVolumeScaleMode	VolumeScaleMode = EConcurrencyVolumeScaleMode::Default

float	VolumeScaleAttackTime = 0.01f

float	VoiceStealReleaseTime = 0.0f

Constructor & Destructor Documentation

◆ FSoundConcurrencySettings()

FSoundConcurrencySettings::FSoundConcurrencySettings ( )

Member Function Documentation

◆ GetMaxCount()

int32 FSoundConcurrencySettings::GetMaxCount ( ) const

Returns the MaxCount as a per-platform integer value.

◆ GetVolumeScale()

float FSoundConcurrencySettings::GetVolumeScale ( ) const

Retrieves the volume scale

◆ IsEvictionSupported()

bool FSoundConcurrencySettings::IsEvictionSupported ( ) const

Whether or not ResolutionRule supports eviction, wherein eviction is the ability to keep a sound from playing prior to start and culling is the requirement of a sound to initialize and actively parse prior to being removed from a concurrency group.

◆ SetMaxCount()

bool FSoundConcurrencySettings::SetMaxCount ( int32 InMaxCount )

Applies the given integer value as the group's MaxCount if passed valid MaxCount (greater than 0) and MaxCount platform scaling is enabled. Returns true if successfully set, false if not.

◆ UPROPERTY() [1/2]

FSoundConcurrencySettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= `"Volume Scaling"`,
		meta	= `(DisplayName="Recover Time", DisplayAfter="bVolumeScaleCanRelease", EditCondition="bVolumeScaleCanRelease && VolumeScaleMode == EConcurrencyVolumeScaleMode::Default", EditConditionHides, UIMin="0.0", ClampMin="0.0", UIMax="10.0", ClampMax="1000000.0")`
	)

pure virtual

Time taken to recover volume scalar duck (default scale mode only).

◆ UPROPERTY() [2/2]

FSoundConcurrencySettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= `Concurrency`,
		meta	= `(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")`
	)

The max number of allowable concurrent active voices for voices playing in this concurrency group. Can be mutated at runtime via Blueprint or code (see "Enable MaxCount Platform Scaling" for disablement of runtime manipulation, which in turn allows for platform scaling of the given value).

Member Data Documentation

◆ bLimitToOwner

uint8 FSoundConcurrencySettings::bLimitToOwner

◆ bVolumeScaleCanRelease

uint8 FSoundConcurrencySettings::bVolumeScaleCanRelease

Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).

◆ ResolutionRule

TEnumAsByte<EMaxConcurrentResolutionRule::Type> FSoundConcurrencySettings::ResolutionRule = EMaxConcurrentResolutionRule::StopFarthestThenOldest

Which concurrency resolution policy to use if max voice count is reached.

◆ RetriggerTime

float FSoundConcurrencySettings::RetriggerTime = 0.0f

Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sounds rejected from this will ignore virtualization settings.

◆ VoiceStealReleaseTime

float FSoundConcurrencySettings::VoiceStealReleaseTime = 0.0f

Time taken to fade out if voice is evicted or culled due to another voice in the group starting.

◆ VolumeScaleAttackTime

float FSoundConcurrencySettings::VolumeScaleAttackTime = 0.01f

Time taken to apply duck using volume scalar.

◆ VolumeScaleMode

EConcurrencyVolumeScaleMode FSoundConcurrencySettings::VolumeScaleMode = EConcurrencyVolumeScaleMode::Default

Volume Scale mode designating how to scale voice volume based on number of member sounds active in group.

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

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

Public Member Functions

Public Attributes