Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pazguille/voix
:loudspeaker: A JavaScript library to add voice commands to your sites, apps or games.
https://github.com/pazguille/voix
Last synced: about 3 hours ago
JSON representation
:loudspeaker: A JavaScript library to add voice commands to your sites, apps or games.
- Host: GitHub
- URL: https://github.com/pazguille/voix
- Owner: pazguille
- License: mit
- Created: 2013-12-02T12:01:51.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T20:16:21.000Z (over 4 years ago)
- Last Synced: 2024-12-15T01:09:25.996Z (7 days ago)
- Language: JavaScript
- Homepage: https://pazguille.github.io/voix/
- Size: 652 KB
- Stars: 586
- Watchers: 35
- Forks: 81
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-javascript - voix - A JavaScript library to add voice commands to your sites, apps or games. - ★ 524 (Voice Command)
README
# 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](https://github.com/component/component)
### Standalone
You can use the standalone version:
```html
```
## How-to
Create a new instance of Voix.
```js
var voix = new Voix('en-US');
```
## API
### Voix(lang)
Create a new instance of `Voix`.
- `lang`: A given language.
```js
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`.
```js
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.
```js
voix.removeCommand('play', playVideo);
// or
voix.removeCommand('play');
```
### Voix#start()
Starts the recognition.
```js
voix.start();
```
### Voix#stop()
Stops the recognition.
```js
voix.stop();
```
## Maintained by
- Guille Paz (Front-end developer | Web standards lover)
- E-mail: [[email protected]](mailto:[email protected])
- Twitter: [@pazguille](http://twitter.com/pazguille)
- Web: [http://pazguille.me](http://pazguille.me)
## License
Licensed under the MIT license.
Copyright (c) 2013 [@pazguille](http://twitter.com/pazguille).