From b0c8d12a631839ffcced325ee0ac74f08d07d106 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sat, 31 Aug 2019 20:14:58 +0200 Subject: [PATCH] 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). --- doc/classes/AudioStreamGenerator.xml | 1 + doc/classes/AudioStreamGeneratorPlayback.xml | 1 + doc/classes/AudioStreamSample.xml | 1 + 3 files changed, 3 insertions(+) diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index 9d67b88c71f..9a1e4432f16 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -5,6 +5,7 @@ + https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 310b58c4e5f..448284e6701 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -5,6 +5,7 @@ + https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 6d033017495..a496902ded6 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -24,6 +24,7 @@ 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. Audio format. See [code]FORMAT_*[/code] constants for values.