Class reference

AudioStreamMP3

Inherits AudioStream

MP3 audio stream driver.

Description

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

int bar_beats = 4

int beat_count = 0

PackedByteArray data = PackedByteArray()

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 = FileAccess.open(path, FileAccess.READ)
				var sound = AudioStreamMP3.new()
				sound.data = file.get_buffer(file.get_length())
				return sound
			
			public AudioStreamMP3 LoadMP3(string path)
			{
				using var file = FileAccess.Open(path, FileAccess.ModeFlags.Read);
				var sound = new AudioStreamMP3();
				sound.Data = file.GetBuffer(file.GetLength());
				return sound;
			}
			

bool loop = false

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

float loop_offset = 0.0

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

Methods

Source revision 5592dc3a7a61
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.