unreal.SoundConcurrencySettings?

class unreal.SoundConcurrencySettings(max_count=16, limit_to_owner=False, resolution_rule=MaxConcurrentResolutionRule.STOP_FARTHEST_THEN_OLDEST, volume_scale_attack_time=0.01, volume_scale_can_release=False, volume_scale_release_time=0.5, voice_steal_release_time=0.0)?

Bases: unreal.StructBase

Sound Concurrency Settings

C++ Source:

  • Module: Engine
  • File: SoundConcurrency.h

Editor Properties: (see get_editor_property/set_editor_property)

  • limit_to_owner (bool): [Read-Write] Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn’t have an owner, it falls back to global concurrency.

  • max_count (int32): [Read-Write] The max number of allowable concurrent active voices for voices playing in this concurrency group.

  • resolution_rule (MaxConcurrentResolutionRule): [Read-Write] Which concurrency resolution policy to use if max voice count is reached.

  • voice_steal_release_time (float): [Read-Write] Time taken to fade out if voice is evicted or culled due to another voice in the group starting.

  • volume_scale (float): [Read-Write] Ducking factor to apply per older voice instance (generation), which compounds as new voices play and (optionally) revives them as they stop according to the provided attack/release times.

    AppliedVolumeScale = Math.Pow(DuckingScale, VoiceGeneration)

  • volume_scale_attack_time (float): [Read-Write] Time taken to apply duck using volume scalar.

  • volume_scale_can_release (bool): [Read-Write] Whether or not volume scaling can release (i.e. “recover”) volume ducking behavior when concurrency group sounds stop.

  • volume_scale_release_time (float): [Read-Write] Time taken to remove duck using volume scalar.

limit_to_owner?

(bool) – [Read-Write] Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn’t have an owner, it falls back to global concurrency.

max_count?

(int32) – [Read-Write] The max number of allowable concurrent active voices for voices playing in this concurrency group.

resolution_rule?

(MaxConcurrentResolutionRule) – [Read-Write] Which concurrency resolution policy to use if max voice count is reached.

voice_steal_release_time?

(float) – [Read-Write] Time taken to fade out if voice is evicted or culled due to another voice in the group starting.

volume_scale_attack_time?

(float) – [Read-Write] Time taken to apply duck using volume scalar.

volume_scale_can_release?

(bool) – [Read-Write] Whether or not volume scaling can release (i.e. “recover”) volume ducking behavior when concurrency group sounds stop.

volume_scale_release_time?

(float) – [Read-Write] Time taken to remove duck using volume scalar.