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
Базовий клас для аудіопотоків.
Опис
Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via AudioStreamWAV), Ogg (via AudioStreamOggVorbis), and MP3 (via AudioStreamMP3) file formats.
Посібники
Методи
_get_bar_beats() virtual const |
|
_get_beat_count() virtual const |
|
_get_bpm() virtual const |
|
_get_length() virtual const |
|
_get_parameter_list() virtual const |
|
String |
_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 🔗
Перевизначте цей метод, щоб налаштувати значення, що повертається get_length(). Маєти повернути довжину цього аудіопотоку в секундах.
String _get_stream_name() virtual const 🔗
Перевизначте цей метод, щоб налаштувати назву, призначену цьому аудіопотоку. Не використовувався двигуном.
Dictionary _get_tags() virtual const 🔗
Перевизначте цей метод, щоб налаштувати теги для цього аудіопотоку. Повинен повертати Dictionary рядків з тегом як ключем та його вмістом як значенням.
Зазвичай використовуються такі теги: назва, виконавець, альбом, номер треку та дата.
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, якщо цей аудіопотік підтримує лише один канал (монофонія), або false, якщо аудіопотік підтримує два або більше каналів (* поліфонія*).