From d800329d162701e127e8de4ca5ca0ad2391a83ad Mon Sep 17 00:00:00 2001 From: Lyuma Date: Thu, 28 Jan 2021 11:47:50 -0800 Subject: Add AudioEffectCapture AudioEffectCapture allows access to the microphone and other audio on an audio bus in real-time. Co-Authored-By: K. S. Ernest (iFire) Lee --- doc/classes/AudioEffectCapture.xml | 75 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 doc/classes/AudioEffectCapture.xml (limited to 'doc/classes') diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml new file mode 100644 index 0000000000..cf3d87c2e4 --- /dev/null +++ b/doc/classes/AudioEffectCapture.xml @@ -0,0 +1,75 @@ + + + + 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 [method get_buffer] and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. + + + + + + + + + + + Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. + + + + + + + Clears the internal ring buffer. + + + + + + + + + Gets the next [code]frames[/code] audio samples from the internal ring buffer. + Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. + + + + + + + Returns the total size of the internal ring buffer in frames. + + + + + + + Returns the number of audio frames discarded from the audio bus due to full buffer. + + + + + + + Returns the number of frames available to read using [method get_buffer]. + + + + + + + Returns the number of audio frames inserted from the audio bus. + + + + + + Length of the internal ring buffer, in seconds. + + + + + -- cgit v1.2.3