summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamPlayback.xml
blob: 1909c4b621888548402395c55326a0796d991b48 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayback" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Meta class for playing back audio.
	</brief_description>
	<description>
		Can play, loop, pause a scroll through audio. See [AudioStream] and [AudioStreamOGGVorbis] for usage.
	</description>
	<tutorials>
		<link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>
	</tutorials>
	<methods>
		<method name="_get_loop_count" qualifiers="virtual const">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="_get_playback_position" qualifiers="virtual const">
			<return type="float" />
			<description>
			</description>
		</method>
		<method name="_is_playing" qualifiers="virtual const">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="_mix" qualifiers="virtual">
			<return type="int" />
			<argument index="0" name="buffer" type="AudioFrame*" />
			<argument index="1" name="rate_scale" type="float" />
			<argument index="2" name="frames" type="int" />
			<description>
			</description>
		</method>
		<method name="_seek" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="position" type="float" />
			<description>
			</description>
		</method>
		<method name="_start" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="from_pos" type="float" />
			<description>
			</description>
		</method>
		<method name="_stop" qualifiers="virtual">
			<return type="void" />
			<description>
			</description>
		</method>
	</methods>
</class>