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", EditCondition="VolumeScaleMode == EConcurrencyVolumeScaleMode::Default")
MaxCount int32 The max number of allowable concurrent active voices for voices playing in this concurrency group. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Concurrency
  • Meta=(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")
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"
VolumeScaleReleaseTime float Time taken to recover volume scalar duck. Sound/SoundConcurrency.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Volume Scaling"
  • Meta=(DisplayName="Recover Time", EditCondition="bVolumeScaleCanRelease && VolumeScaleMode == EConcurrencyVolumeScaleMode::Default", UIMin="0.0", ClampMin="0.0", UIMax="10.0", ClampMax="1000000.0")

Protected

Name Type Remarks Include Path Unreal Specifiers
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

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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page