summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectChorus.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioEffectChorus.xml')
-rw-r--r--doc/classes/AudioEffectChorus.xml170
1 files changed, 1 insertions, 169 deletions
diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml
index 40bac419d6..465fda28da 100644
--- a/doc/classes/AudioEffectChorus.xml
+++ b/doc/classes/AudioEffectChorus.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-alpha">
+<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-beta">
<brief_description>
Adds a chorus audio effect.
</brief_description>
@@ -11,174 +11,6 @@
<demos>
</demos>
<methods>
- <method name="get_dry" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Returns the set dry ratio.
- </description>
- </method>
- <method name="get_voice_count" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the set voice count.
- </description>
- </method>
- <method name="get_voice_cutoff_hz" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice's set cutoff frequency.
- </description>
- </method>
- <method name="get_voice_delay_ms" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice's set delay.
- </description>
- </method>
- <method name="get_voice_depth_ms" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice's set filter depth.
- </description>
- </method>
- <method name="get_voice_level_db" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice's set maximum volume.
- </description>
- </method>
- <method name="get_voice_pan" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice's set pan.
- </description>
- </method>
- <method name="get_voice_rate_hz" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <description>
- Returns the voice filter's set rate in cycles.
- </description>
- </method>
- <method name="get_wet" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Returns the set applied wetness of the effect.
- </description>
- </method>
- <method name="set_dry">
- <return type="void">
- </return>
- <argument index="0" name="amount" type="float">
- </argument>
- <description>
- Returns the set applied dryness of the effect.
- </description>
- </method>
- <method name="set_voice_count">
- <return type="void">
- </return>
- <argument index="0" name="voices" type="int">
- </argument>
- <description>
- Set the number of voices in the effect's filter.
- </description>
- </method>
- <method name="set_voice_cutoff_hz">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="cutoff_hz" type="float">
- </argument>
- <description>
- Set the cutoff frequency of the voice. The maximum frequency the voice may affect.
- </description>
- </method>
- <method name="set_voice_delay_ms">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="delay_ms" type="float">
- </argument>
- <description>
- Set the delay of the voice's signal.
- </description>
- </method>
- <method name="set_voice_depth_ms">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="depth_ms" type="float">
- </argument>
- <description>
- Set the filter depth of the voice's signal.
- </description>
- </method>
- <method name="set_voice_level_db">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="level_db" type="float">
- </argument>
- <description>
- Set the volume level of the voice.
- </description>
- </method>
- <method name="set_voice_pan">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="pan" type="float">
- </argument>
- <description>
- Set the pan level of the voice.
- </description>
- </method>
- <method name="set_voice_rate_hz">
- <return type="void">
- </return>
- <argument index="0" name="voice_idx" type="int">
- </argument>
- <argument index="1" name="rate_hz" type="float">
- </argument>
- <description>
- Set the voice filter's rate.
- </description>
- </method>
- <method name="set_wet">
- <return type="void">
- </return>
- <argument index="0" name="amount" type="float">
- </argument>
- <description>
- Set the amount of effect.
- </description>
- </method>
</methods>
<members>
<member name="dry" type="float" setter="set_dry" getter="get_dry">