diff options
| author | follower <follower@rancidbacon.com> | 2021-09-07 01:45:22 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-07 01:45:22 +1200 |
| commit | 022f49437b5d8ec4aa0b63f1561dd9aa253c895f (patch) | |
| tree | d3e848f694328274e32a4acc8df7c9863049f5f7 | |
| parent | 718221a2ffd75765d875623a4d3064e1e9120aae (diff) | |
Fix the "AudioEffectRecord" descriptions.
The `AudioEffectRecord` effect has no microphone capture-specific functionality--it can be used with any audio bus.
This patch attempts to clarify this fact (so people like me who want to capture audio output know they're in the right place) while still providing a pointer use of the effect with `AudioStreamMicrophone` for microphone capture.
| -rw-r--r-- | doc/classes/AudioEffectRecord.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index a217342d98..0823ce8561 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>https://docs.godotengine.org/en/latest/tutorials/audio/recording_with_microphone.html</link> |