cleanup playback errors, automatically stop playback for recognizestream errors

Author: nfriedly

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v0.23.0
+* Changed file player error.name from `UNRECOGNIZED_FORMAT` to `UNSUPPORTED_FORMAT`
+  (There are now two potential errors with this name: the file is recognized but the browser cannot play it, and the file type is not recognized.)
+* Changed the `playback-error` event to just `error`
+* Automatically stop file playback in the event of a RecognizeStream error
 
 ### v0.22.0
 * Breaking: RecognizeStream now emits the original JSON message rather than the extracted results objects.

README.md

@@ -111,6 +111,7 @@ There have been a few breaking changes in recent releases:
 * renamed `recognizeBlob` to `recognizeFile` to make the primary usage more apparent
 * Changed `playFile` option of `recognizeBlob()` to just `play`, corrected default
 * Changed format of objects emitted in objectMode to exactly match what service sends. Added `ResultExtractor` class and `extract_results` option to enable older behavior.
+* Changed `playback-error` event to just `error` when recognizing and playing a file. Check for `error.name == 'UNSUPPORTED_FORMAT'` to identify playback errors
 
 See [CHANGELOG.md](CHANGELOG.md) for a complete list of changes.
 

speech-to-text/file-player.js

@@ -18,7 +18,7 @@ function getContentTypeFromFile(file) {
         resolve(ct);
       } else {
         var err = new Error('Unable to determine content type from file header; only wav, flac, and ogg/opus are supported.');
-        err.name = 'UNRECOGNIZED_FORMAT';
+        err.name = 'UNSUPPORTED_FORMAT';
         reject(err);
       }
     };

speech-to-text/recognize-file.js

@@ -94,8 +94,9 @@ module.exports = function recognizeFile(options) { // eslint-disable-line comple
   if (options.play) {
     FilePlayer.playFile(options.data).then(function(player) {
       recognizeStream.on('stop', player.stop.bind(player));
+      recognizeStream.on('error', player.stop.bind(player));
     }).catch(function(err) {
-      stream.emit('playback-error', err);
+      stream.emit('error', err);
     });
   }