pandemonium_engine/doc/classes/AudioStream.xml

26 lines
988 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStream" inherits="Resource">
<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 title="Audio streams">$DOCS_URL/03_usage/09_audio/02_audio_streams.md</link>
<link title="Audio Generator Demo">$DOCS_URL/07_demo_projects/audio/generator</link>
<link title="Audio Mic Record Demo">$DOCS_URL/07_demo_projects/audio/mic_record</link>
<link title="Audio Spectrum Demo">$DOCS_URL/07_demo_projects/audio/spectrum</link>
</tutorials>
<methods>
<method name="get_length" qualifiers="const">
<return type="float" />
<description>
Returns the length of the audio stream in seconds.
</description>
</method>
</methods>
<constants>
</constants>
</class>