From a3aa98cb88b2e3641e0606bcd67894a203ec9118 Mon Sep 17 00:00:00 2001 From: follower Date: Fri, 31 May 2019 00:20:33 +1200 Subject: [PATCH] Improve AudioStreamSample documentation. "Squash" of #27928. Wording based on suggestions by @LikeLakers2. --- doc/classes/AudioStreamSample.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index e23080c9d3c..4bcf8ea7919 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,10 +1,11 @@ - Plays audio. + Stores audio data loaded from [code].wav[/code] files. - 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.