dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-05-27 22:11:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document Receiver

Browse source
This commit is contained in:
Amish Shah 2018-01-19 23:03:01 +00:00
parent c57c2889b7
commit 8e5e1ad8fe
No known key found for this signature in database
GPG key ID: 904349C1207D7967
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/client/voice/receiver/Receiver.js
View file

@ -2,6 +2,13 @@ const EventEmitter = require('events');
const prism = require('prism-media');
const PacketHandler = require('./PacketHandler');
/**
* Receives audio packets from a voice connection.
* @example
* const receiver = connection.createReceiver();
* // opusStream is a ReadableStream - that means you could play it back to a voice channel if you wanted to!
* const opusStream = receiver.createStream(user);
*/
class VoiceReceiver extends EventEmitter {
constructor(connection) {
super();
@ -16,6 +23,21 @@ class VoiceReceiver extends EventEmitter {
this.connection.sockets.udp.socket.on('message', buffer => this.packets.push(buffer));
}
/**
* Options passed to `VoiceReceiver#createStream`.
* @typedef {Object} ReceiveStreamOptions
* @property {string} [mode='opus'] The mode for audio output. This defaults to opus, meaning discord.js won't decode
* the packets for you. You can set this to 'pcm' so that the stream's output will be 16-bit little-endian stereo
* audio
*/
/**
* Creates a new audio receiving stream. If a stream already exists for a user, then that stream will be returned
* rather than generating a new one.
* @param {UserResolvable} user The user to start listening to.
* @param {ReceiveStreamOptions} options Options.
* @returns {ReadableStream}
*/
createStream(user, { mode = 'opus' } = {}) {
user = this.connection.client.users.resolve(user);
if (!user) throw new Error('VOICE_USER_MISSING');