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

Посібники

Властивості

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

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 🔗

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

PackedByteArray data = PackedByteArray() 🔗

  • void set_data(value: PackedByteArray)

  • PackedByteArray get_data()

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

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

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

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

Час у секундах, коли потік починається після зациклення.

Описи методів

AudioStreamMP3 load_from_buffer(stream_data: PackedByteArray) static 🔗

Створює новий екземпляр AudioStreamMP3 із заданого буфера. Буфер повинен містити дані MP3.

AudioStreamMP3 load_from_file(path: String) static 🔗

Створює новий екземпляр AudioStreamMP3 із указаного шляху до файлу. Файл має бути у форматі MP3.