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

Наследует: AudioStream < Resource < RefCounted < Object

MP3 audio stream драйвер.

Описание

Драйвер аудиопотока MP3. См. data, если вы хотите загрузить файл MP3 во время выполнения. Дополнительную информацию можно найти в ResourceImporterMP3.

Примечание: Этот класс может опционально поддерживать устаревшие форматы MP1 и MP2 при условии, что движок скомпилирован с опцией SCons minimp3_extra_formats=yes. Эти дополнительные форматы не включены по умолчанию.

Обучающие материалы

Свойства

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

Методы

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

Описания свойств

int bar_beats = 4 🔗

void set_bar_beats(value: int)
int get_bar_beats()

Количество долей (ритм) в одном такте аудиодорожки.

int beat_count = 0 🔗

void set_beat_count(value: int)
int get_beat_count()

Длительность аудиодорожки в тактах. Фактическая длительность аудиофайла может быть больше, чем указано в этом свойстве. Определяет конец аудио для зацикливания, AudioStreamPlaylist и AudioStreamInteractive.

float bpm = 0.0 🔗

void set_bpm(value: float)
float get_bpm()

Темп аудиодорожки, измеряемый в ударах в минуту.

PackedByteArray data = PackedByteArray() 🔗

void set_data(value: PackedByteArray)
PackedByteArray get_data()

Содержит аудиоданные в байтах.

Вы можете загрузить файл без необходимости его предварительного импорта, используя фрагмент кода ниже. Имейте в виду, что этот фрагмент загружает весь файл в память и может быть неидеальным для огромных файлов (сотни мегабайт и более).

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;
}

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

Если true, воспроизведение потока возобновится с указанного значения loop_offset после достижения конца аудиодорожки или после достижения конца последнего такта в соответствии с величиной, указанной в beat_count. Полезно для фоновых звуков и музыки.

float loop_offset = 0.0 🔗

void set_loop_offset(value: float)
float get_loop_offset()

Время в секундах, через которое начинается трансляция после зацикливания.

Описания метода

AudioStreamMP3 load_from_buffer(stream_data: PackedByteArray) static 🔗

Создает новый экземпляр AudioStreamMP3 из указанного буфера. Буфер должен содержать данные MP3.

AudioStreamMP3 load_from_file(path: String) static 🔗

Создает новый экземпляр AudioStreamMP3 из указанного пути к файлу. Файл должен быть в формате MP3.