unreal.SoundConcurrencySettings

class unreal.SoundConcurrencySettings(max_count: int = 0, limit_to_owner: bool = False, volume_scale_can_release: bool = False, resolution_rule: MaxConcurrentResolutionRule = Ellipsis, retrigger_time: float = 0.0, volume_scale_mode: ConcurrencyVolumeScaleMode = Ellipsis, volume_scale_attack_time: float = 0.0, volume_scale_release_time: float = 0.0, voice_steal_release_time: float = 0.0)

Bases: 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] Limit to Owner: 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] Max Count: The max number of allowable concurrent active voices for voices playing in this concurrency group.

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

• retrigger_time (float): [Read-Write] Retrigger Time: Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sounds rejected from this will ignore virtualization settings.

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

• volume_scale (float): [Read-Write] Volume Scale: 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.

  Note: This is not applied until after StopQuietest rules are evaluated, in order to avoid thrashing sounds.

  AppliedVolumeScale = Math.Pow(DuckingScale, VoiceGeneration)

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

• volume_scale_can_release (bool): [Read-Write] Volume Scale Can Release: Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).

• volume_scale_mode (ConcurrencyVolumeScaleMode): [Read-Write] Volume Scale Mode: Volume Scale mode designating how to scale voice volume based on number of member sounds active in group.

• volume_scale_release_time (float): [Read-Write] Volume Scale Release Time: Time taken to recover volume scalar duck.

property limit_to_owner: bool

[Read-Write] Limit to Owner: 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.

Type:

(bool)

property max_count: int

[Read-Write] Max Count: The max number of allowable concurrent active voices for voices playing in this concurrency group.

Type:

(int32)

property resolution_rule: MaxConcurrentResolutionRule

[Read-Write] Resolution Rule: Which concurrency resolution policy to use if max voice count is reached.

Type:

(MaxConcurrentResolutionRule)

property retrigger_time: float

[Read-Write] Retrigger Time: Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sounds rejected from this will ignore virtualization settings.

Type:

(float)

property voice_steal_release_time: float

[Read-Write] Voice Steal Release Time: Time taken to fade out if voice is evicted or culled due to another voice in the group starting.

Type:

(float)

property volume_scale_attack_time: float

[Read-Write] Volume Scale Attack Time: Time taken to apply duck using volume scalar.

Type:

(float)

property volume_scale_can_release: bool

[Read-Write] Volume Scale Can Release: Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).

Type:

(bool)

property volume_scale_mode: ConcurrencyVolumeScaleMode

[Read-Write] Volume Scale Mode: Volume Scale mode designating how to scale voice volume based on number of member sounds active in group.

Type:

(ConcurrencyVolumeScaleMode)

property volume_scale_release_time: float

[Read-Write] Volume Scale Release Time: Time taken to recover volume scalar duck.

Type:

(float)