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.

Опис

Драйвер аудіопотоку 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 🔗

Темп аудіодоріжки, що вимірюється в ударах на хвилину.

PackedByteArray data = PackedByteArray() 🔗

Містить аудіодані в байтах.

Ви можете завантажити файл, не імпортуючи його заздалегідь, використовуючи наведений нижче фрагмент коду. Майте на увазі, що цей фрагмент завантажує весь файл у пам’ять і може бути не ідеальним для великих файлів (сотні мегабайт або більше).

[gdscript]
func load_mp3(шлях):
     var file = FileAccess.open(path, FileAccess.READ)
     var sound = AudioStreamMP3.new()
     sound.data = file.get_buffer(file.get_length())
     return sound
[/gdscript]
[csharp]
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;
 }
[/csharp][/codeblocks]

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.