Improve AudioStreamGenerator and AudioEffectSpectrumAnalyzer documentation #48682
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
added
cherrypick:3.x
Calinou
commented
May 13, 2021
Comment on lines
23
to
24
| <member name="tap_back_pos" type="float" setter="set_tap_back_pos" getter="get_tap_back_pos" default="0.01"> | ||
| </member> |
There was a problem hiding this comment.
Does anyone know what the tap_back_pos property is used for? I'd like to get 100% documentation completion on this class 🙂
Calinou
commented
May 13, 2021
| </description> | ||
| </method> | ||
| <method name="get_frames_available" qualifiers="const"> | ||
| <return type="int"> | ||
| </return> | ||
| <description> | ||
| Returns the number of audio data frames left to play. If this returned number reaches [code]0[/code], the audio will stop playing until frames are added again. Therefore, make sure your script can always generate and push new audio frames fast enough to avoid audio cracking. | ||
| </description> | ||
| </method> | ||
| <method name="get_skips" qualifiers="const"> |
There was a problem hiding this comment.
Does anyone know what the get_skips() method is used for? I'd like to get 100% documentation completion on this class 🙂
Calinou
commented
May 13, 2021
| </member> | ||
| <member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectSpectrumAnalyzer.FFT_Size" default="2"> | ||
| The size of the [url=https://en.wikipedia.org/wiki/Fast_Fourier_transform]Fast Fourier transform[/url] buffer. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can't keep up. |
There was a problem hiding this comment.
Does the FFT size actually affect the visualization quality, or just the history size available? Does it have any relationship with the buffer_length above?
Calinou
force-pushed
the
doc-audio-generation
branch
4 times, most recently
from
811b87e to
eeca267
Compare
Calinou
changed the title
Calinou
force-pushed
the
doc-audio-generation
branch
3 times, most recently
from
69ad402 to
6549f43
Compare
…ation - Mention audio sample rate caveats in other classes where relevant.
Calinou
force-pushed
the
doc-audio-generation
branch
from
6549f43 to
c872819
Compare
akien-mga
approved these changes
Jun 15, 2021
|
Thanks! |
|
Cherry-picked for 3.4. |
akien-mga
removed
the
cherrypick:3.x
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #48681.
cc @unfa as he works with audio 🙂