1. Epic GamesDeveloper
  3. FSoundConcurrencySettings

FSoundConcurrencySettings

API > API/Runtime > API/Runtime/Engine

   
Name FSoundConcurrencySettings
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundConcurrency.h
Include Path #include "Sound/SoundConcurrency.h"

Syntax

USTRUCT (BlueprintType )  
struct FSoundConcurrencySettings

Constructors

Name Remarks Include Path Unreal Specifiers

FSoundConcurrencySettings()

   Sound/SoundConcurrency.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bLimitToOwner uint8 Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
bVolumeScaleCanRelease uint8 Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only). Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Volume Scaling"
  • Meta=(DisplayName="Can Recover", DisplayAfter="VolumeScaleMode", EditCondition="VolumeScaleMode == EConcurrencyVolumeScaleMode::Default", EditConditionHides)
ClampMax     Sound/SoundConcurrency.h
  • 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")
ClampMin     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
DisplayAfter     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
DisplayName   The max number of allowable concurrent active voices for voices playing in this concurrency group. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
EditCondition     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
EditConditionHides     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
ResolutionRule TEnumAsByte< EMaxConcurrentResolutionRule::Type > Which concurrency resolution policy to use if max voice count is reached. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
RetriggerTime float Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(UIMin="0.0", ClampMin="0.0")
UIMax     Sound/SoundConcurrency.h
  • 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")
UIMin     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Dynamic)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="!bEnableMaxCountPlatformScaling", EditConditionHides, UIMin="1", ClampMin="1")
VoiceStealReleaseTime float Time taken to fade out if voice is evicted or culled due to another voice in the group starting. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Voice Stealing"
  • Meta=(UIMin="0.0", ClampMin="0.0", UIMax="1.0", ClampMax="1000000.0")
VolumeScaleAttackTime float Time taken to apply duck using volume scalar. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Volume Scaling"
  • Meta=(DisplayName="Duck Time", UIMin="0.0", ClampMin="0.0", UIMax="10.0", ClampMax="1000000.0")
VolumeScaleMode EConcurrencyVolumeScaleMode Volume Scale mode designating how to scale voice volume based on number of member sounds active in group. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Volume Scaling"

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowPrivateAccess     Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Concurrency
  • Meta=(DisplayName="Max Count (Platform Scaled)", DisplayAfter="bEnableMaxCountPlatformScaling", EditCondition="bEnableMaxCountPlatformScaling", EditConditionHides, AllowPrivateAccess, UIMin="1", ClampMin="1")
bEnableMaxCountPlatformScaling uint8 If true, MaxCount supports platform scaling, but cannot be dynamically changed at runtime (ex. from Blueprint or Gameplay Code). Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Concurrency
  • Meta=(AllowPrivateAccess)
VolumeScale float Ducking factor to apply per older voice instance (generation), which compounds based on scaling mode and (optionally) revives them as they stop according to the provided attack/release times. Sound/SoundConcurrency.h
  • EditAnywhere
  • Category="Volume Scaling"
  • Meta=(UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="1.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetMaxCount()

 Returns the MaxCount as a per-platform integer value. Sound/SoundConcurrency.h  

float GetVolumeScale()

 Retrieves the volume scale Sound/SoundConcurrency.h  

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. Sound/SoundConcurrency.h  

bool IsMaxCountPlatformScalingEnabled()

 Returns whether or not platform scaling is enabled for MaxCount. Sound/SoundConcurrency.h  

void SetEnableMaxCountPlatformScaling ( bool bEnabled
)

 Enables or disables MaxCount platform scaling. Sound/SoundConcurrency.h  

bool 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. Sound/SoundConcurrency.h  

bool SetPlatformMaxCount ( FPerPlatformInt InMaxCount
)

 If MaxCount platform scaling is enabled, applying the given per-platform integer value as the MaxCount. Sound/SoundConcurrency.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page