Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 12:12:28 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Added Documentation of AudioStream

Browse Source
This commit is contained in:
Grosskopf 2017-09-16 23:12:52 +02:00
parent 27370a9d16
commit 10269b74c8
3 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/AudioStreamOGGVorbis.xml
View File

@ -56,10 +56,13 @@
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
Raw audio data.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
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">
If loop is [code]true[/code], loop starts from this position, in seconds.
</member>
</members>
<constants>

4
doc/classes/AudioStreamRandomPitch.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Plays audio with random pitch tweaking.
</brief_description>
<description>
Randomly varies pitch on each start.
</description>
<tutorials>
</tutorials>
@ -40,8 +42,10 @@
</methods>
<members>
<member name="audio_stream" type="AudioStream" setter="set_audio_stream" getter="get_audio_stream">
The current [AudioStream].
</member>
<member name="random_pitch" type="float" setter="set_random_pitch" getter="get_random_pitch">
The intensity of random pitch variation.
</member>
</members>
<constants>

15
doc/classes/AudioStreamSample.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Plays audio.
</brief_description>
<description>
Plays audio, can loop.
</description>
<tutorials>
</tutorials>
@ -110,32 +112,45 @@
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
Raw audio data.
</member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
Audio format. See FORMAT_* constants for values.
</member>
<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin">
Loop start in bytes.
</member>
<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end">
Loop end in bytes.
</member>
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode">
Loop mode. See LOOP_* constants for values.
</member>
<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate">
The sample rate for mixing this audio.
</member>
<member name="stereo" type="bool" setter="set_stereo" getter="is_stereo">
If [code]true[/code], audio is stereo. Default value: [code]false[/code].
</member>
</members>
<constants>
<constant name="FORMAT_8_BITS" value="0">
Audio codec 8 bit.
</constant>
<constant name="FORMAT_16_BITS" value="1">
Audio codec 16 bit.
</constant>
<constant name="FORMAT_IMA_ADPCM" value="2">
Audio codec IMA ADPCM.
</constant>
<constant name="LOOP_DISABLED" value="0">
Audio does not loop.
</constant>
<constant name="LOOP_FORWARD" value="1">
Audio loops the data between loop_begin and loop_end playing forward only.
</constant>
<constant name="LOOP_PING_PONG" value="2">
Audio loops the data between loop_begin and loop_end playing back and forth.
</constant>
</constants>
</class>