add disconnect event, document warn and debug events (#702)

* add documentation for events, and add a disconnect event, because i know people use that

* generate docs, and fix a hastily copied docstring

* fix permissions freak out
This commit is contained in:
Gus Caplan
2016-09-13 23:12:10 -05:00
committed by Schuyler Cebulskie
parent 25531170ec
commit 7cb2e8eef7
6 changed files with 26 additions and 11 deletions

View File

@@ -48,7 +48,7 @@ class VoiceConnectionPlayer extends EventEmitter {
killStream(stream) {
const streams = this.processMap.get(stream);
this._streamingData = this.dispatcher.streamingData;
this.emit('debug', 'Cleaning up player after audio stream ended or encountered an error');
this.emit(Constants.Events.DEBUG, 'Cleaning up player after audio stream ended or encountered an error');
const dummyHandler = () => null;
@@ -62,25 +62,25 @@ class VoiceConnectionPlayer extends EventEmitter {
streams.pcmConverter.stdout.once('error', dummyHandler);
if (streams.inputStream.unpipe) {
streams.inputStream.unpipe(streams.pcmConverter.stdin);
this.emit('debug', '- Unpiped input stream');
this.emit(Constants.Events.DEBUG, '- Unpiped input stream');
} else if (streams.inputStream.destroy) {
streams.inputStream.destroy();
this.emit('debug', '- Couldn\'t unpipe input stream, so destroyed input stream');
this.emit(Constants.Events.DEBUG, '- Couldn\'t unpipe input stream, so destroyed input stream');
}
if (streams.pcmConverter.stdin) {
streams.pcmConverter.stdin.end();
this.emit('debug', '- Ended input stream to PCM converter');
this.emit(Constants.Events.DEBUG, '- Ended input stream to PCM converter');
}
if (streams.pcmConverter && streams.pcmConverter.kill) {
streams.pcmConverter.kill('SIGINT');
this.emit('debug', '- Killed the pcm converter');
this.emit(Constants.Events.DEBUG, '- Killed the pcm converter');
}
} catch (err) {
// if an error happened make sure the pcm converter is killed anyway
try {
if (streams.pcmConverter && streams.pcmConverter.kill) {
streams.pcmConverter.kill('SIGINT');
this.emit('debug', '- Killed the pcm converter after previous error (abnormal)');
this.emit(Constants.Events.DEBUG, '- Killed the pcm converter after previous error (abnormal)');
}
} catch (e) {
return e;