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

AudioStreamOggVorbis

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

Класс, представляющий аудиопоток Ogg Vorbis.

Описание

Класс AudioStreamOggVorbis — это специализированный класс AudioStream для обработки файлов формата Ogg Vorbis. Он предоставляет функциональность для загрузки и воспроизведения файлов Ogg Vorbis, а также для управления зацикливанием и другими свойствами воспроизведения. Дополнительную информацию можно найти в ResourceImporterOggVorbis.

Этот класс является частью системы аудиопотоков, которая также поддерживает файлы WAV через класс AudioStreamWAV и файлы MP3 через класс AudioStreamMP3.

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

Свойства

int

bar_beats

4

int

beat_count

0

float

bpm

0.0

bool

loop

false

float

loop_offset

0.0

OggPacketSequence

packet_sequence

Dictionary

tags

{}

Методы

AudioStreamOggVorbis

load_from_buffer(stream_data: PackedByteArray) static

AudioStreamOggVorbis

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 🔗

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

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

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

OggPacketSequence packet_sequence 🔗

Содержит необработанные данные Ogg для этого потока.

Dictionary tags = {} 🔗

Содержит пользовательские теги, если они найдены в данных Ogg Vorbis.

Обычно используемые теги включают title, artist, album, tracknumber и date, (date не имеет стандартного формата даты).

Примечание: Не все теги гарантированно присутствует в каждом файле, поэтому обязательно учитывайте ключи, которые не всегда существуют.

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

AudioStreamOggVorbis load_from_buffer(stream_data: PackedByteArray) static 🔗

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

AudioStreamOggVorbis load_from_file(path: String) static 🔗

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