AudioStreamSample

    Stores audio data loaded from WAV files.

    AudioStreamSample stores sound samples loaded from WAV files. To play the stored sound, use an (for non-positional audio) or AudioStreamPlayer2D/ (for positional audio). The sound can be looped.

    This class can also be used to store dynamically-generated PCM audio data.

    Properties

    Error ( String path )

    Enumerations

    enum Format:

    • FORMAT_16_BITS = 1 —- 16-bit audio codec.
    • FORMAT_IMA_ADPCM = 2 —- Audio is compressed using IMA ADPCM.
    • LOOP_DISABLED = 0 —- Audio does not loop.
    • LOOP_FORWARD = 1 —- Audio loops the data between and loop_end, playing forward only.
    • LOOP_PING_PONG = 2 —- Audio loops the data between and loop_end, playing back and forth.
    • LOOP_BACKWARD = 3 —- Audio loops the data between and loop_end, playing backward only.
    DefaultPoolByteArray(  )
    Setterset_data(value)
    Getterget_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.

    • format

    Audio format. See Format constants for values.

    • loop_begin
    Default0
    Setterset_loop_begin(value)
    Getterget_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.

    Default0
    Setterset_loop_end(value)
    Getterget_loop_end()
    • loop_mode

    The loop mode. This information will be imported automatically from the WAV file if present. See LoopMode constants for values.

    • mix_rate
    Default
    Setterset_mix_rate(value)
    Getterget_mix_rate()

    The sample rate for mixing this audio.

    Defaultfalse
    Setterset_stereo(value)
    Getteris_stereo()

    If true, audio is stereo.

    Method Descriptions

    Saves the AudioStreamSample as a WAV file to path. Samples with IMA ADPCM format can’t be saved.