summaryrefslogtreecommitdiff
path: root/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml
blob: ee6c28c36aa9b7f63f5ffb644dd69b57c3fea112 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamOGGVorbis" inherits="AudioStream" category="Core" version="3.0-alpha">
	<brief_description>
		OGG Vorbis audio stream driver.
	</brief_description>
	<description>
		OGG Vorbis audio stream driver.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_data" qualifiers="const">
			<return type="PoolByteArray">
			</return>
			<description>
			</description>
		</method>
		<method name="get_loop_offset" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="has_loop" 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_loop">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_loop_offset">
			<return type="void">
			</return>
			<argument index="0" name="seconds" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
			Raw audio data.
		</member>
		<member name="loop" type="bool" setter="set_loop" getter="has_loop">
			If [code]true[/code], audio will loop continuously. Default value: [code]false[/code].
		</member>
		<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset">
			If loop is [code]true[/code], loop starts from this position, in seconds.
		</member>
	</members>
	<constants>
	</constants>
</class>