Browse Source

Improve AudioStreamSample documentation.

"Squash" of #27928.

Wording based on suggestions by @LikeLakers2.

(cherry picked from commit a3aa98cb88b2e3641e0606bcd67894a203ec9118)
follower 6 years ago
parent
commit
1e5c7d0a23
1 changed files with 3 additions and 2 deletions
  1. 3 2
      doc/classes/AudioStreamSample.xml

+ 3 - 2
doc/classes/AudioStreamSample.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.1.2">
 <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.1.2">
 	<brief_description>
 	<brief_description>
-		Plays audio.
+		Stores audio data loaded from [code].wav[/code] files.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>