unreal.SoundControlBus

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

Bases: unreal.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] Generators

  • 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] Parameter

property address

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

Type

(str)

property bypass

[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

[Read-Write] Generators

Type

(Array(SoundModulationGenerator))

property override_address

[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

[Read-Only] Parameter

Type

(SoundModulationParameter)