Table of Contents

Class AudioEffectRecord

Namespace
Godot
Assembly
GodotSharp.dll

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

public class AudioEffectRecord : AudioEffect, IDisposable
Inheritance
AudioEffectRecord
Implements
Inherited Members

Constructors

AudioEffectRecord() 

public AudioEffectRecord()

Properties

Format

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

public AudioStreamWav.FormatEnum Format { get; set; }

Property Value

AudioStreamWav.FormatEnum

Methods

GetRecording()

Returns the recorded sample.

public AudioStreamWav GetRecording()

Returns

AudioStreamWav

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

IsRecordingActive()

Returns whether the recording is active or not.

public bool IsRecordingActive()

Returns

bool

SetRecordingActive(bool)

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

public void SetRecordingActive(bool record)

Parameters

record bool
Edit this page