Skip to content

Correct sampling frequency units in documentation #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2022
Merged

Correct sampling frequency units in documentation #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Audio.begin(rate, size);

#### Parameters

rate (int) : the sample rate of the sound file. If stereo, double the rate (ex. 44100Khz stereo = 88200).
rate (int) : the sample rate of the sound file. If stereo, double the rate (ex. 44100 Hz stereo = 88200).

size (int) : the size of the audio buffer in milliseconds.

Expand Down Expand Up @@ -61,7 +61,7 @@ void setup()
// hi-speed SPI transfers
SPI.setClockDivider(4);

// 44100Khz stereo => 88200 sample rate
// 44100 Hz stereo => 88200 sample rate
// 100 mSec of prebuffering.
Audio.begin(88200, 100);
}
Expand Down Expand Up @@ -168,7 +168,7 @@ void setup()
// hi-speed SPI transfers
SPI.setClockDivider(4);

// 44100Khz stereo => 88200 sample rate
// 44100 Hz stereo => 88200 sample rate
// 100 mSec of prebuffering.
Audio.begin(88200, 100);
}
Expand Down Expand Up @@ -273,7 +273,7 @@ void setup()
// hi-speed SPI transfers
SPI.setClockDivider(4);

// 44100Khz stereo => 88200 sample rate
// 44100 Hz stereo => 88200 sample rate
// 100 mSec of prebuffering.
Audio.begin(88200, 100);
}
Expand Down