Class fx_envelope_tracker

Inheritance Relationships

Base Type

Class Documentation

class fx_envelope_tracker : public fx_effect

Effect: Envelope tracker.

An envelope tracker creates a control signal that follows the volume of the audio running into it.

There is also a control signal built into the pedal itself that can be used for current volume. However, the envelope tracker also provides discrete control for attack and release.

For more advanced envelope control, see the ADSR Envelope function.

Public Functions

fx_envelope_tracker(float attack_speed_ms, float decay_speed_ms, bool triggered)

Constructs a new envelope tracker instance.

Parameters
  • [in] attack_speed_ms: The attack speed milliseconds

  • [in] decay_speed_ms: The decay speed milliseconds

  • [in] triggered: Indicates if triggered (should envelope value drop down to zero when new note event is detected)

fx_envelope_tracker(float attack_speed_ms, float decay_speed_ms, bool triggered, float ctrl_scale, float ctrl_offset)
void set_attack_speed_ms(float attack_speed_ms)
void set_decay_speed_ms(float decay_speed_ms)
void set_env_scale(float scale)

Sets the envelope scale.

Parameters
  • [in] scale: The scale value / multiplier

void set_env_offset(float offset)
void print_params(void)

Public Members

fx_audio_node *input
fx_control_node *decay_speed_ms

Control routing node: decay speed of envelope (milliseconds)

fx_control_node *attack_speed_ms

Control routing node: attack speeed of envelope (milliseconds)

fx_control_node *envelope

Control routing node: envelope signal

fx_control_node *scale

Control routing node: scale of envelope signal

fx_control_node *offset

Control routing node: offset of envelope signal