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(), который становится недействительным после вызова этой функции.