Class AudioEffectRecord
- Namespace
- Godot
- Assembly
- GodotSharp.dll
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.
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
Methods
GetRecording()
Returns the recorded sample.
public AudioStreamWav GetRecording()Returns
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
methodgodot_string_nameName of the method to check for.
Returns
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
signalgodot_string_nameName of the signal to check for.
Returns
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
methodgodot_string_nameName of the method to invoke.
argsNativeVariantPtrArgsArguments to use with the invoked method.
retgodot_variantValue returned by the invoked method.
Returns
IsRecordingActive()
Returns whether the recording is active or not.
public bool IsRecordingActive()Returns
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
recordbool