AudioEffectRecord

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

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

    Methods

    • format

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

    Method Descriptions

    Returns the recorded sample.

    • is_recording_active ( ) const

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