Class AudioStreamMP3

MP3 audio stream driver.

Inheritance

AudioStream

Resource

RefCounted

Object

AudioStreamMP3

Remarks

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

Note: This class can optionally support legacy MP1 and MP2 formats, provided that the engine is compiled with the minimp3_extra_formats=yes SCons option. These extra formats are not enabled by default.

Properties

bar_beats

var bar_beats : int = 4

Property Value

int

Remarks

• void set_bar_beats(int value)
• int get_bar_beats

beat_count

var beat_count : int = 0

Property Value

int

Remarks

• void set_beat_count(int value)
• int get_beat_count

bpm

var bpm : float = 0.0

Property Value

float

Remarks

• void set_bpm(float value)
• float get_bpm

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).

• gdscript
• C#

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

var data : PackedByteArray = PackedByteArray()

Property Value

PackedByteArray

Remarks

• void set_data(PackedByteArray value)
• PackedByteArray get_data

loop

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

var loop : bool = false

Property Value

bool

Remarks

• void set_loop(bool value)
• bool has_loop

loop_offset

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

var loop_offset : float = 0.0

Property Value

float

Remarks

• void set_loop_offset(float value)
• float get_loop_offset

Methods

load_from_buffer(PackedByteArray)

Qualifiers: static

Creates a new AudioStreamMP3 instance from the given buffer. The buffer must contain MP3 data.

AudioStreamMP3 load_from_buffer(PackedByteArray stream_data)

Parameters

stream_data PackedByteArray

load_from_file(String)

Qualifiers: static

Creates a new AudioStreamMP3 instance from the given file path. The file must be in MP3 format.

AudioStreamMP3 load_from_file(String path)

Parameters

path String