summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Hilbrunner <mhilbrunner@users.noreply.github.com>2022-01-07 10:30:10 +0100
committerGitHub <noreply@github.com>2022-01-07 10:30:10 +0100
commita1ea8976f3ed820d0ee8740023a4fa861efda6ba (patch)
treee1a147465a1598040071b1e56cc61f86f8667ace
parent7cb0f9d07901f37187ce6695aedd2546b022c2d4 (diff)
parent022f49437b5d8ec4aa0b63f1561dd9aa253c895f (diff)
Merge pull request #52441 from follower/patch-16
Fix the "AudioEffectRecord" descriptions.
-rw-r--r--doc/classes/AudioEffectRecord.xml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml
index 0b6c5287cf..d523472b8e 100644
--- a/doc/classes/AudioEffectRecord.xml
+++ b/doc/classes/AudioEffectRecord.xml
@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectRecord" inherits="AudioEffect" version="4.0">
<brief_description>
- Audio effect used for recording sound from a microphone.
+ Audio effect used for recording the sound from an audio bus.
</brief_description>
<description>
- Allows the user to record sound from a microphone. It sets and gets the format in which the audio file will be recorded (8-bit, 16-bit, or compressed). It checks whether or not the recording is active, and if it is, records the sound. It then returns the recorded sample.
+ Allows the user to record the sound from an audio bus. This can include all audio output by Godot when used on the "Master" audio bus.
+ Can be used (with an [AudioStreamMicrophone]) to record from a microphone.
+ It sets and gets the format in which the audio file will be recorded (8-bit, 16-bit, or compressed). It checks whether or not the recording is active, and if it is, records the sound. It then returns the recorded sample.
</description>
<tutorials>
<link title="Recording with microphone">$DOCS_URL/tutorials/audio/recording_with_microphone.html</link>