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
Hérite de : Resource < RefCounted < Object
Hérité par : AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV
Classe de base pour les flux audio.
Description
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.
Tutoriels
Méthodes
_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 |
Signaux
parameter_list_changed() 🔗
Signal à émettre pour notifier lorsque la liste des paramètres a changé.
Descriptions des méthodes
int _get_bar_beats() virtual const 🔗
Surchargez cette méthode pour renvoyer les battements par mesure de ce flux.
int _get_beat_count() virtual const 🔗
Méthode surchargeable. Devrait renvoyer le nombre total de battements de ce flux audio. Utilisé par le moteur pour déterminer la position de chaque battement.
Idéalement, la valeur renvoyée devrait être basée sur le taux d'échantillonnage du flux (AudioStreamWAV.mix_rate, par exemple).
float _get_bpm() virtual const 🔗
Méthode surchargeable. Devrait renvoyer le tempo de ce flux audio, en battements par minute (BPM). Utilisé par le moteur pour déterminer la position de chaque battement.
Idéalement, la valeur renvoyée devrait être basée sur le taux d'échantillonnage du flux (AudioStreamWAV.mix_rate, par exemple).
float _get_length() virtual const 🔗
Surchargez cette méthode pour personnaliser la valeur renvoyée de get_length(). Doit renvoyer la longueur de ce flux audio, en secondes.
Array[Dictionary] _get_parameter_list() virtual const 🔗
Renvoie les paramètres contrôlables de ce flux. Ce tableau contient des dictionnaires avec un format de description d'infos de propriété (voir Object.get_property_list()). De plus, la valeur par défaut pour ce paramètre doit être ajoutée à chaque dictionnaire dans le champ "default_value".
String _get_stream_name() virtual const 🔗
Surchargez cette méthode pour personnaliser le nom assigné à ce flux audio. Inutilisé par le moteur.
Dictionary _get_tags() virtual const 🔗
Surchargez cette méthode pour personnaliser les tags pour ce flux audio. Doit renvoyer un Dictionary de chaînes avec le tag comme clé et son contenu comme la valeur.
Les tags couramment utilisés incluent title, artist, album, tracknumber, et date.
bool _has_loop() virtual const 🔗
Surchargez cette méthode pour renvoyer true si ce flux a une boucle.
AudioStreamPlayback _instantiate_playback() virtual required const 🔗
Surchargez cette méthode pour personnaliser la valeur renvoyée de instantiate_playback(). Doit renvoyer un nouveau AudioStreamPlayback créé lorsque le flux est joué (comme avec un AudioStreamPlayer).
bool _is_monophonic() virtual const 🔗
Surchargez cette méthode pour personnaliser la valeur renvoyée de is_monophonic(). Doit renvoyer true si ce flux audio ne supporte qu'un seul canal.
Expérimental : Cette méthode peut être changée ou retirée dans de futures versions.
Renvoie si l'AudioStream courant peut être utilisé comme échantillon. Seuls les flux statiques peuvent être échantillonnés.
AudioSample generate_sample() const 🔗
Expérimental : Cette méthode peut être changée ou retirée dans de futures versions.
Génère un AudioSample basé sur le flux courant.
Renvoie la longueur du flux audio en secondes. Si ce flux est un AudioStreamRandomizer, renvoie la longueur du dernier flux joué. Si ce flux a une longueur indéfinie (comme pour AudioStreamGenerator et AudioStreamMicrophone), renvoie 0.0.
AudioStreamPlayback instantiate_playback() 🔗
Renvoie un AudioStreamPlayback nouvellement créé destiné à jouer ce flux audio. Utile pour quand vous voulez étendre _instantiate_playback() mais appeler instantiate_playback() d'une sous-ressource AudioStream détenue en interne. Un exemple de cela se trouve dans le code source de AudioStreamRandomPitch::instantiate_playback.
Renvoie true si le flux est une collection d'autres flux, false sinon.
Renvoie true si ce flux audio ne supporte qu'un canal (monophonie), ou false si le flux audio prend en charge deux ou plusieurs canaux (polyphonique).