Merge pull request #52441 from follower/patch-16

Fix the "AudioEffectRecord" descriptions.
This commit is contained in:
Max Hilbrunner 2022-01-07 10:30:10 +01:00 committed by GitHub
commit a1ea8976f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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>