Giter VIP home page Giter VIP logo

electron-speech's Introduction

electron-speech

Speech recognition in node and the browser using Electron.

DEFUNCT

It seems that Google has shut down the Chrome Speech API for use in shell environments like Electron, which electron-speech relies on.

Google does offer a general speech api, which you can access using a module like google-speech-api. Unfortunately, you will require ffmpeg, a Google API key, and internet connectivity.

Intrepid developers! A purely local, open, offline-friendly solution like jasper may be the road forward! Go forth and write some awesome node modules around it!

Prerequisites

If you want to use the API from a script using Node, you will need to launch your script using the electron-spawn command instead of the node command:

$ npm install -g electron-spawn

$ electron-spawn example.js

Usage

CLI

This module installs the electron-speech command:

$ electron-speech
listening..
(whatever is said is written here, to stdout)

-q|--quiet to omit the listening.. message. (it's on stderr anyways though)

-c|--continuous to keep on listening after each result.

API

var Speech = require('electron-speech')

var recog = Speech({
  lang: 'en-US',
  continuous: true
})

recog.on('text', function (text) {
  console.log(text)
});

recog.listen()

Methods

var speech = Speech(opts)

Returns speech, an EventEmitter and Readable stream.

opts accepts multiple keys:

  • opts.lang - recognize speech in the language lang. Defaults to 'en-US'.
  • opts.continuous - if true, text events will keep on being emitted as recognition occurs.

speech.listen()

Starts listening to speech via the microphone. 'ready'` will be emitted once speech recognition has begun.

speech.pipe(stream)

Uses speech as a readable stream for text rather than an event emitter. Results have newlines appended to them for parsing convenience.

speech.on('ready')

Emitted when the microphone has begun to listen for speech.

speech.on('text', function (text) {})

Emitted when speech has been recognized.

speech.on('error', function (err) {})

Emitted when an error has occurred in recognition.

speech.on('close')

Emitted when recognition has ended. Does not fire if continuous was set to true.

License

ISC

electron-speech's People

Contributors

hackergrrl avatar noffle avatar alphashuro avatar mafintosh avatar nylki avatar

Watchers

James Cloos avatar JRichardsz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.