Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioStreamMP3

Hérite de : AudioStream < Resource < RefCounted < Object

Le pilote de flux audio MP3.

Description

MP3 audio stream driver. See data if you want to load an MP3 file at run-time. More info can be found in ResourceImporterMP3.

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.

Tutoriels

Propriétés

int	bar_beats	`4`
int	beat_count	`0`
float	bpm	`0.0`
PackedByteArray	data	`PackedByteArray()`
bool	loop	`false`
float	loop_offset	`0.0`

Méthodes

AudioStreamMP3	load_from_buffer(stream_data: PackedByteArray) static
AudioStreamMP3	load_from_file(path: String) static

Descriptions des propriétés

int bar_beats = 4 🔗

void set_bar_beats(value: int)
int get_bar_beats()

The number of beats within a single bar in the audio track.

int beat_count = 0 🔗

void set_beat_count(value: int)
int get_beat_count()

The length of the audio track, in beats. The actual duration of the audio file might be longer than what is indicated by this property. It defines the end of the audio for looping, AudioStreamPlaylist, and AudioStreamInteractive.

float bpm = 0.0 🔗

void set_bpm(value: float)
float get_bpm()

The tempo of the audio track, measured in beats per minute.

PackedByteArray data = PackedByteArray() 🔗

void set_data(value: PackedByteArray)
PackedByteArray get_data()

Contient les données audio en octets.

Vous pouvez charger un fichier sans avoir à l'importer à l'avance en utilisant le bout de code ci-dessous. Gardez à l'esprit que ce code charge tout le fichier dans la mémoire et peut ne pas être idéal pour des fichiers énormes (des centaines de mégaoctets ou plus).

func charger_mp3(chemin):
    var fichier = FileAccess.open(chemin, FileAccess.READ)
    var son = AudioStreamMP3.new()
    son.data = fichier.get_buffer(fichier.get_length())
    return son

public AudioStreamMP3 ChargerMP3(string chemin)
{
    using var fichier = FileAccess.Open(fichier, FileAccess.ModeFlags.Read);
    var son = new AudioStreamMP3();
    son.Data = fichier.GetBuffer(fichier.GetLength());
    return son;
}

Note: The returned array is copied and any changes to it will not update the original property value. See PackedByteArray for more details.

bool loop = false 🔗

void set_loop(value: bool)
bool has_loop()

If true, the stream will play again from the specified loop_offset once it reaches the end of the audio track, or once it reaches the end of the last beat according to the amount specified in beat_count. Useful for ambient sounds and background music.

float loop_offset = 0.0 🔗

void set_loop_offset(value: float)
float get_loop_offset()

Le temps en secondes où le flux commence après avoir bouclé.

Descriptions des méthodes

AudioStreamMP3 load_from_buffer(stream_data: PackedByteArray) static 🔗

Crée une nouvelle instance AudioStreamMP3 depuis le tampon donné. Le tampon doit contenir des données MP3.

AudioStreamMP3 load_from_file(path: String) static 🔗

Crée une nouvelle instance AudioStreamMP3 depuis le chemin de fichier donné. Le fichier doit être au format MP3.