FSoundConcurrencySettings

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "Sound/SoundConcurrency.h"

Syntax

struct FSoundConcurrencySettings

Variables

Name Description

Public variable

uint32: 1

 

bLimitToOwner

Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound).

Public variable

uint32: 1

 

bVolumeScaleCanRelease

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

Public variable

int32

 

MaxCount

The max number of allowable concurrent active voices for voices playing in this concurrency group.

Public variable

TEnumAsByte< EM...

 

ResolutionRule

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

Public variable

float

 

RetriggerTime

Amount of time to wait (in seconds) between different sounds which play with this concurrency.

Public variable

float

 

VoiceStealReleaseTime

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

Public variable

float

 

VolumeScaleAttackTime

Time taken to apply duck using volume scalar.

Public variable

EConcurrencyVol...

 

VolumeScaleMode

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

Public variable

float

 

VolumeScaleReleaseTime

Time taken to recover volume scalar duck.

Constructors

Name Description

Public function

FSoundConcurrencySettings()

Functions

Name Description

Public function Const

float

 

GetVolumeScale()

Retrieves the volume scale

Public function Const

bool

 

IsEvictionSupported()

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.

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