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.

AudioStreamPlayback

Eredita: RefCounted < Object

Ereditato da: AudioStreamPlaybackInteractive, AudioStreamPlaybackPlaylist, AudioStreamPlaybackPolyphonic, AudioStreamPlaybackResampled, AudioStreamPlaybackSynchronized

Classe meta per la riproduzione audio.

Descrizione

Può riprodurre, ripetere, mettere in pausa uno scorrimento attraverso l'audio. Vedi AudioStream e AudioStreamOggVorbis per l'uso.

Tutorial

Metodi

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()


Descrizioni dei metodi

int _get_loop_count() virtual const 🔗

Metodo sovrascrivibile. Dovrebbe restituire quante volte questo flusso audio si è ripetuto. La maggior parte dei riproduttori integrati restituiscono sempre 0.


Variant _get_parameter(name: StringName) virtual const 🔗

Restituisce il valore attuale di un parametro di riproduzione per nome (vedi AudioStream._get_parameter_list()).


float _get_playback_position() virtual required const 🔗

Metodo sovrascrivibile. Dovrebbe restituire il progresso attuale lungo il flusso audio, in secondi.


bool _is_playing() virtual required const 🔗

Metodo sovrascrivibile. Dovrebbe restituire true se questo riproduttore è attivo e sta riproducendo il suo flusso audio.


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

Sovrascrivi questo metodo per personalizzare come il flusso audio è mixato. Questo metodo viene chiamato anche se il riproduttore non è attivo.

Nota: Non è utile sovrascrivere questo metodo in GDScript o C#. Solo GDExtension può usufruirne.


void _seek(position: float) virtual 🔗

Sovrascrivi questo metodo per personalizzare cosa succede quando cerchi questo flusso audio alla posizione position specificata, ad esempio chiamando AudioStreamPlayer.seek().


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

Imposta il valore attuale di un parametro di riproduzione per nome (vedi AudioStream._get_parameter_list()).


void _start(from_pos: float) virtual required 🔗

Sovrascrivi questo metodo per personalizzare cosa succede quando la riproduzione inizia nella posizione specificata, ad esempio chiamando AudioStreamPlayer.play().


void _stop() virtual required 🔗

Sovrascrivi questo metodo per personalizzare cosa succede quando la riproduzione è interrotta, ad esempio chiamando AudioStreamPlayer.stop().


void _tag_used_streams() virtual 🔗

Metodo sovrascrivibile. Chiamato ogni volta che il flusso audio viene mixato se la riproduzione è attiva e AudioServer.set_enable_tagging_used_audio_streams() è stato impostato su true. I plugin dell'editor possono utilizzare questo metodo per "taggare" la posizione corrente lungo il flusso audio e visualizzarla in un'anteprima.


int get_loop_count() const 🔗

Restituisce il numero di volte che il flusso si è ripetuto.


float get_playback_position() const 🔗

Restituisce la posizione attuale nel flusso, in secondi.


AudioSamplePlayback get_sample_playback() const 🔗

Sperimentale: Questo metodo potrebbe essere cambiato o rimosso in versioni future.

Restituisce l'AudioSamplePlayback associato a questo AudioStreamPlayback per riprodurre il campione audio di questo flusso.


bool is_playing() const 🔗

Restituisce true se il flusso è in riproduzione.


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

Mixa fino a frames frame di audio dal flusso dalla posizione attuale, a una velocità di rate_scale, facendo avanzare il flusso.

Restituisce un PackedVector2Array in cui ogni elemento contiene i livelli del volume del canale sinistro e destro di ogni frame.

Nota: Può restituire meno frame di quelli richiesti, assicurati di usare la dimensione del valore restituito.


void seek(time: float = 0.0) 🔗

Cerca il flusso al tempo time, in secondi.


void set_sample_playback(playback_sample: AudioSamplePlayback) 🔗

Sperimentale: Questo metodo potrebbe essere cambiato o rimosso in versioni future.

Associa l'AudioSamplePlayback a questo AudioStreamPlayback per riprodurre il campione audio di questo flusso.


void start(from_pos: float = 0.0) 🔗

Avvia il flusso dalla posizione from_pos, in secondi.


void stop() 🔗

Arresta il flusso.