Browse Source

Improve AudioStreamSample and AudioStreamGenerator documentation

- Add a link to the audio generator demo in AudioStreamGenerator
  and AudioStreamGeneratorPlayback.
- Mention that signed PCM8 data is expected in AudioStreamSample
  (and how to convert unsigned PCM8 to signed PCM8).
Hugo Locurcio 6 years ago
parent
commit
b0c8d12a63

+ 1 - 0
doc/classes/AudioStreamGenerator.xml

@@ -5,6 +5,7 @@
 	<description>
 	<description>
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
+		<link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link>
 	</tutorials>
 	</tutorials>
 	<methods>
 	<methods>
 	</methods>
 	</methods>

+ 1 - 0
doc/classes/AudioStreamGeneratorPlayback.xml

@@ -5,6 +5,7 @@
 	<description>
 	<description>
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
+		<link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link>
 	</tutorials>
 	</tutorials>
 	<methods>
 	<methods>
 		<method name="can_push_buffer" qualifiers="const">
 		<method name="can_push_buffer" qualifiers="const">

+ 1 - 0
doc/classes/AudioStreamSample.xml

@@ -24,6 +24,7 @@
 	<members>
 	<members>
 		<member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray(  )">
 		<member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray(  )">
 			Contains the audio data in bytes.
 			Contains the audio data in bytes.
+			[b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
 		</member>
 		</member>
 		<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0">
 		<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0">
 			Audio format. See [code]FORMAT_*[/code] constants for values.
 			Audio format. See [code]FORMAT_*[/code] constants for values.