virtualx-engine/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml

71 lines
1.8 KiB
XML
Raw Normal View History

<?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">
2017-09-16 23:12:52 +02:00
Raw audio data.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
2017-09-16 23:12:52 +02:00
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">
2017-09-16 23:12:52 +02:00
If loop is [code]true[/code], loop starts from this position, in seconds.
</member>
</members>
<constants>
</constants>
</class>