AudioEffectRecord

Inherits: AudioEffect < Resource < Reference < Object

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

Description

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.

Tutorials

• Recording with microphone

• Audio Mic Record Demo

Properties

Format

format

1

Methods

AudioStreamSample	get_recording ( ) const
bool	is_recording_active ( ) const
void	set_recording_active ( bool record )

---

Property Descriptions

Format format = 1

• void set_format ( Format value )

• Format get_format ( )

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

---

Method Descriptions

AudioStreamSample 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 )

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