Package Exports

speedyspeech

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (speedyspeech) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

speedyspeech

This is a module to quickly use the Web Speech API to recognize keywords as a user speaks.

Usage

var speedyspeech = require('speedyspeech');

// these will be keywords that speedyspeech will look for
var keywords = [ 'sports', 'future', 'family' ];

var fastRecog = new speedyspeech({
    keywords: keywords
}, function( err, result, confidence, foundKeyword ) {

    if( err )
        throw err;
    
    // result is the what the person said that speech api picked up
    // confidence is the confidence of the sentence/word uttered
    // foundKeyword is a keyword which was found in the result
    console.log( result, confidence, foundKeyword );
    
    // after you receive a result you must start recognizing again
    fastRecog.start();
});

// start's speech recognition
fastRecog.start();

// stop's speech recognition
// fastRecog.stop();

// change keywords
// fastRecog.setKeywords([ 'some', 'new', 'keywords' ]);

License

MIT, see LICENSE.md for details.