Files
discord.js/src/structures/VoiceChannel.js
Gus Caplan 495264761c Add snowflake utils (#1064)
* snowflakes

* use proper binary for snowflake example

* fix jsdoc errors

* remove dupe
2017-01-05 15:41:42 +00:00

121 lines
3.0 KiB
JavaScript

const GuildChannel = require('./GuildChannel');
const Collection = require('../util/Collection');
/**
* Represents a guild voice channel on Discord.
* @extends {GuildChannel}
*/
class VoiceChannel extends GuildChannel {
constructor(guild, data) {
super(guild, data);
/**
* The members in this voice channel.
* @type {Collection<Snowflake, GuildMember>}
*/
this.members = new Collection();
this.type = 'voice';
}
setup(data) {
super.setup(data);
/**
* The bitrate of this voice channel
* @type {number}
*/
this.bitrate = data.bitrate;
/**
* The maximum amount of users allowed in this channel - 0 means unlimited.
* @type {number}
*/
this.userLimit = data.user_limit;
}
/**
* The voice connection for this voice channel, if the client is connected
* @type {?VoiceConnection}
* @readonly
*/
get connection() {
const connection = this.guild.voiceConnection;
if (connection && connection.channel.id === this.id) return connection;
return null;
}
/**
* Checks if the client has permission join the voice channel
* @type {boolean}
*/
get joinable() {
if (this.client.browser) return false;
return this.permissionsFor(this.client.user).hasPermission('CONNECT');
}
/**
* Checks if the client has permission to send audio to the voice channel
* @type {boolean}
*/
get speakable() {
return this.permissionsFor(this.client.user).hasPermission('SPEAK');
}
/**
* Sets the bitrate of the channel
* @param {number} bitrate The new bitrate
* @returns {Promise<VoiceChannel>}
* @example
* // set the bitrate of a voice channel
* voiceChannel.setBitrate(48000)
* .then(vc => console.log(`Set bitrate to ${vc.bitrate} for ${vc.name}`))
* .catch(console.error);
*/
setBitrate(bitrate) {
return this.edit({ bitrate });
}
/**
* Sets the user limit of the channel
* @param {number} userLimit The new user limit
* @returns {Promise<VoiceChannel>}
* @example
* // set the user limit of a voice channel
* voiceChannel.setUserLimit(42)
* .then(vc => console.log(`Set user limit to ${vc.userLimit} for ${vc.name}`))
* .catch(console.error);
*/
setUserLimit(userLimit) {
return this.edit({ userLimit });
}
/**
* Attempts to join this voice channel
* @returns {Promise<VoiceConnection>}
* @example
* // join a voice channel
* voiceChannel.join()
* .then(connection => console.log('Connected!'))
* .catch(console.error);
*/
join() {
if (this.client.browser) return Promise.reject(new Error('Voice connections are not available in browsers.'));
return this.client.voice.joinChannel(this);
}
/**
* Leaves this voice channel
* @example
* // leave a voice channel
* voiceChannel.leave();
*/
leave() {
if (this.client.browser) return;
const connection = this.client.voice.connections.get(this.guild.id);
if (connection && connection.channel.id === this.id) connection.disconnect();
}
}
module.exports = VoiceChannel;