diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-05-30 15:04:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-30 15:04:51 +0200 |
| commit | 7310c84367ad336f3c58253f7adea6ba21e24b91 (patch) | |
| tree | d14fb3e06ee7e8b17b790475d396d69bd646b3bc /doc/classes | |
| parent | bac7e22cb186616197482caf12f1a1ae16b46127 (diff) | |
| parent | a3aa98cb88b2e3641e0606bcd67894a203ec9118 (diff) | |
Merge pull request #29310 from follower/patch-4
Improve AudioStreamSample documentation.
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> |