summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamSample.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioStreamSample.xml')
-rw-r--r--doc/classes/AudioStreamSample.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml
index 77d5f14ab7..e23080c9d3 100644
--- a/doc/classes/AudioStreamSample.xml
+++ b/doc/classes/AudioStreamSample.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.1">
+<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.2">
<brief_description>
Plays audio.
</brief_description>
@@ -8,15 +8,15 @@
</description>
<tutorials>
</tutorials>
- <demos>
- </demos>
<methods>
<method name="save_to_wav">
- <return type="void">
+ <return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
+ Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved.
+ Note that a [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing.
</description>
</method>
</methods>