Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

AudioEffectChorus

Inherits: AudioEffect < Resource < RefCounted < 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.

Tutorials

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

float dry = 1.0

The effect's raw signal.


float voice/1/cutoff_hz = 8000.0

  • void set_voice_cutoff_hz ( int voice_idx, float cutoff_hz )

  • float get_voice_cutoff_hz ( int voice_idx ) const

The voice's cutoff frequency.


float voice/1/delay_ms = 15.0

  • void set_voice_delay_ms ( int voice_idx, float delay_ms )

  • float get_voice_delay_ms ( int voice_idx ) const

The voice's signal delay.


float voice/1/depth_ms = 2.0

  • void set_voice_depth_ms ( int voice_idx, float depth_ms )

  • float get_voice_depth_ms ( int voice_idx ) const

The voice filter's depth.


float voice/1/level_db = 0.0

  • void set_voice_level_db ( int voice_idx, float level_db )

  • float get_voice_level_db ( int voice_idx ) const

The voice's volume.


float voice/1/pan = -0.5

  • void set_voice_pan ( int voice_idx, float pan )

  • float get_voice_pan ( int voice_idx ) const

The voice's pan level.


float voice/1/rate_hz = 0.8

  • void set_voice_rate_hz ( int voice_idx, float rate_hz )

  • float get_voice_rate_hz ( int voice_idx ) const

The voice's filter rate.


float voice/2/cutoff_hz = 8000.0

  • void set_voice_cutoff_hz ( int voice_idx, float cutoff_hz )

  • float get_voice_cutoff_hz ( int voice_idx ) const

The voice's cutoff frequency.


float voice/2/delay_ms = 20.0

  • void set_voice_delay_ms ( int voice_idx, float delay_ms )

  • float get_voice_delay_ms ( int voice_idx ) const

The voice's signal delay.


float voice/2/depth_ms = 3.0

  • void set_voice_depth_ms ( int voice_idx, float depth_ms )

  • float get_voice_depth_ms ( int voice_idx ) const

The voice filter's depth.


float voice/2/level_db = 0.0

  • void set_voice_level_db ( int voice_idx, float level_db )