How do I add voice commands with annyang?

Define commands using an object where keys are voice phrases and values are callback functions, then use annyang.addCommands() and start(). For example, 'search for *term': (term) => console.log(term) handles dynamic inputs.

annyang vs using the Web Speech API directly: which should I choose?

annyang simplifies the Web Speech API by abstracting command management and reducing boilerplate, ideal for quick setups. However, direct API use offers more control for complex recognition settings or custom event handling.

Does annyang work on mobile browsers like iPhone?

annyang works on browsers supporting the SpeechRecognition API, but iOS Safari has limited or no support, so functionality may be restricted on Apple mobile devices, requiring fallback strategies.

Can annyang recognize multiple languages?

Yes, by setting the language via annyang.setLanguage('lang-code'), but support depends on the browser's SpeechRecognition API, and not all languages may be available consistently across platforms.

How to customize the speech recognition GUI in annyang?

Integrate Speech KITT, a separate library, to add and customize a GUI. This involves including its scripts and CSS, then configuring themes and controls to match your design, as detailed in the Speech KITT documentation.

What browsers fully support annyang?

annyang works best in browsers with robust SpeechRecognition API support, such as Chrome and Edge. Firefox has partial implementation, and Safari on iOS is largely unsupported, so check current compatibility tables.

annyang — JavaScript Speech Recognition

What is annyang?

annyang is a lightweight JavaScript library that adds speech recognition capabilities to websites, enabling users to control web applications with voice commands. It provides a simple API to define custom voice commands and integrates seamlessly with the browser's native SpeechRecognition API. The library solves the problem of making web interfaces more accessible and interactive through hands-free voice control.

Target Audience

Frontend developers and web designers looking to enhance user experience with voice interaction, particularly for accessibility features, hands-free navigation, or innovative UI controls.

Value Proposition

Developers choose annyang for its minimal size (2 KB), zero dependencies, and straightforward API that simplifies adding speech recognition without complex setups. Its compatibility with the browser's built-in API ensures broad support and ease of integration.

💬 Speech recognition for your site

Use Cases

Best For

Adding voice navigation to single-page applications
Creating accessible web interfaces for users with mobility impairments
Building hands-free demos or interactive tutorials
Implementing voice search functionality on websites
Enhancing educational or gaming sites with voice commands
Prototyping voice-controlled web applications quickly

Not Ideal For

Projects requiring server-side or offline speech recognition independent of browser APIs
Applications needing complex natural language understanding beyond simple keyword matching
Teams that must ensure consistent voice recognition across all browsers, including iOS Safari
Environments where users have limited or no internet access, as the SpeechRecognition API may rely on cloud services

Pros & Cons

Pros

No Dependencies, Tiny Size

Leverages the browser's native SpeechRecognition API, resulting in a minimal 2 KB library with zero external dependencies, as highlighted in the README.

Intuitive Command Syntax

Uses a straightforward object-based syntax to define voice commands, including wildcards for dynamic inputs, making it easy to set up basic interactions as shown in the Hello World example.

Flexible Integration Options

Supports ESM, CommonJS, and script tag inclusion, allowing seamless adoption in various JavaScript project setups without configuration hurdles.

GUI Ready with Speech KITT

Easily pairs with Speech KITT for a customizable graphical interface, providing visual feedback and user controls to enhance the speech recognition experience, as documented in the README.

Cons

Limited Browser Compatibility

Relies on the SpeechRecognition API, which has inconsistent support across browsers—particularly poor on iOS Safari—leading to unreliable user experiences in some environments.

Basic Recognition Capabilities

Only supports simple keyword and wildcard matching, lacking advanced features like continuous listening, context awareness, or natural language processing without custom extensions.

Separate GUI Dependency

Requires integrating Speech KITT as an additional library for a graphical interface, adding complexity and potential compatibility issues for projects needing visual controls out-of-the-box.

What is annyang?

Target Audience

Frontend developers and web designers looking to enhance user experience with voice interaction, particularly for accessibility features, hands-free navigation, or innovative UI controls.

Value Proposition

Use Cases

Best For

Adding voice navigation to single-page applications
Creating accessible web interfaces for users with mobility impairments
Building hands-free demos or interactive tutorials
Implementing voice search functionality on websites
Enhancing educational or gaming sites with voice commands
Prototyping voice-controlled web applications quickly

Not Ideal For

Projects requiring server-side or offline speech recognition independent of browser APIs
Applications needing complex natural language understanding beyond simple keyword matching
Teams that must ensure consistent voice recognition across all browsers, including iOS Safari
Environments where users have limited or no internet access, as the SpeechRecognition API may rely on cloud services

Pros & Cons

Pros

No Dependencies, Tiny Size

Leverages the browser's native SpeechRecognition API, resulting in a minimal 2 KB library with zero external dependencies, as highlighted in the README.

Intuitive Command Syntax

Uses a straightforward object-based syntax to define voice commands, including wildcards for dynamic inputs, making it easy to set up basic interactions as shown in the Hello World example.

Flexible Integration Options

Supports ESM, CommonJS, and script tag inclusion, allowing seamless adoption in various JavaScript project setups without configuration hurdles.

GUI Ready with Speech KITT

Easily pairs with Speech KITT for a customizable graphical interface, providing visual feedback and user controls to enhance the speech recognition experience, as documented in the README.

Cons

Limited Browser Compatibility

Relies on the SpeechRecognition API, which has inconsistent support across browsers—particularly poor on iOS Safari—leading to unreliable user experiences in some environments.

Basic Recognition Capabilities

Only supports simple keyword and wildcard matching, lacking advanced features like continuous listening, context awareness, or natural language processing without custom extensions.

Separate GUI Dependency

Requires integrating Speech KITT as an additional library for a graphical interface, adding complexity and potential compatibility issues for projects needing visual controls out-of-the-box.

annyang

What is annyang?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

annyang

What is annyang?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?