pazguille / voix

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

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.

voix's Issues

Background is copyrighted: Add name credit / link on footer.

The image used as background is copyrighted. He asked me add copyright information on the page.

Author:
Kenn Delbridge

Link:
https://www.flickr.com/photos/auralasia/8410119383/in/set-72157626950382118

Publish packages to NPM.

"It's cross-browser compatible"

The claim in the Readme, that this is "cross-browser compatible", but then only listing "Chrome" as a supported browser is akin to that old Henry Ford quote "You can have any color, as long as it's black."

Might be worth dropping that section until other browsers are supported.

Add touch support.

Use regular expressions.

No voice permissions on local test

I'm trying to test this locally and I don't get the microphone pemissions check from Chrome.
I suspect this is what's stopping me from running the application.