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

AudioStreamPlaybackPolyphonic

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

Примірник відтворення для AudioStreamPolyphonic.

Опис

Примірник відтворення для AudioStreamPolyphonic. Після встановлення властивості stream для AudioStreamPlayer, AudioStreamPlayer2D або AudioStreamPlayer3D екземпляр відтворення можна отримати шляхом виклику AudioStreamPlayer.get_stream_playback(), AudioStreamPlayer2D.get_stream_playback() або Методи AudioStreamPlayer3D.get_stream_playback().

Методи

bool	is_stream_playing(stream: int) const
int	play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master")
void	set_stream_pitch_scale(stream: int, pitch_scale: float)
void	set_stream_volume(stream: int, volume_db: float)
void	stop_stream(stream: int)

Константи

INVALID_ID = -1 🔗

Повертається play_stream(), якщо він не може виділити потік для відтворення.

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

bool is_stream_playing(stream: int) const 🔗

Повертає true, якщо потік, пов’язаний із вказаним цілим ідентифікатором, усе ще відтворюється. Перевірте play_stream(), щоб дізнатися, коли цей ідентифікатор стає недійсним.

int play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master") 🔗

Відтворення AudioStream із заданим зміщенням, гучністю, масштабом висоти, типом відтворення та шиною. Відтворення починається негайно.

Повернене значення — це унікальний цілочисельний ідентифікатор, пов’язаний із цим потоком відтворення та який можна використовувати для керування ним.

Цей ідентифікатор стає недійсним, коли потік закінчується (якщо він не зациклюється), коли AudioStreamPlaybackPolyphonic зупиняється або коли викликається stop_stream().

Ця функція повертає INVALID_ID, якщо кількість поточних потоків дорівнює AudioStreamPolyphonic.polyphony. Якщо вам потрібна більша кількість максимальної поліфонії, збільште це значення.

void set_stream_pitch_scale(stream: int, pitch_scale: float) 🔗

Змінити масштаб висоти потоку. Аргумент stream — це цілочисельний ідентифікатор, який повертає play_stream().

void set_stream_volume(stream: int, volume_db: float) 🔗

Змінити гучність потоку (в дБ). Аргумент stream — це цілочисельний ідентифікатор, який повертає play_stream().

void stop_stream(stream: int) 🔗

Зупинити потік. Аргумент stream — це цілочисельний ідентифікатор, повернутий play_stream(), який стає недійсним після виклику цієї функції.