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...

AudioStreamWAV

Hérite de : AudioStream < Resource < RefCounted < Object

Enregistre les données audio depuis les fichiers WAV.

Description

AudioStreamSample stocke des échantillons sonores chargés depuis des fichiers WAV. Pour jouer le son enregistré, utilisez un AudioStreamPlayer (pour de l'audio indépendant de la position) ou AudioStreamPlayer2D/AudioStreamPlayer3D (pour de l'audio dépendant de la positions). Le son peut être bouclé.

Cette classe peut également être utilisée pour stocker des données audio générées dynamiquement au format PCM. Voir aussi AudioStreamGenerator pour la génération audio procédurale.

Tutoriels

Propriétés

PackedByteArray

data

PackedByteArray()

Format

format

0

int

loop_begin

0

int

loop_end

0

LoopMode

loop_mode

0

int

mix_rate

44100

bool

stereo

false

Dictionary

tags

{}

Méthodes

AudioStreamWAV

load_from_buffer(stream_data: PackedByteArray, options: Dictionary = {}) static

AudioStreamWAV

load_from_file(path: String, options: Dictionary = {}) static

Error

save_to_wav(path: String)

Énumérations

enum Format: 🔗

Format FORMAT_8_BITS = 0

Codec audio 8 bits PCM.

Format FORMAT_16_BITS = 1

Codec audio 16 bits PCM.

Format FORMAT_IMA_ADPCM = 2

L'audio est compressé avec perte en IMA ADPCM.

Format FORMAT_QOA = 3

L'audio est compressé avec perte au format Quite OK Audio.

enum LoopMode: 🔗

LoopMode LOOP_DISABLED = 0

L'audio ne boucle pas.

LoopMode LOOP_FORWARD = 1

L'audio boucle entre loop_begin et loop_end, ne jouant qu'en avant.

LoopMode LOOP_PINGPONG = 2

Les données audio bouclent entre loop_begin et loop_end, jouant en arrière puis en avant.

LoopMode LOOP_BACKWARD = 3

L'audio boucle entre loop_begin et loop_end, ne jouant qu'en arrière.

Descriptions des propriétés

PackedByteArray data = PackedByteArray() 🔗

Contient les données audio en octets.

Note : Si format est défini à FORMAT_8_BITS, cette propriété s'attend à des données PCM signées 8 bits. Pour convertir des PCM 8 bits non signés, soustraire 128 à chaque octet.

Note : Si format est défini à FORMAT_QOA, cette propriété s'attend à des données d'un fichier QOA complet.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedByteArray for more details.

Format format = 0 🔗

Format audio.

int loop_begin = 0 🔗

  • void set_loop_begin(value: int)

  • int get_loop_begin()

Le point de départ de la boucle (en nombre d’échantillons, relatif au début du flux).

int loop_end = 0 🔗

  • void set_loop_end(value: int)

  • int get_loop_end()

Le point de fin de la boucle (en nombre d’échantillons, relatif au début du flux).

LoopMode loop_mode = 0 🔗

Le mode de boucle.

int mix_rate = 44100 🔗

  • void set_mix_rate(value: int)

  • int get_mix_rate()

Le taux d'échantillonnage pour mélanger ce son. Les valeurs plus élevées nécessitent plus d'espace de stockage, mais proposent une meilleure qualité.

Dans les jeux, les taux d'échantillonnage courants sont 11025, 16000, 22050, 32000, 44100, et 48000.

D'après le Théorème d'échantillonnage, il n'y a aucune différence de qualité pour l'audition humaine au-delà de 40 000 Hz (puisque la plupart des humains ne peuvent entendre que jusqu'à 20 000 Hz, et souvent bien moins). Si vous générez des sons inférieurs tels que les voix, des taux d'échantillonnage inférieurs tels que 32000 ou 22050 peuvent être utilisables sans perte de qualité audible.

bool stereo = false 🔗

  • void set_stereo(value: bool)

  • bool is_stereo()

Si true, l’audio est stéréo.

Dictionary tags = {} 🔗

Contient des étiquettes définies par l'utilisateur si elles sont trouvées dans les données WAV.

Les étiquettes couramment utilisées incluent title, artist, album, tracknumber, et date (date n'a pas un format de date standard).

Note : Aucune étiquette n'est garantie d'être présente dans chaque fichier, alors assurez-vous de tenir compte des clés qui n'existent pas toujours.

Note : Seuls les fichiers WAV utilisant un chunk LIST avec un identifiant INFO pour encoder les étiquettes sont actuellement supportés.

Descriptions des méthodes

AudioStreamWAV load_from_buffer(stream_data: PackedByteArray, options: Dictionary = {}) static 🔗

Crée une nouvelle instance AudioStreamWAV depuis le tampon donné. Le tampon doit contenir des données WAV.

Les clés et les valeurs de options correspondent aux propriétés de ResourceImporterWAV. L'utilisation de options est identique à load_from_file().

AudioStreamWAV load_from_file(path: String, options: Dictionary = {}) static 🔗

Crée une nouvelle instance AudioStreamWAV depuis le chemin de fichier donné. Le fichier doit être en format WAV.

Les clés et les valeurs de options correspondent aux propriétés de ResourceImporterWAV.

Exemple : Charger le premier fichier déposé en WAV et le jouer :

@onready var lecteur_audio = $AudioStreamPlayer

func _ready():
    get_window().files_dropped.connect(_lorsque_fichier_depose)

func _lorsque_fichier_depose(fichiers):
    if fichiers[0].get_extension() == "wav":
        lecteur_audio.stream = AudioStreamWAV.load_from_file(fichiers[0], {
                "force/max_rate": true,
                "force/max_rate_hz": 11025
            })
        lecteur_audio.play()

Error save_to_wav(path: String) 🔗

Enregistre l'AudioStreamWAV en un fichier WAV à l'emplacement path. Les échantillons au format IMA ADPCM ou Quite OK Audio ne peuvent pas être enregistrés.

Note : Une extension .wav est automatiquement ajoutée au path si elle est manquante.