summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamSample.xml
diff options
context:
space:
mode:
authormerumelu <merumelu@protonmail.com>2019-03-12 15:48:52 +0100
committermerumelu <merumelu@protonmail.com>2019-03-12 15:51:07 +0100
commitdb8f26c8e59d2adabd0c7ef5d310ea0d47e77479 (patch)
tree54eb21a2c599b969275674dceb60b53538473da3 /doc/classes/AudioStreamSample.xml
parent291c281fcf35c531905a68a12a5aec8de68d617f (diff)
AudioStreamSample: Don't crash when writing to file fails
Diffstat (limited to 'doc/classes/AudioStreamSample.xml')
-rw-r--r--doc/classes/AudioStreamSample.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml
index 77d5f14ab7..fdaa942018 100644
--- a/doc/classes/AudioStreamSample.xml
+++ b/doc/classes/AudioStreamSample.xml
@@ -12,11 +12,13 @@
</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>