/Godot 3.2


Inherits: AudioEffect < Resource < Reference < Object

Audio effect used for recording sound from a microphone.


Allows the user to record sound 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.



Format format 1


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

Property Descriptions

Format format

Default 1
Setter set_format(value)
Getter 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.

© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.