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...
AudioStream
Наследует: Resource < RefCounted < Object
Наследуется от: AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV
Базовый класс для аудиопотоков.
Описание
Базовый класс для аудиопотоков. Аудиопотоки используются для воспроизведения звуковых эффектов и музыки и поддерживают форматы файлов WAV (через AudioStreamWAV), Ogg (через AudioStreamOggVorbis) и MP3 (через AudioStreamMP3).
Обучающие материалы
Методы
_get_bar_beats() virtual const |
|
_get_beat_count() virtual const |
|
_get_bpm() virtual const |
|
_get_length() virtual const |
|
_get_parameter_list() virtual const |
|
_get_stream_name() virtual const |
|
_get_tags() virtual const |
|
_has_loop() virtual const |
|
_instantiate_playback() virtual required const |
|
_is_monophonic() virtual const |
|
can_be_sampled() const |
|
generate_sample() const |
|
get_length() const |
|
is_meta_stream() const |
|
is_monophonic() const |
Сигналы
parameter_list_changed() 🔗
Сигнал, который будет подаваться для уведомления об изменении списка параметров.
Описания метода
int _get_bar_beats() virtual const 🔗
Переопределите этот метод, чтобы вернуть тактовые доли этого потока.
int _get_beat_count() virtual const 🔗
Переопределяемый метод. Должен возвращать общее количество тактов этого аудиопотока. Используется движком для определения позиции каждого такта.
В идеале возвращаемое значение должно основываться на частоте дискретизации потока (например, AudioStreamWAV.mix_rate).
float _get_bpm() virtual const 🔗
Переопределяемый метод. Должен возвращать темп этого аудиопотока в ударах в минуту (BPM). Используется движком для определения позиции каждого удара.
В идеале возвращаемое значение должно основываться на частоте дискретизации потока (например, AudioStreamWAV.mix_rate).
float _get_length() virtual const 🔗
Переопределите этот метод, чтобы настроить возвращаемое значение get_length(). Должен возвращать длину этого аудиопотока в секундах.
Array[Dictionary] _get_parameter_list() virtual const 🔗
Верните контролируемые параметры этого потока. Этот массив содержит словари с форматом описания информации о свойствах (см. Object.get_property_list()). Кроме того, значение по умолчанию для этого параметра должно быть добавлено в каждый словарь в поле "default_value".
String _get_stream_name() virtual const 🔗
Переопределите этот метод, чтобы настроить имя, назначенное этому аудиопотоку. Не используется движком.
Dictionary _get_tags() virtual const 🔗
Переопределите этот метод, чтобы настроить теги для этого аудиопотока. Должен возвращать Dictionary строк с тегом в качестве ключа и его содержимым в качестве значения.
Обычно используемые теги включают title, artist, album, tracknumber и date.
bool _has_loop() virtual const 🔗
Переопределите этот метод, чтобы он возвращал true, если этот поток имеет зацикленность.
AudioStreamPlayback _instantiate_playback() virtual required const 🔗
Переопределите этот метод, чтобы настроить возвращаемое значение instantiate_playback(). Должен возвращать новый AudioStreamPlayback, созданный при воспроизведении потока (например, AudioStreamPlayer).
bool _is_monophonic() virtual const 🔗
Переопределите этот метод, чтобы настроить возвращаемое значение is_monophonic(). Должен возвращать true, если этот аудиопоток поддерживает только один канал.
Экспериментальное: Этот метод может быть изменён или удалён в будущих версиях.
Возвращает, если текущий AudioStream может быть использован в качестве образца. Только статические потоки могут быть сэмплированы.
AudioSample generate_sample() const 🔗
Экспериментальное: Этот метод может быть изменён или удалён в будущих версиях.
Генерирует AudioSample на основе текущего потока.
Возвращает длительность аудиопотока в секундах. Если этот поток является AudioStreamRandomizer, возвращает длительность последнего воспроизведенного потока. Если длительность потока не определена (например, для AudioStreamGenerator и AudioStreamMicrophone), возвращает 0.0.
AudioStreamPlayback instantiate_playback() 🔗
Возвращает недавно созданный AudioStreamPlayback, предназначенный для воспроизведения этого аудиопотока. Полезно, когда вы хотите расширить _instantiate_playback(), но вызвать instantiate_playback() из внутреннего подресурса AudioStream. Пример этого можно найти в исходном коде для AudioStreamRandomPitch::instantiate_playback.
Возвращает true, если поток является набором других потоков, и false в противном случае.
Возвращает true, если этот аудиопоток поддерживает только один канал (монофония (monophony)), или false, если аудиопоток поддерживает два или более каналов (полифония (polyphony)).