Browse Source

Merge pull request #52441 from follower/patch-16

Fix the "AudioEffectRecord" descriptions.
Max Hilbrunner 3 years ago
parent
commit
a1ea8976f3
1 changed files with 4 additions and 2 deletions
  1. 4 2
      doc/classes/AudioEffectRecord.xml

+ 4 - 2
doc/classes/AudioEffectRecord.xml

@@ -1,10 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectRecord" inherits="AudioEffect" version="4.0">
 <class name="AudioEffectRecord" inherits="AudioEffect" version="4.0">
 	<brief_description>
 	<brief_description>
-		Audio effect used for recording sound from a microphone.
+		Audio effect used for recording the sound from an audio bus.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<tutorials>
 	<tutorials>
 		<link title="Recording with microphone">$DOCS_URL/tutorials/audio/recording_with_microphone.html</link>
 		<link title="Recording with microphone">$DOCS_URL/tutorials/audio/recording_with_microphone.html</link>