diff options
| author | follower <follower@rancidbacon.com> | 2019-05-31 00:20:33 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-31 00:20:33 +1200 |
| commit | a3aa98cb88b2e3641e0606bcd67894a203ec9118 (patch) | |
| tree | 6c8e89593090a964fefee0857be11f6da92bde8f /doc/classes | |
| parent | 0c74aae57616fb91dd348cb485404486a95a2064 (diff) | |
Improve AudioStreamSample documentation.
"Squash" of #27928.
Wording based on suggestions by @LikeLakers2.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AudioStreamSample.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index e23080c9d3..4bcf8ea791 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.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> |