blob: 0fc32b7dd90a499e5f3c0e224c4a0cb0bf12183f (
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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0-beta">
<brief_description>
Plays audio.
</brief_description>
<description>
Plays audio, can loop.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="AudioStreamSample.Format">
</return>
<description>
</description>
</method>
<method name="get_loop_begin" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_end" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_mode" qualifiers="const">
<return type="int" enum="AudioStreamSample.LoopMode">
</return>
<description>
</description>
</method>
<method name="get_mix_rate" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_stereo" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="set_format">
<return type="void">
</return>
<argument index="0" name="format" type="int" enum="AudioStreamSample.Format">
</argument>
<description>
</description>
</method>
<method name="set_loop_begin">
<return type="void">
</return>
<argument index="0" name="loop_begin" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_end">
<return type="void">
</return>
<argument index="0" name="loop_end" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_mode">
<return type="void">
</return>
<argument index="0" name="loop_mode" type="int" enum="AudioStreamSample.LoopMode">
</argument>
<description>
</description>
</method>
<method name="set_mix_rate">
<return type="void">
</return>
<argument index="0" name="mix_rate" type="int">
</argument>
<description>
</description>
</method>
<method name="set_stereo">
<return type="void">
</return>
<argument index="0" name="stereo" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
Raw audio data.
</member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
Audio format. See FORMAT_* constants for values.
</member>
<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin">
Loop start in bytes.
</member>
<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end">
Loop end in bytes.
</member>
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode">
Loop mode. See LOOP_* constants for values.
</member>
<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate">
The sample rate for mixing this audio.
</member>
<member name="stereo" type="bool" setter="set_stereo" getter="is_stereo">
If [code]true[/code], audio is stereo. Default value: [code]false[/code].
</member>
</members>
<constants>
<constant name="FORMAT_8_BITS" value="0">
Audio codec 8 bit.
</constant>
<constant name="FORMAT_16_BITS" value="1">
Audio codec 16 bit.
</constant>
<constant name="FORMAT_IMA_ADPCM" value="2">
Audio codec IMA ADPCM.
</constant>
<constant name="LOOP_DISABLED" value="0">
Audio does not loop.
</constant>
<constant name="LOOP_FORWARD" value="1">
Audio loops the data between loop_begin and loop_end playing forward only.
</constant>
<constant name="LOOP_PING_PONG" value="2">
Audio loops the data between loop_begin and loop_end playing back and forth.
</constant>
</constants>
</class>
|