godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve AudioStreamSample documentation. 

"Squash" of #27928.

Wording based on suggestions by @LikeLakers2.

(cherry picked from commit a3aa98cb88)
This commit is contained in:
follower 2019-05-31 00:20:33 +12:00 committed by Rémi Verschelde
parent 78a24be155
commit 1e5c7d0a23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/AudioStreamSample.xml
View File

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.1.2">
<brief_description>
Plays audio.
Stores audio data loaded from [code].wav[/code] files.
</brief_description>
<description>
Plays audio, can loop.
AudioStreamSample stores sound samples loaded from [code].wav[/code] files. To play the stored sound use an [AudioStreamPlayer] (for background music) or [AudioStreamPlayer2D]/[AudioStreamPlayer3D] (for positional audio). The sound can be looped.
This class can also be used to store dynamically generated PCM audio data.
</description>
<tutorials>
</tutorials>