Table of Contents

Class AudioEffectRecord

Audio effect used for recording the sound from an audio bus.

Inheritance
AudioEffectRecord

Remarks

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

See Also

Recording with microphone
Audio Microphone Record Demo

Properties

format

Specifies the format in which the sample will be recorded. See Format for available formats.

var format : int = 1

Property Value

int

Remarks

  • void set_format(int value)
  • int get_format

Methods

get_recording

Qualifiers: const

Returns the recorded sample.

AudioStreamWAV get_recording

is_recording_active

Qualifiers: const

Returns whether the recording is active or not.

bool is_recording_active

set_recording_active(bool)

If true, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.

void set_recording_active(bool record)

Parameters

record bool