Class reference
AudioEffectRecord
Inherits AudioEffect
Audio effect used for recording the sound from an audio bus.
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 Redot. 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.
Properties
int format = 1
int format = 1Specifies the format in which the sample will be recorded.
Methods
AudioStreamWAV get_recording() const
AudioStreamWAV get_recording() constReturns the recorded sample.
bool is_recording_active() const
bool is_recording_active() constReturns whether the recording is active or not.
void set_recording_active(bool record)
bool record)If true, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.