godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve the AudioStreamSample class documentation 

This closes #37915.

(cherry picked from commit 52786b54ef)
This commit is contained in:
Hugo Locurcio 2020-04-15 23:38:12 +02:00 committed by Rémi Verschelde
parent 103278d84b
commit ab4ea9379c
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/classes/AudioStreamSample.xml
View File

@ -30,13 +30,13 @@
Audio format. See [enum Format] constants for values. Audio format. See [enum Format] constants for values.
</member> </member>
<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin" default="0"> <member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin" default="0">
Loop start in bytes. The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
</member> </member>
<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end" default="0"> <member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end" default="0">
Loop end in bytes. The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
</member> </member>
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode" default="0"> <member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode" default="0">
Loop mode. See [enum LoopMode] constants for values. The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.
</member> </member>
<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate" default="44100"> <member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate" default="44100">
The sample rate for mixing this audio. The sample rate for mixing this audio.
@ -59,13 +59,13 @@
Audio does not loop. Audio does not loop.
</constant> </constant>
<constant name="LOOP_FORWARD" value="1" enum="LoopMode"> <constant name="LOOP_FORWARD" value="1" enum="LoopMode">
Audio loops the data between [member loop_begin] and [member loop_end] playing forward only. Audio loops the data between [member loop_begin] and [member loop_end], playing forward only.
</constant> </constant>
<constant name="LOOP_PING_PONG" value="2" enum="LoopMode"> <constant name="LOOP_PING_PONG" value="2" enum="LoopMode">
Audio loops the data between [member loop_begin] and [member loop_end] playing back and forth. Audio loops the data between [member loop_begin] and [member loop_end], playing back and forth.
</constant> </constant>
<constant name="LOOP_BACKWARD" value="3" enum="LoopMode"> <constant name="LOOP_BACKWARD" value="3" enum="LoopMode">
Audio loops the data between [member loop_begin] and [member loop_end] playing backward only. Audio loops the data between [member loop_begin] and [member loop_end], playing backward only.
</constant> </constant>
</constants> </constants>
</class> </class>