Skip to content
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

Update config in README #22

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update config in README #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8ea5ba
Update config
dnicolson Nov 22, 2022
ae3d911
Fix typo
dnicolson Nov 22, 2022
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ setTimeout(() => {

// Dispose (stop sox process and listeners) after 30s
setTimeout(() => {
console.log("dispose all listeners and free ressources")
console.log("dispose all listeners and free resources")
clap.dispose()
}, 30000)
```
Expand All @@ -129,12 +129,13 @@ You can pass a configuration object and override the default values when you cre
```bash
// DEFAULT CONFIG
var CONFIG = {
AUDIO_SOURCE: 'hw:1,0', // this is your microphone input. If you dont know it you can refer to this thread (http://www.voxforge.org/home/docs/faq/faq/linux-how-to-determine-your-audio-cards-or-usb-mics-maximum-sampling-rate)
DETECTION_PERCENTAGE_START : '5%', // minimum noise percentage threshold necessary to start recording sound
DETECTION_PERCENTAGE_END: '5%', // minimum noise percentage threshold necessary to stop recording sound
AUDIO_SOURCE: 'alsa hw:1,0', // this is your microphone input. If you dont know it you can refer to this thread (http://www.voxforge.org/home/docs/faq/faq/linux-how-to-determine-your-audio-cards-or-usb-mics-maximum-sampling-rate)
DETECTION_PERCENTAGE_START : '10%', // minimum noise percentage threshold necessary to start recording sound
DETECTION_PERCENTAGE_END: '10%', // minimum noise percentage threshold necessary to stop recording sound
CLAP_AMPLITUDE_THRESHOLD: 0.7, // minimum amplitude threshold to be considered as clap
CLAP_ENERGY_THRESHOLD: 0.3, // maximum energy threshold to be considered as clap
MAX_HISTORY_LENGTH: 10 // all claps are stored in history, this is its max length
CLAP_MAX_DURATION: 1500,
MAX_HISTORY_LENGTH: 100 // all claps are stored in history, this is its max length
}
const clap = new ClapDetector(CONFIG)
```
Expand Down