AudioStreamMP3

Inherits: AudioStream < Resource < RefCounted < Object

MP3 audio stream driver.

Description

MP3 audio stream driver. See data if you want to load an MP3 file at run-time.

Properties

int

bar_beats

4

int

beat_count

0

float

bpm

0.0

PackedByteArray

data

PackedByteArray()

bool

loop

false

float

loop_offset

0.0

Property Descriptions

  • int bar_beats

Default

4

Setter

set_bar_beats(value)

Getter

get_bar_beats()


  • int beat_count

Default

0

Setter

set_beat_count(value)

Getter

get_beat_count()


Default

0.0

Setter

set_bpm(value)

Getter

get_bpm()


Default

PackedByteArray()

Setter

set_data(value)

Getter

get_data()

Contains the audio data in bytes.

You can load a file without having to import it beforehand using the code snippet below. Keep in mind that this snippet loads the whole file into memory and may not be ideal for huge files (hundreds of megabytes or more).

func load_mp3(path):
    var file = File.new()
    file.open(path, File.READ)
    var sound = AudioStreamMP3.new()
    sound.data = file.get_buffer(file.get_length())
    file.close()
    return sound

Default

false

Setter

set_loop(value)

Getter

has_loop()

If true, the stream will automatically loop when it reaches the end.


Default

0.0

Setter

set_loop_offset(value)

Getter

get_loop_offset()

Time in seconds at which the stream starts after being looped.