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

  Methods

  Property Descriptions

• Format format 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.

• set_recording_active ( bool record ) true, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.