unreal.SoundfieldSubmix

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

Bases: unreal.SoundSubmixWithParentBase

Sound Submix class meant for use with soundfield formats, such as Ambisonics.

C++ Source:

• Module: Engine

• File: SoundSubmix.h

Editor Properties: (see get_editor_property/set_editor_property)

• auto_disable (bool): [Read-Write] Auto Disable: Auto-manage enabling and disabling the submix as a CPU optimization. It will be disabled if the submix and all child submixes are silent. It will re-enable if a sound is sent to the submix or a child submix is audible.

• auto_disable_time (float): [Read-Write] Auto Disable Time: The minimum amount of time to wait before automatically disabling a submix if it is silent. Will immediately re-enable if source audio is sent to it.

• child_submixes (Array(SoundSubmixBase)): [Read-Only] Child Submixes: Child submixes to this sound mix

• encoding_settings (SoundfieldEncodingSettingsBase): [Read-Write] Encoding Settings: Which encoding settings to use the sound field.

• parent_submix (SoundSubmixBase): [Read-Only] Parent Submix

• soundfield_effect_chain (Array(SoundfieldEffectBase)): [Read-Write] Soundfield Effect Chain: Soundfield effect chain to use for the sound field.

• soundfield_encoding_format (Name): [Read-Write] Soundfield Encoding Format: Currently used format.