Skip to content

Commit dbf6d6c

Browse files
committed
README.md
1 parent f723634 commit dbf6d6c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ As “Audio Sinks” we will have e.g:
4545
- Callback integration e.g. with ESP8266Audio [AudioOutputWithCallback](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_audio_output_with_callback.html)
4646
- Any other Arduino Classes implementing Streams: SD, Ethernet etc
4747

48+
### Examples
49+
4850
Here is an simple example which streams a file from the Flash Memory and writes it to I2S:
4951

5052
```
@@ -63,7 +65,7 @@ StreamCopy copier(i2s, music); // copies sound into i2s
6365
void setup(){
6466
Serial.begin(115200);
6567
66-
I2SConfig config = i2s.defaultConfig(TX_MODE);
68+
auto config = i2s.defaultConfig(TX_MODE);
6769
config.sample_rate = sample_rate;
6870
config.channels = channels;
6971
config.bits_per_sample = 16;
@@ -78,9 +80,8 @@ void loop(){
7880
}
7981
8082
```
81-
82-
83-
### Examples
83+
Each stream has it's own configuration object that should be passed to the begin method. The defaultConfig() method is providing a default proposal which will usually "just work". Please consult
84+
the class documentation for the available configuration parameters.
8485

8586
Further examples can be found in the [Wiki](https://github.com/pschatzmann/arduino-audio-tools/wiki/Examples). The library also provides a versatile [AudioPlayer](https://github.com/pschatzmann/arduino-audio-tools/wiki/The-Audio-Player-Class).
8687

0 commit comments

Comments
 (0)