Giter VIP home page Giter VIP logo

voicecmdr's Introduction

voiceCmdr

Build Status npm version

voiceCmdr is a library for adding voice commands to your website. It is build on top of Webkit Speech API.

Browser support

  • Google Chrome 31+

Getting started

Install with npm:

npm install voice-cmdr

Install with bower:

bower install voice-cmdr

Run http server (can be installed with npm install -g http-server):

http-server

Then open localhost:8080 in your browser and navigate to examples directory.

(*) Voice recognition works only through http protocol. That's why you have to serve static files through the server instead of just opening them in the browser.

(**) Pages hosted on HTTPS do not need to ask repeatedly for permission, whereas HTTP hosted pages do.

API

  • Add command:

      voiceCmdr.addCommand("command", callbackFunction);
    

    Example:

      voiceCmdr.addCommand("home", function () {
      	// navigate to home page
      });
      
      voiceCmdr.addCommand("search", function (param) {
      	console.log("Searching for:", param);
      });	
    
  • Remove command:

      voiceCmdr.removeCommand("command");
    
  • Start listening (continuously):

      voiceCmdr.start();
    
  • Stop listening:

      voiceCmdr.stop();
    
  • Get single command:

      voiceCmdr.getCommand();
    
  • Turn debug mode on/off:

      voiceCmdr.debug(true|false);
    

Demo

www.bookslib.azurewebsites.net

Available commands:

books
favorites
top 10
search [string]

To Do

  • lowercase commands
  • Stop restarting after 5 tries (if user set deny the restarting will work infinitely)
  • Add setting language
  • Tests (???):
    • addCommand
      • Works
      • Can overwrite existing without error
    • removeCommand
      • Remove existing returns true
      • Remove non-existing returns false
    • in browser with karma (???)
    • Jasmine vs Mocha+Chai+Sinon with mocking window + webkitSpeechRecognition (???)

License

MIT

voicecmdr's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

voicecmdr's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.