asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #84584 from mutantbob/capture-doc

Browse source 
Add details about `AudioEffectCapture.clear_buffer()` and `get_buffer()`
This commit is contained in:
Rémi Verschelde 2024-02-21 15:22:39 +01:00
commit 14a05f0e84
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/AudioEffectCapture.xml
View file

@ -5,7 +5,7 @@
</brief_description> </brief_description>
<description> <description>
AudioEffectCapture is an AudioEffect which copies all audio frames from the attached audio effect bus into its internal ring buffer. 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 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. 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 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]. Unlike [AudioEffectRecord], this effect only returns the raw audio samples instead of encoding them into an [AudioStream].
</description> </description>
<tutorials> <tutorials>
@ -23,6 +23,7 @@
<return type="void" /> <return type="void" />
<description> <description>
Clears the internal ring buffer. Clears the internal ring buffer.
[b]Note:[/b] Calling this during a capture can cause the loss of samples which causes popping in the playback.
</description> </description>
</method> </method>
<method name="get_buffer"> <method name="get_buffer">
@ -31,6 +32,7 @@
<description> <description>
Gets the next [param frames] audio samples from the internal ring buffer. Gets the next [param frames] audio samples from the internal ring buffer.
Returns a [PackedVector2Array] containing exactly [param frames] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. Returns a [PackedVector2Array] containing exactly [param frames] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available.
The samples are signed floating-point PCM between [code]-1[/code] and [code]1[/code]. You will have to scale them if you want to use them as 8 or 16-bit integer samples. ([code]v = 0x7fff * samples[0].x[/code])
</description> </description>
</method> </method>
<method name="get_buffer_length_frames" qualifiers="const"> <method name="get_buffer_length_frames" qualifiers="const">