Attention: Here be dragons
This is the
(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...
Inherits: AudioEffect < Resource < RefCounted < Object
Audio effect used for recording the sound from an audio bus.
Allows the user to record the sound from an audio bus. This can include all audio output by Godot when used on the "Master" audio bus.
Can be used (with an AudioStreamMicrophone) to record from a microphone.
It sets and gets the format in which the audio file will be recorded (8-bit, 16-bit, or compressed). It checks whether or not the recording is active, and if it is, records the sound. It then returns the recorded sample.
get_recording ( ) const
is_recording_active ( ) const
set_recording_active ( bool record )
Format format =
Specifies the format in which the sample will be recorded. See Format for available formats.
AudioStreamWAV get_recording ( ) const
Returns the recorded sample.
bool is_recording_active ( ) const
Returns whether the recording is active or not.
void set_recording_active ( bool record )
true, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.