mirror of
https://github.com/godotengine/godot
synced 2024-09-05 18:09:34 +00:00
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.
This commit is contained in:
parent
461037203c
commit
7823ca1367
|
@ -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">
|
||||
|
|
Loading…
Reference in a new issue