AudioEffectCapture

Captures audio from an audio bus in real-time.

AudioEffectCapture is an AudioEffect which copies all audio frames from the attached audio effect bus into its internal ring buffer. Application code should consume these audio frames from this ring buffer using getBuffer and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network.

Members

Aliases

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

Functions

canGetBuffer
bool canGetBuffer(long frames)

Returns true if at least frames audio frames are available to read in the internal ring buffer.

clearBuffer
void clearBuffer()

Clears the internal ring buffer.

getBuffer
PoolVector2Array getBuffer(long frames)

Gets the next frames audio samples from the internal ring buffer. Returns a PoolVector2Array containing exactly frames audio samples if available, or an empty PoolVector2Array if insufficient data was available.

getBufferLength
double getBufferLength()
getBufferLengthFrames
long getBufferLengthFrames()

Returns the total size of the internal ring buffer in frames.

getDiscardedFrames
long getDiscardedFrames()

Returns the number of audio frames discarded from the audio bus due to full buffer.

getFramesAvailable
long getFramesAvailable()

Returns the number of frames available to read using getBuffer.

getPushedFrames
long getPushedFrames()

Returns the number of audio frames inserted from the audio bus.

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(AudioEffectCapture other)
opEquals
bool opEquals(typeof(null) n)
setBufferLength
void setBufferLength(double buffer_length_seconds)
toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

bufferLength
double bufferLength [@property getter]
double bufferLength [@property setter]

Length of the internal ring buffer, in seconds. Setting the buffer length will have no effect if already initialized.

Static functions

_new
AudioEffectCapture _new()

Construct a new instance of AudioEffectCapture. Note: use memnew!AudioEffectCapture 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.

Meta