diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-08-31 20:14:58 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-08-31 20:16:04 +0200 |
| commit | b0c8d12a631839ffcced325ee0ac74f08d07d106 (patch) | |
| tree | 3fef9fbebeb16c378ea070a355153457680fc630 /doc | |
| parent | b17b51d9701459d43da7c6766642762649802ff0 (diff) | |
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).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AudioStreamGenerator.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AudioStreamGeneratorPlayback.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AudioStreamSample.xml | 1 |
3 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index 9d67b88c71..9a1e4432f1 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> </methods> diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 310b58c4e5..448284e670 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> <method name="can_push_buffer" qualifiers="const"> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 6d03301749..a496902ded 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -24,6 +24,7 @@ <members> <member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray( )"> 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 name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0"> Audio format. See [code]FORMAT_*[/code] constants for values. |