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.

Methods

floatget_voice_cutoff_hz ( int voice_idx ) const
floatget_voice_delay_ms ( int voice_idx ) const
floatget_voice_depth_ms ( int voice_idx ) const
floatget_voice_level_db ( int voice_idx ) const
floatget_voice_pan ( int voice_idx ) const
floatget_voice_rate_hz ( int voice_idx ) const
voidset_voice_cutoff_hz ( int voice_idx, float cutoff_hz )
voidset_voice_delay_ms ( int voice_idx, float delay_ms )
voidset_voice_depth_ms ( int voice_idx, float depth_ms )
voidset_voice_level_db ( int voice_idx, float level_db )
voidset_voice_pan ( int voice_idx, float pan )
voidset_voice_rate_hz ( int voice_idx, float rate_hz )

Property Descriptions

Default1.0
Setterset_dry(value)
Getterget_dry()

The effect’s raw signal.


Default8000.0
Setterset_voice_cutoff_hz(value)
Getterget_voice_cutoff_hz()

The voice’s cutoff frequency.


Default15.0
Setterset_voice_delay_ms(value)
Getterget_voice_delay_ms()

The voice’s signal delay.


Default2.0
Setterset_voice_depth_ms(value)
Getterget_voice_depth_ms()

The voice filter’s depth.


Default0.0
Setterset_voice_level_db(value)
Getterget_voice_level_db()

The voice’s volume.


Default-0.5
Setterset_voice_pan(value)
Getterget_voice_pan()

The voice’s pan level.


Default0.8
Setterset_voice_rate_hz(value)
Getterget_voice_rate_hz()

The voice’s filter rate.


Default8000.0
Setterset_voice_cutoff_hz(value)
Getterget_voice_cutoff_hz()

The voice’s cutoff frequency.


Default20.0
Setterset_voice_delay_ms(value)
Getterget_voice_delay_ms()

The voice’s signal delay.


Default3.0
Setterset_voice_depth_ms(value)
Getterget_voice_depth_ms()

The voice filter’s depth.


Default0.0
Setterset_voice_level_db(value)
Getterget_voice_level_db()

The voice’s volume.


Default0.5
Setterset_voice_pan(value)
Getterget_voice_pan()

The voice’s pan level.


Default1.2
Setterset_voice_rate_hz(value)
Getterget_voice_rate_hz()

The voice’s filter rate.


Setterset_voice_cutoff_hz(value)
Getterget_voice_cutoff_hz()

The voice’s cutoff frequency.


Setterset_voice_delay_ms(value)
Getterget_voice_delay_ms()

The voice’s signal delay.


Setterset_voice_depth_ms(value)
Getterget_voice_depth_ms()

The voice filter’s depth.


Setterset_voice_level_db(value)
Getterget_voice_level_db()

The voice’s volume.


Setterset_voice_pan(value)
Getterget_voice_pan()

The voice’s pan level.


Setterset_voice_rate_hz(value)
Getterget_voice_rate_hz()

The voice’s filter rate.


Setterset_voice_cutoff_hz(value)
Getterget_voice_cutoff_hz()

The voice’s cutoff frequency.


Setterset_voice_delay_ms(value)
Getterget_voice_delay_ms()

The voice’s signal delay.


Setterset_voice_depth_ms(value)
Getterget_voice_depth_ms()

The voice filter’s depth.


Setterset_voice_level_db(value)
Getterget_voice_level_db()

The voice’s volume.


Setterset_voice_pan(value)
Getterget_voice_pan()

The voice’s pan level.


Setterset_voice_rate_hz(value)
Getterget_voice_rate_hz()

The voice’s filter rate.


  • int voice_count
Default2
Setterset_voice_count(value)
Getterget_voice_count()

The amount of voices in the effect.


Default0.5
Setterset_wet(value)
Getterget_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 )

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:28:34. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.