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...
AudioStream
Eredita: Resource < RefCounted < Object
Ereditato da: AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV
Classe di base per i flussi audio.
Descrizione
Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via AudioStreamWAV), Ogg (via AudioStreamOggVorbis), and MP3 (via AudioStreamMP3) file formats.
Tutorial
Metodi
_get_bar_beats() virtual const |
|
_get_beat_count() virtual const |
|
_get_bpm() virtual const |
|
_get_length() virtual const |
|
_get_parameter_list() virtual const |
|
_get_stream_name() virtual const |
|
_get_tags() virtual const |
|
_has_loop() virtual const |
|
_instantiate_playback() virtual required const |
|
_is_monophonic() virtual const |
|
can_be_sampled() const |
|
generate_sample() const |
|
get_length() const |
|
is_meta_stream() const |
|
is_monophonic() const |
Segnali
parameter_list_changed() 🔗
Segnale da emettere per notificare quando la lista dei parametri è modificata.
Descrizioni dei metodi
int _get_bar_beats() virtual const 🔗
Sovrascrivi questo metodo per restituire i battiti per battuta di questo flusso.
int _get_beat_count() virtual const 🔗
Metodo sovrascivibile. Dovrebbe restituire il numero totale di battiti di questo flusso audio. Utilizzato dal motore per determinare la posizione di ogni battito.
Idealmente, il valore restituito dovrebbe essere basato sulla frequenza di campionamento del flusso (AudioStreamWAV.mix_rate, per esempio).
float _get_bpm() virtual const 🔗
Metodo sovrascivibile. Dovrebbe restituire il tempo di questo flusso audio, in battiti al minuto (BPM). Utilizzato dal motore per determinare la posizione di ogni battito.
Idealmente, il valore restituito dovrebbe essere basato sulla frequenza di campionamento del flusso (AudioStreamWAV.mix_rate, per esempio).
float _get_length() virtual const 🔗
Sovrascrivi questo metodo per personalizzare il valore restituito da get_length(). Dovrebbe restituire la durata di questo flusso audio, in secondi.
Array[Dictionary] _get_parameter_list() virtual const 🔗
Restituite i parametri controllabili di questo flusso. Questo array contiene dizionari con un formato di descrizione della proprietà (vedi Object.get_property_list()). Inoltre, un valore predefinito per questo parametro deve essere aggiunto a ogni dizionario nel campo "default_value".
String _get_stream_name() virtual const 🔗
Sovrascrivi questo metodo per personalizzare il nome assegnato a questo flusso audio. Non usato dal motore.
Dictionary _get_tags() virtual const 🔗
Sovrascrivi questo metodo per personalizzare i tag per questo flusso audio. Dovrebbe restituire un Dictionary di stringhe con il tag come chiave e il suo contenuto come valore.
I tag comunemente utilizzati includono title, artist, album, tracknumber e date.
bool _has_loop() virtual const 🔗
Sovrascrivi questo metodo per restituire true se questo flusso si ripete.
AudioStreamPlayback _instantiate_playback() virtual required const 🔗
Sovrascrivi questo metodo per personalizzare il valore restituito da instantiate_playback(). Dovrebbe restituire un nuovo AudioStreamPlayback creato quando il flusso viene riprodotto (come da un AudioStreamPlayer.
bool _is_monophonic() virtual const 🔗
Sovrascrivi questo metodo per personalizzare il valore restituito da is_monophonic(). Dovrebbe restituire true se questo flusso audio supporta solo un canale.
Sperimentale: Questo metodo potrebbe essere cambiato o rimosso in versioni future.
Restituisce se l'AudioStream attuale può essere utilizzato come campione. Solo i flussi statici possono essere campionati.
AudioSample generate_sample() const 🔗
Sperimentale: Questo metodo potrebbe essere cambiato o rimosso in versioni future.
Genera un AudioSample basato sul flusso attuale.
Restituisce la durata del flusso audio in secondi. Se questo flusso è un AudioStreamRandomizer, restituisce la durata dell'ultimo flusso riprodotto. Se questo flusso ha una lunghezza indefinita (ad esempio per AudioStreamGenerator e AudioStreamMicrophone), restituisce 0.0.
AudioStreamPlayback instantiate_playback() 🔗
Restituisce un AudioStreamPlayback nuovamente creato, a scopo di riprodurre questo flusso audio. Utile per quando si desidera estendere _instantiate_playback() ma chiamando instantiate_playback() da una sotto-risorsa AudioStream mantenuta internamente. È possibile trovare un esempio al riguardo nel codice sorgente per AudioStreamRandomPitch::instantiate_playback.
Restituisce true se il flusso è una collezione di altri flussi, altrimenti false.
Restituisce true se questo flusso audio supporta solo un canale (monofonia), o false se il flusso audio supporta due o più canali (polifonia).