Table of Contents

Class AudioEffectCapture

Captures audio from an audio bus in real-time.

Inheritance
AudioEffectCapture

Remarks

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 AudioEffectCapture.get_buffer and process it as needed, for example to capture data from an AudioStreamMicrophone, implement application-defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating-point PCM.

Unlike AudioEffectRecord, this effect only returns the raw audio samples instead of encoding them into an AudioStream.

See Also

Audio buses

Properties

buffer_length

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

var buffer_length : float = 0.1

Property Value

float

Remarks

  • void set_buffer_length(float value)
  • float get_buffer_length

Methods

can_get_buffer(int)

Qualifiers: const

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

bool can_get_buffer(int frames)

Parameters

frames int

clear_buffer

Clears the internal ring buffer.

Note: Calling this during a capture can cause the loss of samples which causes popping in the playback.

void clear_buffer

get_buffer(int)

Gets the next frames audio samples from the internal ring buffer.

Returns a PackedVector2Array containing exactly frames audio samples if available, or an empty PackedVector2Array if insufficient data was available.

The samples are signed floating-point PCM between -1 and 1. You will have to scale them if you want to use them as 8 or 16-bit integer samples. (v = 0x7fff * samples[0].x)

PackedVector2Array get_buffer(int frames)

Parameters

frames int

get_buffer_length_frames

Qualifiers: const

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

int get_buffer_length_frames

get_discarded_frames

Qualifiers: const

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

int get_discarded_frames

get_frames_available

Qualifiers: const

Returns the number of frames available to read using AudioEffectCapture.get_buffer.

int get_frames_available

get_pushed_frames

Qualifiers: const

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

int get_pushed_frames