summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectChorus.xml
blob: 40bac419d6255be5e0e9c3999c438b0478c429d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-alpha">
	<brief_description>
		Adds a chorus audio effect.
	</brief_description>
	<description>
		Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
	</description>
	<tutorials>
	</tutorials>
	<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">
			The effect's raw signal.
		</member>
		<member name="voice/1/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
			The voice's cutoff frequency.
		</member>
		<member name="voice/1/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
			The voice's signal delay.
		</member>
		<member name="voice/1/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
			The voice filter's depth.
		</member>
		<member name="voice/1/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
			The voice's volume.
		</member>
		<member name="voice/1/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
			The voice's pan level.
		</member>
		<member name="voice/1/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
			The voice's filter rate.
		</member>
		<member name="voice/2/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
			The voice's cutoff frequency.
		</member>
		<member name="voice/2/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
			The voice's signal delay.
		</member>
		<member name="voice/2/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
			The voice filter's depth.
		</member>
		<member name="voice/2/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
			The voice's volume.
		</member>
		<member name="voice/2/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
			The voice's pan level.
		</member>
		<member name="voice/2/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
			The voice's filter rate.
		</member>
		<member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
			The voice's cutoff frequency.
		</member>
		<member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
			The voice's signal delay.
		</member>
		<member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
			The voice filter's depth.
		</member>
		<member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
			The voice's volume.
		</member>
		<member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
			The voice's pan level.
		</member>
		<member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
			The voice's filter rate.
		</member>
		<member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
			The voice's cutoff frequency.
		</member>
		<member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
			The voice's signal delay.
		</member>
		<member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
			The voice filter's depth.
		</member>
		<member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
			The voice's volume.
		</member>
		<member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
			The voice's pan level.
		</member>
		<member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
			The voice's filter rate.
		</member>
		<member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count">
			The amount of voices in the effect.
		</member>
		<member name="wet" type="float" setter="set_wet" getter="get_wet">
			The effect's processed signal.
		</member>
	</members>
	<constants>
	</constants>
</class>