summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStream.xml
blob: c0a16adda9b739714e5c8f74adff0b24f72e1d5b (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStream" inherits="Resource" category="Core" version="3.1">
	<brief_description>
		Base class for audio streams.
	</brief_description>
	<description>
		Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamSample]) and OGG (via [AudioStreamOGGVorbis]) file formats.
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_length" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns the length of the audio stream in seconds.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>