godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml

27 lines
999 B
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="AudioStreamOGGVorbis" inherits="AudioStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
OGG Vorbis audio stream driver.
</brief_description>
<description>
OGG Vorbis audio stream driver.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray( )">
Fully exposes data variable on AudioStreamSample/AudioStreamOGGVorbis... ...and also changes "_set_data" and "_get_data" to "set_data" and "get_data" respectively.
2018-04-25 19:04:03 +00:00
Contains the audio data in bytes.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">
Complete documentation of various classes
2020-01-08 21:51:16 +00:00
If [code]true[/code], the stream will automatically loop when it reaches the end.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset" default="0.0">
Complete documentation of various classes
2020-01-08 21:51:16 +00:00
Time in seconds at which the stream starts after being looped.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
</class>