unreal.SoundControlBus

class unreal.SoundControlBus(outer: Object | None = None, name: Name | str = 'None')

Bases: SoundModulatorBase

Sound Control Bus

C++ Source:

  • Plugin: AudioModulation

  • Module: AudioModulation

  • File: SoundControlBus.h

Editor Properties: (see get_editor_property/set_editor_property)

  • address (str): [Read-Write] Address to use when applying mix changes.

  • bypass (bool): [Read-Write] If true, bypasses control bus from being modulated by parameters, patches, or mixed (control bus remains active and computed).

  • generators (Array[SoundModulationGenerator]): [Read-Write]

  • override_address (bool): [Read-Write] If true, Address field is used in place of object name for address used when applying mix changes using filtering.

  • parameter (SoundModulationParameter): [Read-Write]

property address: str

[Read-Write] Address to use when applying mix changes.

Type:

(str)

property bypass: bool

[Read-Write] If true, bypasses control bus from being modulated by parameters, patches, or mixed (control bus remains active and computed).

Type:

(bool)

property generators: None

[Read-Write]

Type:

(Array[SoundModulationGenerator])

property override_address: bool

[Read-Write] If true, Address field is used in place of object name for address used when applying mix changes using filtering.

Type:

(bool)

property parameter: SoundModulationParameter

[Read-Only]

Type:

(SoundModulationParameter)