|
@@ -15,7 +15,7 @@
|
|
<return type="int" enum="Error" />
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<param index="0" name="path" type="String" />
|
|
<description>
|
|
<description>
|
|
- Saves the AudioStreamWAV as a WAV file to [param path]. Samples with IMA ADPCM or QOA formats can't be saved.
|
|
|
|
|
|
+ Saves the AudioStreamWAV as a WAV file to [param path]. Samples with IMA ADPCM or Quite OK Audio formats can't be saved.
|
|
[b]Note:[/b] A [code].wav[/code] extension is automatically appended to [param path] if it is missing.
|
|
[b]Note:[/b] A [code].wav[/code] extension is automatically appended to [param path] if it is missing.
|
|
</description>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
@@ -23,19 +23,20 @@
|
|
<members>
|
|
<members>
|
|
<member name="data" type="PackedByteArray" setter="set_data" getter="get_data" default="PackedByteArray()">
|
|
<member name="data" type="PackedByteArray" setter="set_data" getter="get_data" default="PackedByteArray()">
|
|
Contains the audio data in bytes.
|
|
Contains the audio data in bytes.
|
|
- [b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
|
|
|
|
|
|
+ [b]Note:[/b] If [member format] is set to [constant FORMAT_8_BITS], this property expects signed 8-bit PCM data. To convert from unsigned 8-bit PCM, subtract 128 from each byte.
|
|
|
|
+ [b]Note:[/b] If [member format] is set to [constant FORMAT_QOA], this property expects data from a full QOA file.
|
|
</member>
|
|
</member>
|
|
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamWAV.Format" default="0">
|
|
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamWAV.Format" default="0">
|
|
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">
|
|
- The loop start point (in number of samples, relative to the beginning of the stream). This information will be imported automatically from the WAV file if present.
|
|
|
|
|
|
+ The loop start point (in number of samples, relative to the beginning of the stream).
|
|
</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">
|
|
- The loop end point (in number of samples, relative to the beginning of the stream). This information will be imported automatically from the WAV file if present.
|
|
|
|
|
|
+ The loop end point (in number of samples, relative to the beginning of the stream).
|
|
</member>
|
|
</member>
|
|
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamWAV.LoopMode" default="0">
|
|
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamWAV.LoopMode" default="0">
|
|
- The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.
|
|
|
|
|
|
+ The loop mode. 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. Higher values require more storage space, but result in better quality.
|
|
The sample rate for mixing this audio. Higher values require more storage space, but result in better quality.
|
|
@@ -48,16 +49,16 @@
|
|
</members>
|
|
</members>
|
|
<constants>
|
|
<constants>
|
|
<constant name="FORMAT_8_BITS" value="0" enum="Format">
|
|
<constant name="FORMAT_8_BITS" value="0" enum="Format">
|
|
- 8-bit audio codec.
|
|
|
|
|
|
+ 8-bit PCM audio codec.
|
|
</constant>
|
|
</constant>
|
|
<constant name="FORMAT_16_BITS" value="1" enum="Format">
|
|
<constant name="FORMAT_16_BITS" value="1" enum="Format">
|
|
- 16-bit audio codec.
|
|
|
|
|
|
+ 16-bit PCM audio codec.
|
|
</constant>
|
|
</constant>
|
|
<constant name="FORMAT_IMA_ADPCM" value="2" enum="Format">
|
|
<constant name="FORMAT_IMA_ADPCM" value="2" enum="Format">
|
|
- Audio is compressed using IMA ADPCM.
|
|
|
|
|
|
+ Audio is lossily compressed as IMA ADPCM.
|
|
</constant>
|
|
</constant>
|
|
<constant name="FORMAT_QOA" value="3" enum="Format">
|
|
<constant name="FORMAT_QOA" value="3" enum="Format">
|
|
- Audio is compressed as QOA ([url=https://qoaformat.org/]Quite OK Audio[/url]).
|
|
|
|
|
|
+ Audio is lossily compressed as [url=https://qoaformat.org/]Quite OK Audio[/url].
|
|
</constant>
|
|
</constant>
|
|
<constant name="LOOP_DISABLED" value="0" enum="LoopMode">
|
|
<constant name="LOOP_DISABLED" value="0" enum="LoopMode">
|
|
Audio does not loop.
|
|
Audio does not loop.
|