AudioStreamPlaybackPolyphonic

Eredita: AudioStreamPlayback < RefCounted < Object

Istanza di riproduttore per AudioStreamPolyphonic.

Descrizione

Istanza di riproduttore per AudioStreamPolyphonic. Dopo aver impostato la proprietà stream di AudioStreamPlayer, AudioStreamPlayer2D, o AudioStreamPlayer3D, l'istanza del riproduttore può essere ottenuta chiamando i metodi AudioStreamPlayer.get_stream_playback(), AudioStreamPlayer2D.get_stream_playback() o AudioStreamPlayer3D.get_stream_playback().

Metodi

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)

Costanti

INVALID_ID = -1 🔗

Restituito da play_stream() nel caso in cui non sia possibile allocare un flusso per la riproduzione.

Descrizioni dei metodi

bool is_stream_playing(stream: int) const 🔗

Restituisce true se il flusso associato a l'ID intero fornito è ancora in riproduzione. Consulta play_stream() per informazioni su quando questo ID diventa non valido.

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

Riproduce un AudioStream a un determinato offset, volume, scala di tono, tipo di riproduzione e bus. La riproduzione inizia immediatamente.

Il valore restituito è un ID intero univoco associato a questo flusso di riproduzione e che può essere utilizzato per controllarlo.

Questo ID diventa non valido quando il flusso termina (se non è in ripetizione), quando AudioStreamPlaybackPolyphonic viene interrotto o quando viene chiamato stop_stream().

Questa funzione restituisce INVALID_ID se la quantità di flussi attualmente in riproduzione è uguale a AudioStreamPolyphonic.polyphony. Se si necessita di una maggiore quantità di polifonia massima, aumenta questo valore.

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

Cambia la scala del tono del flusso. L'argomento stream è un ID intero restituito da play_stream().

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

Cambia il volume (in db) del flusso. L'argomento stream è un ID intero restituito da play_stream().

void stop_stream(stream: int) 🔗

Interrompe un flusso. L'argomento stream è un ID intero restituito da play_stream(), che diventa non valido dopo aver chiamato questa funzione.