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

Hérite de : AudioStreamPlayback < RefCounted < Object

Instance de lecture pour AudioStreamPolyphonic.

Description

Instance de lecture pour AudioStreamPolyphonic. Après avoir paramétré la propriété stream d'AudioStreamPlayer, AudioStreamPlayer2D, ou AudioStreamPlayer3D, l'instance de lecture peut être obtenue en appelant les méthodes AudioStreamPlayer.get_stream_playback(), AudioStreamPlayer2D.get_stream_playback() ou AudioStreamPlayer3D.get_stream_playback().

Méthodes

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)

Constantes

INVALID_ID = -1 🔗

Renvoyé par play_stream() au cas où il ne pouvait pas allouer un flux pour la lecture.

Descriptions des méthodes

bool is_stream_playing(stream: int) const 🔗

Renvoie true si le flux associé à l'identifiant entier donné joue encore. Vérifiez play_stream() pour obtenir l'information sur quand cette ID devient invalide.

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") 🔗

Joue un AudioStream à un décalage, volume, échelle de pitch, type de lecture et bus donnés. La lecture commence immédiatement.

La valeur renvoyée est un identifiant entier unique qui est associé à ce flux de lecture et qui peut être utilisée pour le contrôler.

Cet ID devient invalide lorsque le flux se termine (s'il ne boucle pas), lorsque le AudioStreamPlaybackPolyphonic est arrêté, ou lorsque stop_stream() est appelée.

Cette fonction renvoie INVALID_ID si la quantité de flux jouant actuellement est égale à AudioStreamPolyphonic.polyphony. Si vous avez besoin d'une quantité supérieure de polyphonie maximale, augmentez cette valeur.

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

Change l'échelle de la hauteur du flux. L'argument stream est un ID entier renvoyé par play_stream().

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

Change le volume du flux (en db). L'argument stream est un ID entier renvoyé par play_stream().

void stop_stream(stream: int) 🔗

Arrête un flux. L'argument stream est un ID entier renvoyé par play_stream(), qui devient invalide après avoir appelé cette fonction.