virtualx-engine/doc/classes/AudioStreamSample.xml
2017-09-16 01:46:29 +02:00

141 lines
3.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="AudioStreamSample.Format">
</return>
<description>
</description>
</method>
<method name="get_loop_begin" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_end" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_mode" qualifiers="const">
<return type="int" enum="AudioStreamSample.LoopMode">
</return>
<description>
</description>
</method>
<method name="get_mix_rate" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_stereo" 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_format">
<return type="void">
</return>
<argument index="0" name="format" type="int" enum="AudioStreamSample.Format">
</argument>
<description>
</description>
</method>
<method name="set_loop_begin">
<return type="void">
</return>
<argument index="0" name="loop_begin" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_end">
<return type="void">
</return>
<argument index="0" name="loop_end" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_mode">
<return type="void">
</return>
<argument index="0" name="loop_mode" type="int" enum="AudioStreamSample.LoopMode">
</argument>
<description>
</description>
</method>
<method name="set_mix_rate">
<return type="void">
</return>
<argument index="0" name="mix_rate" type="int">
</argument>
<description>
</description>
</method>
<method name="set_stereo">
<return type="void">
</return>
<argument index="0" name="stereo" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
</member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
</member>
<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin">
</member>
<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end">
</member>
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode">
</member>
<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate">
</member>
<member name="stereo" type="bool" setter="set_stereo" getter="is_stereo">
</member>
</members>
<constants>
<constant name="FORMAT_8_BITS" value="0">
</constant>
<constant name="FORMAT_16_BITS" value="1">
</constant>
<constant name="FORMAT_IMA_ADPCM" value="2">
</constant>
<constant name="LOOP_DISABLED" value="0">
</constant>
<constant name="LOOP_FORWARD" value="1">
</constant>
<constant name="LOOP_PING_PONG" value="2">
</constant>
</constants>
</class>