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

AudioStreamPlayback

Успадковує: RefCounted < Object

Успадковано від: AudioStreamPlaybackInteractive, AudioStreamPlaybackPlaylist, AudioStreamPlaybackPolyphonic, AudioStreamPlaybackResampled, AudioStreamPlaybackSynchronized

Мета-клас для відтворення аудіо.

Опис

Може відтворювати, повторювати, призупиняти, прокручувати аудіо. Перегляньте AudioStream і AudioStreamOggVorbis для використання.

Посібники

Демонстрація аудіогенератора

Методи

int	_get_loop_count() virtual const
Variant	_get_parameter(name: StringName) virtual const
float	_get_playback_position() virtual required const
bool	_is_playing() virtual required const
int	_mix(buffer: `AudioFrame*`, rate_scale: float, frames: int) virtual required
void	_seek(position: float) virtual
void	_set_parameter(name: StringName, value: Variant) virtual
void	_start(from_pos: float) virtual required
void	_stop() virtual required
void	_tag_used_streams() virtual
int	get_loop_count() const
float	get_playback_position() const
AudioSamplePlayback	get_sample_playback() const
bool	is_playing() const
PackedVector2Array	mix_audio(rate_scale: float, frames: int)
void	seek(time: float = 0.0)
void	set_sample_playback(playback_sample: AudioSamplePlayback)
void	start(from_pos: float = 0.0)
void	stop()

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

int _get_loop_count() virtual const 🔗

Метод перевизначення. Має повернути, скільки разів цей аудіопотік зациклювався. Більшість вбудованих відтворень завжди повертають 0.

Variant _get_parameter(name: StringName) virtual const 🔗

Повертає поточне значення параметра відтворення за назвою (див. AudioStream._get_parameter_list()).

float _get_playback_position() virtual required const 🔗

Метод перевизначення. Повинен повертати поточний прогрес уздовж аудіопотоку в секундах.

bool _is_playing() virtual required const 🔗

Метод перевизначення. Має повертати true, якщо це відтворення активне та відтворює свій аудіопотік.

int _mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual required 🔗

Перевизначте цей метод, щоб налаштувати спосіб мікшування аудіопотоку. Цей метод викликається, навіть якщо відтворення не активне.

Примітка: Перевизначати цей метод у GDScript або C# не корисно. Тільки GDExtension може скористатися цим.

void _seek(position: float) virtual 🔗

Перевизначте цей метод, щоб налаштувати те, що відбувається під час пошуку цього аудіопотоку в заданому position, наприклад, шляхом виклику AudioStreamPlayer.seek().

void _set_parameter(name: StringName, value: Variant) virtual 🔗

Встановіть поточне значення параметра відтворення за назвою (див. AudioStream._get_parameter_list()).

void _start(from_pos: float) virtual required 🔗

Перевизначте цей метод, щоб налаштувати те, що відбувається, коли відтворення починається з заданої позиції, наприклад викликом AudioStreamPlayer.play().

void _stop() virtual required 🔗

Перевизначте цей метод, щоб налаштувати, що відбувається, коли відтворення зупиняється, наприклад викликом AudioStreamPlayer.stop().

void _tag_used_streams() virtual 🔗

Метод перевизначення. Викликається кожного разу, коли аудіопотік мікшується, якщо відтворення активне і AudioServer.set_enable_tagging_used_audio_streams() встановлено на true. Плагіни редактора можуть використовувати цей метод, щоб "тегувати" поточну позицію вздовж аудіопотоку та відображати її у попередньому перегляді.

int get_loop_count() const 🔗

Повертає кількість циклів потоку.

float get_playback_position() const 🔗

Повертає поточну позицію в потоці в секундах.

AudioSamplePlayback get_sample_playback() const 🔗

Експериментальний: Цей метод може бути змінений або усунутий у наступних версіях.

Повертає AudioSamplePlayback, пов’язаний із цим AudioStreamPlayback для відтворення зразка аудіо цього потоку.

bool is_playing() const 🔗

Повертає true, якщо потік відтворюється.

PackedVector2Array mix_audio(rate_scale: float, frames: int) 🔗

Змішує до frames аудіо з потоку з поточної позиції зі швидкістю rate_scale, просуваючи потік вперед.

Повертає PackedVector2Array, де кожен елемент містить рівні гучності лівого та правого каналів кожного кадру.

Примітка: може повернути менше кадрів, ніж запитувано, переконайтеся, що використовуєте розмір поверненого значення.

void seek(time: float = 0.0) 🔗

Шукає потік у заданому time у секундах.

void set_sample_playback(playback_sample: AudioSamplePlayback) 🔗

Експериментальний: Цей метод може бути змінений або усунутий у наступних версіях.

Пов’язує AudioSamplePlayback із цим AudioStreamPlayback для відтворення зразка аудіо цього потоку.

void start(from_pos: float = 0.0) 🔗

Початок потоку з указаного from_pos за секунди.

void stop() 🔗

Зупиняє потік.