AudioEffectChorus

Inherits: AudioEffect < Resource < Reference < Object

Adds a chorus audio effect.

Description

Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.

Properties

float

dry

1.0

float

voice/1/cutoff_hz

8000.0

float

voice/1/delay_ms

15.0

float

voice/1/depth_ms

2.0

float

voice/1/level_db

0.0

float

voice/1/pan

-0.5

float

voice/1/rate_hz

0.8

float

voice/2/cutoff_hz

8000.0

float

voice/2/delay_ms

20.0

float

voice/2/depth_ms

3.0

float

voice/2/level_db

0.0

float

voice/2/pan

0.5

float

voice/2/rate_hz

1.2

float

voice/3/cutoff_hz

float

voice/3/delay_ms

float

voice/3/depth_ms

float

voice/3/level_db

float

voice/3/pan

float

voice/3/rate_hz

float

voice/4/cutoff_hz

float

voice/4/delay_ms

float

voice/4/depth_ms

float

voice/4/level_db

float

voice/4/pan

float

voice/4/rate_hz

int

voice_count

2

float

wet

0.5

Methods

float

get_voice_cutoff_hz ( int voice_idx ) const

float

get_voice_delay_ms ( int voice_idx ) const

float

get_voice_depth_ms ( int voice_idx ) const

float

get_voice_level_db ( int voice_idx ) const

float

get_voice_pan ( int voice_idx ) const

float

get_voice_rate_hz ( int voice_idx ) const

void

set_voice_cutoff_hz ( int voice_idx, float cutoff_hz )

void

set_voice_delay_ms ( int voice_idx, float delay_ms )

void

set_voice_depth_ms ( int voice_idx, float depth_ms )

void

set_voice_level_db ( int voice_idx, float level_db )

void

set_voice_pan ( int voice_idx, float pan )

void

set_voice_rate_hz ( int voice_idx, float rate_hz )

Property Descriptions

Default

1.0

Setter

set_dry(value)

Getter

get_dry()

The effect's raw signal.


  • float voice/1/cutoff_hz

Default

8000.0

Setter

set_voice_cutoff_hz(value)

Getter

get_voice_cutoff_hz()

The voice's cutoff frequency.


Default

15.0

Setter

set_voice_delay_ms(value)

Getter

get_voice_delay_ms()

The voice's signal delay.


Default

2.0

Setter

set_voice_depth_ms(value)

Getter

get_voice_depth_ms()

The voice filter's depth.


Default

0.0

Setter

set_voice_level_db(value)

Getter

get_voice_level_db()

The voice's volume.


Default

-0.5

Setter

set_voice_pan(value)

Getter

get_voice_pan()

The voice's pan level.


Default

0.8

Setter

set_voice_rate_hz(value)

Getter

get_voice_rate_hz()

The voice's filter rate.


  • float voice/2/cutoff_hz

Default

8000.0

Setter

set_voice_cutoff_hz(value)

Getter

get_voice_cutoff_hz()

The voice's cutoff frequency.


Default

20.0

Setter

set_voice_delay_ms(value)

Getter

get_voice_delay_ms()

The voice's signal delay.


Default

3.0

Setter

set_voice_depth_ms(value)

Getter

get_voice_depth_ms()

The voice filter's depth.


Default

0.0

Setter

set_voice_level_db(value)

Getter

get_voice_level_db()

The voice's volume.


Default

0.5

Setter

set_voice_pan(value)

Getter

get_voice_pan()

The voice's pan level.


Default

1.2

Setter

set_voice_rate_hz(value)

Getter

get_voice_rate_hz()

The voice's filter rate.


  • float voice/3/cutoff_hz

Setter

set_voice_cutoff_hz(value)

Getter

get_voice_cutoff_hz()

The voice's cutoff frequency.


Setter

set_voice_delay_ms(value)

Getter

get_voice_delay_ms()

The voice's signal delay.


Setter

set_voice_depth_ms(value)

Getter

get_voice_depth_ms()

The voice filter's depth.


Setter

set_voice_level_db(value)

Getter

get_voice_level_db()

The voice's volume.


Setter

set_voice_pan(value)

Getter

get_voice_pan()

The voice's pan level.


Setter

set_voice_rate_hz(value)

Getter

get_voice_rate_hz()

The voice's filter rate.


  • float voice/4/cutoff_hz

Setter

set_voice_cutoff_hz(value)

Getter

get_voice_cutoff_hz()

The voice's cutoff frequency.


Setter

set_voice_delay_ms(value)

Getter

get_voice_delay_ms()

The voice's signal delay.


Setter

set_voice_depth_ms(value)

Getter

get_voice_depth_ms()

The voice filter's depth.


Setter

set_voice_level_db(value)

Getter

get_voice_level_db()

The voice's volume.


Setter

set_voice_pan(value)

Getter

get_voice_pan()

The voice's pan level.


Setter

set_voice_rate_hz(value)

Getter

get_voice_rate_hz()

The voice's filter rate.


  • int voice_count

Default

2

Setter

set_voice_count(value)

Getter

get_voice_count()

The amount of voices in the effect.


Default

0.5

Setter

set_wet(value)

Getter

get_wet()

The effect's processed signal.

Method Descriptions

  • float get_voice_cutoff_hz ( int voice_idx ) const


  • float get_voice_delay_ms ( int voice_idx ) const


  • float get_voice_depth_ms ( int voice_idx ) const


  • float get_voice_level_db ( int voice_idx ) const


  • float get_voice_pan ( int voice_idx ) const


  • float get_voice_rate_hz ( int voice_idx ) const


  • void set_voice_cutoff_hz ( int voice_idx, float cutoff_hz )


  • void set_voice_delay_ms ( int voice_idx, float delay_ms )


  • void set_voice_depth_ms ( int voice_idx, float depth_ms )


  • void set_voice_level_db ( int voice_idx, float level_db )


  • void set_voice_pan ( int voice_idx, float pan )


  • void set_voice_rate_hz ( int voice_idx, float rate_hz )