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.

ResourceImporterOggVorbis

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

Импортирует аудиофайл Ogg Vorbis для воспроизведения.

Описание

Ogg Vorbis — это аудиоформат с потерями, с лучшим качеством звука по сравнению с ResourceImporterMP3 при заданном битрейте.

В большинстве случаев рекомендуется использовать Ogg Vorbis вместо MP3. Однако, если вы используете источник звука MP3 без более качественного источника, рекомендуется использовать файл MP3 напрямую, чтобы избежать двойного сжатия с потерями.

Ogg Vorbis требует больше ресурсов ЦП для декодирования, чем ResourceImporterWAV. Если вам нужно воспроизводить много одновременных звуков, рекомендуется использовать для этих звуков WAV, особенно если вы ориентируетесь на бюджетные устройства.

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

Свойства

int

bar_beats

4

int

beat_count

0

float

bpm

0

bool

loop

false

float

loop_offset

0

Методы

AudioStreamOggVorbis

load_from_buffer(stream_data: PackedByteArray) static

AudioStreamOggVorbis

load_from_file(path: String) static


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

int bar_beats = 4 🔗

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

Более удобный редактор для bar_beats доступен в диалоговом окне Расширенные настройки импорта, так как он позволяет предварительно просмотреть изменения без необходимости повторного импорта аудио.


int beat_count = 0 🔗

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

Более удобный редактор для beat_count предоставляется в диалоговом окне Расширенные настройки импорта, поскольку он позволяет предварительно просмотреть изменения без необходимости повторного импорта аудио.


float bpm = 0 🔗

Темп аудиодорожки, измеренный в ударах в минуту. Он должен соответствовать показателю BPM, который использовался при создании трека. Это актуально только для музыки, которая предполагает использование интерактивных музыкальных функций, а не звуковых эффектов.

Более удобный редактор для bpm предоставляется в диалоговом окне Расширенные настройки импорта, поскольку он позволяет предварительно просмотреть изменения без необходимости повторного импорта аудио.


bool loop = false 🔗

Если эта функция включена, воспроизведение аудио начнётся либо с начала, либо с loop_offset после завершения воспроизведения, либо после достижения конца аудиофайла, либо конца последнего такта в соответствии с величиной, указанной в beat_count.

Примечание: В AudioStreamPlayer сигнал AudioStreamPlayer.finished не будет генерироваться для зацикливания аудио, когда он достигнет конца аудиофайла, поскольку воспроизведение аудио будет продолжаться бесконечно.


float loop_offset = 0 🔗

Определяет, где аудио начнет цикл после того, как воспроизведение достигнет конца аудио. Это можно использовать для циклического воспроизведения только части аудиофайла, что полезно для некоторых окружающих звуков или музыки. Значение определяется в секундах относительно начала аудио. Значение 0.0 зациклит весь аудиофайл.

Действует только в том случае, если loop равно true.

Более удобный редактор для loop_offset представлен в диалоговом окне Расширенные параметры импорта, поскольку он позволяет предварительно просматривать изменения без необходимости повторного импорта аудио.


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

AudioStreamOggVorbis load_from_buffer(stream_data: PackedByteArray) static 🔗

Устарело: Use AudioStreamOggVorbis.load_from_buffer() instead.

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


AudioStreamOggVorbis load_from_file(path: String) static 🔗

Устарело: Use AudioStreamOggVorbis.load_from_file() instead.

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