unreal.SoundBase

class unreal.SoundBase(outer=None, name='None')

Bases: unreal.Object

The base class for a playable sound object

C++ Source:

  • Module: Engine

  • File: SoundBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the asset

  • attenuation_settings (SoundAttenuation): [Read-Write] Attenuation Settings: Attenuation settings package for the sound

  • bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

  • bypass_volume_scale_for_priority (bool): [Read-Write] Bypass Volume Scale for Priority: Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).

  • concurrency_overrides (SoundConcurrencySettings): [Read-Write] Concurrency Overrides: If Override Concurrency is true, concurrency settings to use.

  • concurrency_set (Set(SoundConcurrency)): [Read-Write] Concurrency Set: Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.

  • debug (bool): [Read-Write] Debug: When “au.debug.Sounds -debug” has been specified, draw this sound’s attenuation shape when the sound is audible. For debugging purpose only.

  • duration (float): [Read-Only] Duration: Duration of sound in seconds.

  • enable_base_submix (bool): [Read-Write] Enable Base Submix: If enabled, sound will route to the Master Submix by default or to the Base Submix if defined. If disabled, sound will route ONLY to the Submix Sends and/or Bus Sends

  • enable_bus_sends (bool): [Read-Write] Enable Bus Sends: Whether or not to enable sending this audio’s output to buses.

  • enable_submix_sends (bool): [Read-Write] Enable Submix Sends: Whether or not to enable Submix Sends other than the Base Submix.

  • max_distance (float): [Read-Only] Max Distance: The max distance of the asset, as determined by attenuation settings.

  • override_concurrency (bool): [Read-Write] Override Concurrency: Whether or not to override the sound concurrency object with local concurrency settings.

  • pre_effect_bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] Pre Effect Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

  • priority (float): [Read-Write] Priority: Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform’s Audio Settings ‘Max Channels’ property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.

  • sound_class_object (SoundClass): [Read-Write] Sound Class Object: Sound class this sound belongs to

  • sound_submix_object (SoundSubmixBase): [Read-Write] Sound Submix Object: Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass submix is unset, sends to the ‘Master Submix’ as set in the ‘Audio’ category of Project Settings’.

  • sound_submix_sends (Array(SoundSubmixSendInfo)): [Read-Write] Sound Submix Sends: Array of submix sends to which a prescribed amount (see ‘Send Level’) of this sound is sent.

  • source_effect_chain (SoundEffectSourcePresetChain): [Read-Write] Source Effect Chain: The source effect chain to use for this sound.

  • total_samples (float): [Read-Only] Total Samples: Total number of samples (in the thousands). Useful as a metric to analyze the relative size of a given sound asset in content browser.

  • virtualization_mode (VirtualizationMode): [Read-Write] Virtualization Mode: Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).

property bus_sends

[Read-Write] Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

Type

(Array(SoundSourceBusSendInfo))

property bypass_volume_scale_for_priority

[Read-Write] Bypass Volume Scale for Priority: Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).

Type

(bool)

property concurrency_overrides

[Read-Write] Concurrency Overrides: If Override Concurrency is true, concurrency settings to use.

Type

(SoundConcurrencySettings)

property concurrency_set

[Read-Write] Concurrency Set: Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.

Type

(Set(SoundConcurrency))

property duration

[Read-Only] Duration: Duration of sound in seconds.

Type

(float)

property enable_bus_sends

[Read-Write] Enable Bus Sends: Whether or not to enable sending this audio’s output to buses.

Type

(bool)

property max_distance

[Read-Only] Max Distance: The max distance of the asset, as determined by attenuation settings.

Type

(float)

property override_concurrency

[Read-Write] Override Concurrency: Whether or not to override the sound concurrency object with local concurrency settings.

Type

(bool)

property pre_effect_bus_sends

[Read-Write] Pre Effect Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

Type

(Array(SoundSourceBusSendInfo))

property priority

[Read-Write] Priority: Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform’s Audio Settings ‘Max Channels’ property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.

Type

(float)

property sound_class_object

[Read-Only] Sound Class Object: Sound class this sound belongs to

Type

(SoundClass)

property sound_submix_object

[Read-Write] Sound Submix Object: Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass submix is unset, sends to the ‘Master Submix’ as set in the ‘Audio’ category of Project Settings’.

Type

(SoundSubmixBase)

property sound_submix_sends

[Read-Write] Sound Submix Sends: Array of submix sends to which a prescribed amount (see ‘Send Level’) of this sound is sent.

Type

(Array(SoundSubmixSendInfo))

property source_effect_chain

[Read-Write] Source Effect Chain: The source effect chain to use for this sound.

Type

(SoundEffectSourcePresetChain)

property total_samples

[Read-Only] Total Samples: Total number of samples (in the thousands). Useful as a metric to analyze the relative size of a given sound asset in content browser.

Type

(float)

property virtualization_mode

[Read-Write] Virtualization Mode: Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).

Type

(VirtualizationMode)