diff options
| author | Fireflash <sam@trnl.co> | 2022-09-10 21:39:13 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-10 21:39:13 +1000 |
| commit | 7823ca13676648ae1f35b33ea18c9d699395f283 (patch) | |
| tree | e12fe701c0a587de1068a9258d3512877705f81a | |
| parent | 461037203cc0ec4f8a59422163b37e29e125d5fc (diff) | |
Update AudioStreamGeneratorPlayback.xml
Fixed incorrect method description for `get_frames_available`.
According to [The AudioStreamGenerator source](https://github.com/godotengine/godot/blob/master/servers/audio/effects/audio_stream_generator.cpp#L132), the `get_frames_available` method should return the space remaining in the sample buffer.
| -rw-r--r-- | doc/classes/AudioStreamGeneratorPlayback.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 1c02dbd3ce..c16198c5c6 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -27,7 +27,7 @@ <method name="get_frames_available" qualifiers="const"> <return type="int" /> <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. + Returns the number of frames that can be pushed to the audio sample data buffer without overflowing it. If the result is [code]0[/code], the buffer is full. </description> </method> <method name="get_skips" qualifiers="const"> |