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

• Guille Paz (Front-end developer | Web standards lover)
• E-mail: [email protected]
• Twitter: @pazguille
• Web: http://pazguille.me

License

Licensed under the MIT license.

Copyright (c) 2013 @pazguille.