📢 A JavaScript library to add voice commands to your sites, apps or games.
JavaScript
Switch branches/tags
Nothing to show
Latest commit 8fdcff9 Dec 26, 2013 @pazguille Update README.md
Permalink
Failed to load latest commit information.
dist Remove console.log Dec 8, 2013
test Corrected Reference to Javascript File Dec 11, 2013
.gitignore Ignore .DS_Store file Dec 6, 2013
History.md Create component files. Dec 4, 2013
LICENSE Initial commit Dec 2, 2013
Makefile Create component files. Dec 4, 2013
README.md Update README.md Dec 26, 2013
component.json Update version. Dec 8, 2013
index.js
voix.js Remove console.log Dec 8, 2013

README.md

Voix JS

A JavaScript library to add voice commands to your sites, apps or games.

NOTE: At this time, this library is only compatible with Google Chrome.

Installation

$ component install pazguille/voix

See: https://github.com/component/component

Standalone

You can use the standalone version:

<script src="voix.js"></script>

How-to

Create a new instance of Voix.

var voix = new Voix('en-US');

API

Voix(lang)

Create a new instance of Voix.

  • lang: A given language.
var voix = new Voix('en-US');

Voix#setCommand(command, listener)

Sets a new command with a listener to the collection.

  • command - A given command.
  • listener - A given listener.
voix.setCommand('play', playVideo);

Voix#removeCommand(command, listener)

Removes a given command or its listener from the collection.

  • command - A given command to remove.
  • listener [optional] - A given listener to remove.
voix.removeCommand('play', playVideo);

// or

voix.removeCommand('play');

Voix#start()

Starts the recognition.

voix.start();

Voix#stop()

Stops the recognition.

voix.stop();

## Maintained by

License

Licensed under the MIT license.

Copyright (c) 2013 @pazguille.