{"_id":"tessel-av","_rev":"34-aa89c4dda42164172c5fa98ae1b2579c","name":"tessel-av","description":"USB Camera, Microphone, MP3 Player and Text Speaker support for Tessel 2.","dist-tags":{"latest":"0.19.0"},"versions":{"0.1.0":{"name":"tessel-av","version":"0.1.0","description":"Cross-platform audio record/playback and video recording.","repository":{"type":"git","url":"git+https://github.com/tessel/tessel-av.git"},"main":"lib/index.js","scripts":{"test":"grunt","postinstall":"node scripts/postinstall","install":"node-gyp rebuild"},"author":{"name":"Rick Waldron","email":"waldron.rick@gmail.com"},"contributors":[{"name":"Tim Cameron Ryan","email":" {\n response.writeHead(200, { \"Content-Type\": \"image/jpg\" });\n\n camera.capture().pipe(response);\n\n}).listen(port, () => console.log(`http://${os.hostname()}.local:${port}`));\n\nprocess.on(\"SIGINT\", _ => server.close());\n```\n\n\nA very simple example of direct-to-browser streaming:\n\n```js\n'use strict';\nconst express = require('express');\nconst app = express();\nconst server = require('http').Server(app);\nconst os = require('os');\nconst path = require('path');\nconst port = 8888;\n\nconst av = require('tessel-av');\nconst camera = new av.Camera();\n\nserver.listen(port, function () {\n console.log(`http://${os.hostname()}.local:${port}`);\n});\n\napp.use(express.static(path.join(__dirname, '/public')));\napp.get('/stream', (request, response) => {\n response.redirect(camera.url);\n});\n```\n\nAnd here's the `public/index.html` file, which should be referenced in a [`.tesselinclude` file](https://tessel.gitbooks.io/t2-docs/content/API/CLI.html)): \n\n```html\n\n\n \n \n streaming video to img element\n \n \n \n \n\n```\n\n\n## av.Player\n\nThe `Player` class produces instances that may be used to play audio from an mp3 file stored on the Tessel 2.\n\n(Prior to v0.3.0, the `av.Speaker` class was used for audio file playback, and while that still works in versions >=0.3.0, programs will need to update to use this class before 1.0.0 (estimated release: July 1st, 2016)\n\n\n### av.Player Initialization\n\nThe `Player` class constructor accepts one argument, which is optional, that specifies an mp3 file to play when the `play()` method is called. The may be omitted and supplied directly to `play(file [, time])` at a later time in the object's lifecycle.\n\n\n- **`play([seconds])`** Play the specified file. Optionally provide a time to start at in seconds. See Allowed Time String Formats\n- **`play([ file [, seconds])`** Play the specified file. Optionally provide a time to start at in seconds. See Allowed Time String Formats\n- **`play([ 'file.mp3', ...options ])`** Play the file with additional options in an array. \n- **`play(options)`** Play the file with additional options in an object. \n ```\n Options {\n phrase: \"Hello Dave, you're looking well today\", \n ...\n }\n ```\n\n- **`pause()`** Pause playback of the current file. \n- **`stop()`** Stop playback of the current file (calling `play()` will start the playback from the beginning.)\n\n#### Allowed Time String Formats\n\n| Format | Type |\n| ------ | ---- |\n| `hh:mm:ss` | string |\n| `ssss.dddd` | number |\n| `ssss` | number |\n\n\n#### Options\n\nOptions may be _most_ of [options supported by `madplay`](madplay.md). For example, if I wanted to set the amplitude and pitch: \n\n```js\nplayer.play(['foo.mp3', '-a', 10, '-r', 2 ]);\nplayer.play(['foo.mp3', 'a', 10, 'r', 2 ]);\n```\n\nor \n\n```js\nplayer.play({\n file: 'foo.mp3',\n a: 10,\n r: 2,\n});\n```\n\n\n### av.Player Events\n\n- **`ended`** when playback ends.\n- **`play`** after `play()` is called.\n- **`pause`** after `pause()` is called.\n- **`stop`** after `stop()` is called.\n- **`timeupdate`** approximately every 100ms. Delivers an approximation of the playback time in seconds, as `ssss.ddd`.\n\nThe following is an example of the API and events working together: \n\n- The sound will play from the beginning\n- After approximate 2 seconds, the sound will pause\n- After 1 second pause, sound will resume , it will resume playback from the 10 second mark, play until just after the 12 second mark, where it will stop and then play from the beginning again. \n\n```js\n'use strict';\nconst path = require('path');\nconst av = require('tessel-av');\nconst mp3 = path.join(__dirname, '20-second-nonsense.mp3');\nconst sound = new av.Player(mp3);\n\nsound.play();\n\nsound.on('timeupdate', function(seconds) {\n seconds = Math.round(seconds);\n\n if (seconds === 2) {\n this.pause();\n }\n\n if (seconds > 12) {\n this.stop().play();\n }\n});\n\nsound.on('pause', function() {\n setTimeout(() => this.play(10), 1000);\n});\n```\n\n\nAlternatively, an mp3 file may be provided at the `play(...)` call site: \n\n```js\n'use strict';\nconst path = require('path');\nconst av = require('./lib/index');\nconst mp3 = path.join(__dirname, 'some-audio-file.mp3');\nconst sound = new av.Player();\n\n// Play the mp3, starting at the 10 second mark.\nsound.play(mp3, \"10\");\n\nsound.on('ended', function() {\n console.log('This is not the end!');\n sound.play();\n});\n```\n\n\n> Remember that you **must** explicitly specify static assets by listing them in a [`.tesselinclude` file](https://tessel.gitbooks.io/t2-docs/content/API/CLI.html) file. For example, to ensure the `song.mp3` file is deployed to your Tessel 2, you'll create a file called `.tesselinclude` that contains the following:\n> ```\n> song.mp3\n> ```\n> \n> You may find it easier to put all static assets in a sub-directory, such as `public/`, or similar. Then you can include _all_ files and sub-directories by creating a `.tesselinclude` file and listing that assets directory like this: \n> \n> ```\n> public\n> ```\n> \n\n\n## av.Speaker \n\n(Prior to v0.3.0, the `av.Speaker` class was used for audio file playback, and while that still works in versions >=0.3.0, programs will need to update to use this class before 1.0.0 (estimated release: July 1st, 2016)\n\n\n- **`say(\"phrase\")`** Speak the phrase (string). \n- **`say([\"phrase\", ...])`** Speak the phrase with additional options in an array. \n- **`say(options)`** Speak the phrase with additional options in an object. \n ```\n Options {\n phrase: \"Hello Dave, you're looking well today\", \n ...\n }\n ```\n- **`stop()`** Stop playback.\n\n\n### av.Speaker Initialization\n\nOptions may be _most_ of the [options supported by `espeak`](espeak.md). For example, if I wanted to set the amplitude and pitch: \n\n```js\nspeaker.say(['Hello!', '-a', 10, '-p', 50 ]);\nspeaker.say(['Hello!', 'a', 10, 'p', 50 ]);\n```\n\nor \n\n```js\nspeaker.say({\n phrase: 'Hello!',\n a: 10,\n p: 50,\n});\n```\n\n\n#### Queuing\n\nBack to back calls to `speaker.say(...)` will result in each phrase being queued. Once a phrase has been said, the next phrase in the queue will be spoken.\n\n\n### av.Speaker Events\n\n- **`ended`** when speech ends.\n- **`empty`** when speech ends and the speech queue is empty.\n- **`lastword`** when speech ends and the speech queue is empty and the program should **prevent** any further `empty` events from being emitted. This allows your robot to get the last word in without repeating themselves forever.\n- **`say`** after `say()` is called.\n- **`stop`** after `stop()` is called.\n- **`timeupdate`** approximately every 100ms. Delivers an approximation of the speech time in seconds, as `ssss.ddd`.\n\nThe following is an example of the API and events working together: \n\n- The first phrase will be said.\n- Once spoken, the `ended` event will trigger, which will start the \"cycle\" through the letters of the alphabet.\n\n```js\n'use strict';\nconst os = require('os');\nconst path = require('path');\nconst av = require('tessel-av');\n\nconst alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');\nconst speaker = new av.Speaker();\n\nspeaker.say(`\n Hello, this is ${os.hostname()}. \n I'm going to say my A-B-C's now\n`);\n\nspeaker.on('ended', function() {\n if (alphabet.length) {\n this.say(alphabet.shift());\n }\n});\n```\n\nAlternatively, each letter can be \"queued\": \n\n```js\n'use strict';\nconst os = require('os');\nconst av = require('tessel-av');\n\nconst alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');\nconst speaker = new av.Speaker();\n\nspeaker.say(`\n Hello, this is ${os.hostname()}. \n I'm going to say my A-B-C's now\n`);\n\nalphabet.forEach(letter => speaker.say(letter));\n\nspeaker.on('lastword', function() {\n // If this had been an `empty` event, it would've \n // been emitted again as soon as the next phrase \n // was spoken.\n this.say('And now I know my A-B-Cs');\n});\n```\n\n\n## License\n\nMIT.\n","maintainers":[{"name":"rwaldron","email":"waldron.rick@gmail.com"}],"time":{"modified":"2022-06-27T04:56:48.931Z","created":"2016-02-24T21:13:06.491Z","0.1.0":"2016-02-24T21:13:06.491Z","0.1.1":"2016-02-25T15:31:09.283Z","0.1.2":"2016-02-25T15:39:07.952Z","0.2.0":"2016-02-26T19:59:09.134Z","0.2.1":"2016-03-01T17:48:00.961Z","0.2.2":"2016-03-08T22:33:46.662Z","0.3.0":"2016-03-16T23:16:25.187Z","0.3.1":"2016-03-16T23:59:58.116Z","0.3.2":"2016-03-17T15:35:28.655Z","0.4.0":"2016-03-17T21:27:10.354Z","0.4.1":"2016-03-17T22:10:29.508Z","0.4.2":"2016-03-17T22:25:09.448Z","0.5.0":"2016-03-22T15:40:27.865Z","0.6.0":"2016-04-16T00:03:33.126Z","0.7.0":"2016-05-25T22:06:36.967Z","0.8.0":"2016-08-04T01:21:25.653Z","0.10.0":"2016-09-12T20:56:57.153Z","0.11.0":"2016-10-21T20:29:15.931Z","0.12.0":"2016-11-02T21:44:40.057Z","0.12.1":"2016-11-03T17:34:54.787Z","0.13.0":"2016-11-04T21:40:36.094Z","0.14.0":"2016-11-14T20:52:09.083Z","0.15.0":"2016-12-16T19:48:49.285Z","0.15.1":"2017-03-21T19:35:04.198Z","0.16.0":"2017-04-27T19:46:37.424Z","0.16.1":"2017-04-28T13:45:39.257Z","0.16.2":"2017-04-28T14:44:50.674Z","0.16.3":"2017-04-28T14:47:21.162Z","0.16.4":"2017-04-28T14:48:20.363Z","0.17.0":"2017-05-12T19:45:44.827Z","0.18.0":"2017-05-22T15:21:20.644Z","0.19.0":"2017-06-12T15:43:31.087Z"},"homepage":"https://github.com/tessel/tessel-av#readme","repository":{"type":"git","url":"git+https://github.com/tessel/tessel-av.git"},"contributors":[{"name":"Tim Cameron Ryan","email":"