Browse Source

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.

(cherry picked from commit 7823ca13676648ae1f35b33ea18c9d699395f283)
Fireflash 3 years ago
parent
commit
239b2e4bbc
1 changed files with 1 additions and 1 deletions
  1. 1 1
      doc/classes/AudioStreamGeneratorPlayback.xml

+ 1 - 1
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">