unreal.EnvelopeFollowerGeneratorParams

class unreal.EnvelopeFollowerGeneratorParams(bypass=False, invert=False, audio_bus=None, gain=1.0, attack_time=0.01, release_time=0.1)

Bases: unreal.StructBase

Envelope Follower Generator Params

C++ Source:

  • Plugin: AudioModulation

  • Module: AudioModulation

  • File: SoundModulationEnvelopeFollower.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attack_time (float): [Read-Write] Attack time of envelope response (in sec)

  • audio_bus (AudioBus): [Read-Write] AudioBus to follow amplitude of and generate modulation control signal from.

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

  • gain (float): [Read-Write] Gain to apply to amplitude signal.

  • invert (bool): [Read-Write] If true, inverts output

  • release_time (float): [Read-Write] Release time of envelope response (in sec)

property attack_time

[Read-Write] Attack time of envelope response (in sec)

Type

(float)

property audio_bus

[Read-Write] AudioBus to follow amplitude of and generate modulation control signal from.

Type

(AudioBus)

property bypass

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

Type

(bool)

property gain

[Read-Write] Gain to apply to amplitude signal.

Type

(float)

property invert

[Read-Write] If true, inverts output

Type

(bool)

property release_time

[Read-Write] Release time of envelope response (in sec)

Type

(float)