AudioEffectRecord

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.

@GodotBaseClass

struct AudioEffectRecord {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AudioEffectRecord other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AudioEffectRecord _new();

AudioStreamSample.Format getFormat();

Ref!AudioStreamSample getRecording();

bool isRecordingActive();

void setFormat(long format);

void setRecordingActive(bool record);

AudioStreamSample.Format format [@property getter];

long format [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getFormat AudioStreamSample.Format getFormat()
getRecording Ref!AudioStreamSample getRecording(): Returns the recorded sample.
isRecordingActive bool isRecordingActive(): Returns whether the recording is active or not.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AudioEffectRecord other)
opEquals bool opEquals(typeof(null) n)
setFormat void setFormat(long format)
setRecordingActive void setRecordingActive(bool record): If true, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

format AudioStreamSample.Format format [@property getter]
long format [@property setter]: Specifies the format in which the sample will be recorded. See AudioStreamSample.format for available formats.

Static functions

_new AudioEffectRecord _new(): Construct a new instance of AudioEffectRecord. Note: use memnew!AudioEffectRecord instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

AudioEffectRecord

Members

Aliases

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

AudioEffectRecord

From mixin baseCasts

From `mixin baseCasts`