Fix the "AudioEffectRecord" descriptions.

[follower]

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 to use of the effect with AudioStreamMicrophone for microphone capture.

Additional context

• Feel free to reword as desired--my goal was to provide a fix at least--I'm not attached to the specific wording.
• Intentionally preserved as much of previous PR as possible: Adds full description for AudioEffectRecord.xml. #39453.
• AudioStreamMicrophone needs to be documented.
• The microphone tutorial would benefit from clarifying the use of AudioStreamMicrophone.
• Read more on social media: https://twitter.com/RancidBacon/status/1434877933823299588 :D

Edited to add:
Forgot to mention that I discovered the Audio Buses tutorial does have a mostly (i.e. probably doesn't have to be a file) correct description for this effect:

The Record effect allows audio passing through the bus to be written to a file.

[follower]

Related links

Dumping these related links (which I used to figure out what was going on) here so I can close some tabs. :D

While there's further followup actions that could be taken I'm not able to do so right now, so hopefully this additional context is useful for anyone (including future me) wanting to followup.

• Audio Recording from godot #15967
• https://github.com/godotengine/godot/pull/36773/files#diff-134fd4e33fe884ad5e61e603fa8c2dec56d2530f20008522153e22e88e7d72fd
• https://github.com/godotengine/godot-demo-projects/blob/57f5e0835dcc83f7c564ca0cf2f611c33328b3cb/audio/mic_record/MicRecord.tscn#L6
• Experimental microphone support #19106
• No document for AudioStreamMicrophone on help #24370
• https://docs.godotengine.org/en/3.3/classes/class_audiostreammicrophone.html
• https://github.com/godotengine/godot/blob/8f7f5846397297fff6e8a08f89bc60ce658699cc/doc/classes/AudioStreamMicrophone.xml
• https://github.com/godotengine/godot/search?q=AudioStreamMicrophone&type=code
• Microphone recording doesn't work on Linux with official builds #33184
• Add support for recording and sending VoIP data godot-proposals#870
• Request mic access only when is needed #24324
• https://docs.godotengine.org/en/stable/tutorials/audio/recording_with_microphone.html#the-structure-of-the-demo
• https://godotengine.org/qa/26174/how-to-save-audiostreamplayer-bus-output-as-wav-ogg
• https://godotforums.org/discussion/20319/how-to-save-audio-output-to-a-wav-file
• https://godotforums.org/discussion/22691/render-audio-out-as-wav
• https://twitter.com/miziziziz/status/1296767673448173571

[fire]

I and @lyuma will find time to review since we proposed the idea of AudioEffectRecord.

Edited: We proposed AudioEffectCapture which is mostly a replacement for our usecases for AudioEffectRecord because Record wasn't able to be toggled every 20ms.

[lyuma]

@fire You are mistaken. It is AudioEffectCapture which we implemented, not AudioEffectRecord. But regardless we are in a position to understand both and their usages.

@YeldhamDev reading your tweets and such, I believe it is may actually be AudioEffectCapture that you want to use for your project... but that's your choice.

Anyway it's good to improve docs, so here are my comments.

I would like to add cross-linking between AudioEffectCapture and AudioEffectRecord so that it is easier to find them.

On AudioEffectRecord, I would write "This is for generating recordings. For real time processing, use [AudioEffectCapture]."

On AudioEffectCapture we can make a comment that "this is used for realtime processing. To record into an AudioStreamSample for later playback, see [AudioEffectRecord]"

And the same thing about "AudioStreamMicrophone" should also be written on AudioEffectCapture, since it is also expected to be a common use case.

One more thing, since you had difficulty finding this from the microphone capture, perhaps we can link to both of these AudioEffectCapture/AudioEffectRecord classes from AudioStreamMicrophone, too.

Haven't ever looked at those demos. They are probably out of date.

[follower]

Oh! I don't think I knew AudioEffectCapture even existed! :) Or maybe I didn't pay attention because I wasn't at that stage of one of my side projects... :)

I'm fine with any changes you want to make to the text so please feel free to amend as desired.

[fire]

Can you amend the changes so one is not waiting for each other?

[GeorgeS2019]

@follower For a tutorial on AudioEffectCapture

for real-time processing and monitoring if the microphone is capturing audio

Godot Voip

[GeorgeS2019]

Feedback to AudioEffectCapture

Why doesn't this support signals, and instead require every user to poll?

Signals from Godot-Voip

• received_voice_data(data: PoolRealArray, from_id: int) Emitted when voice data is received.
• sent_voice_data(data: PoolRealArray) Emitted when recording and data is sent.

[GeorgeS2019]

@follower

One use case that supports the use of AudioEffectCapture instead of AudioEffectRecord:

Sound activated voice recording from microphone

[mhilbrunner]

Thank you!

[akien-mga]

Cherry-picked for 3.5.

[akien-mga]

Cherry-picked for 3.4.3.