Inherits: AudioStream < Resource < Reference < Object
Stores audio data loaded from WAV files.
AudioStreamSample stores sound samples loaded from WAV files. To play the stored sound, use an AudioStreamPlayer (for non-positional audio) or AudioStreamPlayer2D/AudioStreamPlayer3D (for positional audio). The sound can be looped.
This class can also be used to store dynamically-generated PCM audio data.
PoolByteArray | data | PoolByteArray( ) |
Format | format | 0 |
int | loop_begin | 0 |
int | loop_end | 0 |
LoopMode | loop_mode | 0 |
int | mix_rate | 44100 |
bool | stereo | false |
Error | save_to_wav ( String path ) |
enum Format:
enum LoopMode:
Default | PoolByteArray( ) |
Setter | set_data(value) |
Getter | get_data() |
Contains the audio data in bytes.
Note: This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
Default | 0 |
Setter | set_format(value) |
Getter | get_format() |
Audio format. See Format constants for values.
Default | 0 |
Setter | set_loop_begin(value) |
Getter | get_loop_begin() |
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.
Default | 0 |
Setter | set_loop_end(value) |
Getter | get_loop_end() |
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.
Default | 0 |
Setter | set_loop_mode(value) |
Getter | get_loop_mode() |
The loop mode. This information will be imported automatically from the WAV file if present. See LoopMode constants for values.
Default | 44100 |
Setter | set_mix_rate(value) |
Getter | get_mix_rate() |
The sample rate for mixing this audio.
Default | false |
Setter | set_stereo(value) |
Getter | is_stereo() |
If true
, audio is stereo.
Saves the AudioStreamSample as a WAV file to path
. Samples with IMA ADPCM format can't be saved.
Note: A .wav
extension is automatically appended to path
if it is missing.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_audiostreamsample.html