summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNikola Whallon <browncanstudios@gmail.com>2022-06-09 14:01:38 -0700
committerNikola Whallon <browncanstudios@gmail.com>2022-06-09 14:01:38 -0700
commiteb5a42d0bc28809f954861291c20d2ed6bed6d0f (patch)
tree6db6f487fa829a405eff88f1d7b1529f3d9c2698 /doc
parentd120b099f528673fb6aebaa5d9cff0fa91a774d0 (diff)
added info on microphone sample format
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/AudioEffectCapture.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml
index 5ab4403be5..7a7f1f8e8a 100644
--- a/doc/classes/AudioEffectCapture.xml
+++ b/doc/classes/AudioEffectCapture.xml
@@ -5,7 +5,7 @@
</brief_description>
<description>
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.
+ 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. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM.
</description>
<tutorials>
</tutorials>