blob: a8a61f1b49acaf83c5afb94d6a8a8b0a4595f4c3 (
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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Plays audio in 2D.
</brief_description>
<description>
Plays audio that dampens with distance from screen center.
</description>
<tutorials>
http://docs.godotengine.org/en/latest/learning/features/audio/index.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_area_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_attenuation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_max_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="AudioStream">
</return>
<description>
</description>
</method>
<method name="get_volume_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_autoplay_enabled">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>
<argument index="0" name="from_position" type="float" default="0.0">
</argument>
<description>
Plays the audio from the given position 'from_position', in seconds.
</description>
</method>
<method name="seek">
<return type="void">
</return>
<argument index="0" name="to_position" type="float">
</argument>
<description>
Sets the position from which audio will be played, in seconds.
</description>
</method>
<method name="set_area_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_attenuation">
<return type="void">
</return>
<argument index="0" name="curve" type="float">
</argument>
<description>
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_bus">
<return type="void">
</return>
<argument index="0" name="bus" type="String">
</argument>
<description>
</description>
</method>
<method name="set_max_distance">
<return type="void">
</return>
<argument index="0" name="pixels" type="float">
</argument>
<description>
</description>
</method>
<method name="set_stream">
<return type="void">
</return>
<argument index="0" name="stream" type="AudioStream">
</argument>
<description>
</description>
</method>
<method name="set_volume_db">
<return type="void">
</return>
<argument index="0" name="volume_db" type="float">
</argument>
<description>
</description>
</method>
<method name="stop">
<return type="void">
</return>
<description>
Stops the audio.
</description>
</method>
</methods>
<members>
<member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
Areas in which this sound plays.
</member>
<member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation">
Dampens audio over distance with this as an exponent.
</member>
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
</member>
<member name="bus" type="String" setter="set_bus" getter="get_bus">
Bus on which this audio is playing.
</member>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
Maximum distance from which audio is still hearable.
</member>
<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
If [code]true[/code], audio is playing.
</member>
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
The [AudioStream] object to be played.
</member>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
Base volume without dampening.
</member>
</members>
<signals>
<signal name="finished">
<description>
Emitted when the audio stops playing.
</description>
</signal>
</signals>
<constants>
</constants>
</class>
|