summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectChorus.xml
blob: 7c252b2708461d4209f557915adb668cdd5bf433 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.2">
	<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>
	<methods>
	</methods>
	<members>
		<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
			The effect's raw signal.
		</member>
		<member name="voice/1/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
			The voice's cutoff frequency.
		</member>
		<member name="voice/1/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="15.0">
			The voice's signal delay.
		</member>
		<member name="voice/1/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="2.0">
			The voice filter's depth.
		</member>
		<member name="voice/1/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
			The voice's volume.
		</member>
		<member name="voice/1/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="-0.5">
			The voice's pan level.
		</member>
		<member name="voice/1/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="0.8">
			The voice's filter rate.
		</member>
		<member name="voice/2/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
			The voice's cutoff frequency.
		</member>
		<member name="voice/2/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="20.0">
			The voice's signal delay.
		</member>
		<member name="voice/2/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="3.0">
			The voice filter's depth.
		</member>
		<member name="voice/2/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
			The voice's volume.
		</member>
		<member name="voice/2/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="0.5">
			The voice's pan level.
		</member>
		<member name="voice/2/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="1.2">
			The voice's filter rate.
		</member>
		<member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="null">
			The voice's cutoff frequency.
		</member>
		<member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="null">
			The voice's signal delay.
		</member>
		<member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="null">
			The voice filter's depth.
		</member>
		<member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="null">
			The voice's volume.
		</member>
		<member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="null">
			The voice's pan level.
		</member>
		<member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="null">
			The voice's filter rate.
		</member>
		<member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="null">
			The voice's cutoff frequency.
		</member>
		<member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="null">
			The voice's signal delay.
		</member>
		<member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="null">
			The voice filter's depth.
		</member>
		<member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="null">
			The voice's volume.
		</member>
		<member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="null">
			The voice's pan level.
		</member>
		<member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="null">
			The voice's filter rate.
		</member>
		<member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count" default="2">
			The amount of voices in the effect.
		</member>
		<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
			The effect's processed signal.
		</member>
	</members>
	<constants>
	</constants>
</class>