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.

AudioEffectRecord

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

L'effet audio utilisé pour l'enregistrement des sons venants d'un bus audio.

Description

Allows the user to record the sound from an audio bus into an AudioStreamWAV. When used on the Master audio bus, this includes all audio output by Godot.

Unlike AudioEffectCapture, this effect encodes the recording with the given format (8-bit, 16-bit, or compressed) instead of giving access to the raw audio samples.

Can be used (with an AudioStreamMicrophone) to record from a microphone.

Note: ProjectSettings.audio/driver/enable_input must be true for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.

Tutoriels

Propriétés

Format

format

1

Méthodes

AudioStreamWAV

get_recording() const

bool

is_recording_active() const

void

set_recording_active(record: bool)


Descriptions des propriétés

Format format = 1 🔗

Spécifie le format dans lequel l'échantillon sera enregistré.


Descriptions des méthodes

AudioStreamWAV get_recording() const 🔗

Renvoie l’échantillon enregistré.


bool is_recording_active() const 🔗

Renvoie si l'enregistrement est actif ou non.


void set_recording_active(record: bool) 🔗

Si true, le son sera enregistré. Notez que le redémarrage de l'enregistrement supprimera l'échantillon précédemment enregistré.