summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-06-10 07:45:12 +0200
committerGitHub <noreply@github.com>2022-06-10 07:45:12 +0200
commit9c1ead556999434ceb15c82b3dda9573c681b66a (patch)
tree7ba8c5928a871e7e996f97b547e89b039cab8f97 /doc/classes
parent174c769c615b4d03044567608b21b04f3ec3f573 (diff)
parenteb5a42d0bc28809f954861291c20d2ed6bed6d0f (diff)
Merge pull request #61865 from nikolawhallon/microphone-sample-format
added info on microphone sample format
Diffstat (limited to 'doc/classes')
-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>