https://github.com/TalAter/annyang

:speech_balloon: Speech recognition for your site
https://github.com/TalAter/annyang

hacktoberfest speech speech-recognition speech-to-text voice

Last synced: 14 days ago
JSON representation

:speech_balloon: Speech recognition for your site

• Host: GitHub
• URL: https://github.com/TalAter/annyang
• Owner: TalAter
• License: mit
• Created: 2013-08-23T10:59:34.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2022-10-03T18:05:48.000Z (about 2 years ago)
• Last Synced: 2024-04-14T22:13:32.513Z (7 months ago)
• Topics: hacktoberfest, speech, speech-recognition, speech-to-text, voice
• Language: JavaScript
• Homepage: https://www.talater.com/annyang/
• Size: 1.4 MB
• Stars: 6,550
• Watchers: 242
• Forks: 1,048
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - TalAter/annyang - 💬 Speech recognition for your site (JavaScript)
• awesome-javascript - annyang - Speech recognition for your site - ★ 5043 (Voice Command)
• StarryDivineSky - TalAter/annyang

README

        
# annyang!

A tiny JavaScript Speech Recognition library that lets your users control your site with voice commands.

**annyang** has no dependencies, weighs just 2 KB, and is free to use and modify under the MIT license.

## Demo and Tutorial

[Play with some live speech recognition demos](https://www.talater.com/annyang)

## FAQ, Technical Documentation, and API Reference

- [annyang Frequently Asked Questions](https://github.com/TalAter/annyang/blob/master/docs/FAQ.md)

- [annyang API reference](https://github.com/TalAter/annyang/blob/master/docs/README.md)

- [annyang tutorial](https://www.talater.com/annyang)

## Hello World

It's as easy as adding [one javascript file](//cdnjs.cloudflare.com/ajax/libs/annyang/2.6.1/annyang.min.js) to your document and defining the commands you want.

````html

if (annyang) {

  // Let's define a command.

  const commands = {

    'hello': () => { alert('Hello world!'); }

  };

  // Add our commands to annyang

  annyang.addCommands(commands);

  // Start listening.

  annyang.start();

}

````

**Check out some [live speech recognition demos and advanced samples](https://www.talater.com/annyang), then read the full [API Docs](https://github.com/TalAter/annyang/blob/master/docs/README.md).**

## Adding a GUI

You can easily add a GUI for the user to interact with Speech Recognition using [Speech KITT](https://github.com/TalAter/SpeechKITT).

Speech KITT makes it easy to add a graphical interface for the user to start or stop Speech Recognition and see its current status. KITT also provides clear visual hints to the user on how to interact with your site using their voice, providing instructions and sample commands.

Speech KITT is fully customizable and comes with many different themes, and instructions on how to create your own designs.

[![Speech Recognition GUI with Speech KITT](https://raw.githubusercontent.com/TalAter/SpeechKITT/master/demo/speechkitt-demo.gif)](https://github.com/TalAter/SpeechKITT)

````html

if (annyang) {

  // Add our commands to annyang

  annyang.addCommands({

    'hello': function() { alert('Hello world!'); }

  });

  // Tell KITT to use annyang

  SpeechKITT.annyang();

  // Define a stylesheet for KITT to use

  SpeechKITT.setStylesheet('//cdnjs.cloudflare.com/ajax/libs/SpeechKITT/0.3.0/themes/flat.css');

  // Render KITT's interface

  SpeechKITT.vroom();

}

````

For help with setting up a GUI with KITT, check out the [Speech KITT page](https://github.com/TalAter/SpeechKITT).

## Author

Tal Ater: [@TalAter](https://twitter.com/TalAter)

## License

Licensed under [MIT](https://github.com/TalAter/annyang/blob/master/LICENSE).