'use strict'; const Base = require('./Base'); const { Error, TypeError } = require('../errors'); /** * Represents the voice state for a Guild Member. */ class VoiceState extends Base { /** * @param {Guild} guild The guild the voice state is part of * @param {Object} data The data for the voice state */ constructor(guild, data) { super(guild.client); /** * The guild of this voice state * @type {Guild} */ this.guild = guild; /** * The ID of the member of this voice state * @type {Snowflake} */ this.id = data.user_id; this._patch(data); } _patch(data) { /** * Whether this member is deafened server-wide * @type {?boolean} */ this.serverDeaf = 'deaf' in data ? data.deaf : null; /** * Whether this member is muted server-wide * @type {?boolean} */ this.serverMute = 'mute' in data ? data.mute : null; /** * Whether this member is self-deafened * @type {?boolean} */ this.selfDeaf = 'self_deaf' in data ? data.self_deaf : null; /** * Whether this member is self-muted * @type {?boolean} */ this.selfMute = 'self_mute' in data ? data.self_mute : null; /** * Whether this member's camera is enabled * @type {?boolean} */ this.selfVideo = 'self_video' in data ? data.self_video : null; /** * The session ID of this member's connection * @type {?string} */ this.sessionID = 'session_id' in data ? data.session_id : null; /** * Whether this member is streaming using "Go Live" * @type {boolean} */ this.streaming = data.self_stream || false; /** * The ID of the voice or stage channel that this member is in * @type {?Snowflake} */ this.channelID = data.channel_id || null; /** * Whether this member is suppressed from speaking. This property is specific to stage channels only. * @type {boolean} */ this.suppress = data.suppress; /** * The time at which the member requested to speak. This property is specific to stage channels only. * @type {?number} */ this.requestToSpeakTimestamp = data.request_to_speak_timestamp ? new Date(data.request_to_speak_timestamp).getTime() : null; return this; } /** * The member that this voice state belongs to * @type {?GuildMember} * @readonly */ get member() { return this.guild.members.cache.get(this.id) || null; } /** * The channel that the member is connected to * @type {?VoiceChannel|StageChannel} * @readonly */ get channel() { return this.guild.channels.cache.get(this.channelID) || null; } /** * If this is a voice state of the client user, then this will refer to the active VoiceConnection for this guild * @type {?VoiceConnection} * @readonly */ get connection() { if (this.id !== this.client.user.id) return null; return this.client.voice.connections.get(this.guild.id) || null; } /** * Whether this member is either self-deafened or server-deafened * @type {?boolean} * @readonly */ get deaf() { return this.serverDeaf || this.selfDeaf; } /** * Whether this member is either self-muted or server-muted * @type {?boolean} * @readonly */ get mute() { return this.serverMute || this.selfMute; } /** * Whether this member is currently speaking. A boolean if the information is available (aka * the bot is connected to any voice channel or stage channel in the guild), otherwise this is `null` * @type {?boolean} * @readonly */ get speaking() { return this.channel && this.channel.connection ? Boolean(this.channel.connection._speaking.get(this.id)) : null; } /** * Mutes/unmutes the member of this voice state. * @param {boolean} mute Whether or not the member should be muted * @param {string} [reason] Reason for muting or unmuting * @returns {Promise} */ setMute(mute, reason) { return this.member ? this.member.edit({ mute }, reason) : Promise.reject(new Error('VOICE_STATE_UNCACHED_MEMBER')); } /** * Deafens/undeafens the member of this voice state. * @param {boolean} deaf Whether or not the member should be deafened * @param {string} [reason] Reason for deafening or undeafening * @returns {Promise} */ setDeaf(deaf, reason) { return this.member ? this.member.edit({ deaf }, reason) : Promise.reject(new Error('VOICE_STATE_UNCACHED_MEMBER')); } /** * Kicks the member from the channel. * @param {string} [reason] Reason for kicking member from the channel * @returns {Promise} */ kick(reason) { return this.setChannel(null, reason); } /** * Moves the member to a different channel, or disconnects them from the one they're in. * @param {ChannelResolvable|null} [channel] Channel to move the member to, or `null` if you want to disconnect them * from voice. * @param {string} [reason] Reason for moving member to another channel or disconnecting * @returns {Promise} */ setChannel(channel, reason) { return this.member ? this.member.edit({ channel }, reason) : Promise.reject(new Error('VOICE_STATE_UNCACHED_MEMBER')); } /** * Self-mutes/unmutes the bot for this voice state. * @param {boolean} mute Whether or not the bot should be self-muted * @returns {Promise} true if the voice state was successfully updated, otherwise false */ async setSelfMute(mute) { if (this.id !== this.client.user.id) throw new Error('VOICE_STATE_NOT_OWN'); if (typeof mute !== 'boolean') throw new TypeError('VOICE_STATE_INVALID_TYPE', 'mute'); if (!this.connection) return false; this.selfMute = mute; await this.connection.sendVoiceStateUpdate(); return true; } /** * Self-deafens/undeafens the bot for this voice state. * @param {boolean} deaf Whether or not the bot should be self-deafened * @returns {Promise} true if the voice state was successfully updated, otherwise false */ async setSelfDeaf(deaf) { if (this.id !== this.client.user.id) return new Error('VOICE_STATE_NOT_OWN'); if (typeof deaf !== 'boolean') return new TypeError('VOICE_STATE_INVALID_TYPE', 'deaf'); if (!this.connection) return false; this.selfDeaf = deaf; await this.connection.sendVoiceStateUpdate(); return true; } /** * Toggles the request to speak in the channel. * Only applicable for stage channels and for the client's own voice state. * @param {boolean} request Whether or not the client is requesting to become a speaker. * @example * // Making the client request to speak in a stage channel (raise its hand) * guild.me.voice.setRequestToSpeak(true); * @example * // Making the client cancel a request to speak * guild.me.voice.setRequestToSpeak(false); * @returns {Promise} */ async setRequestToSpeak(request) { const channel = this.channel; if (channel?.type !== 'stage') throw new Error('VOICE_NOT_STAGE_CHANNEL'); if (this.client.user.id !== this.id) throw new Error('VOICE_STATE_NOT_OWN'); await this.client.api.guilds(this.guild.id, 'voice-states', '@me').patch({ data: { channel_id: this.channelID, request_to_speak_timestamp: request ? new Date().toISOString() : null, }, }); } /** * Suppress/unsuppress the user. Only applicable for stage channels. * @param {boolean} suppressed - Whether or not the user should be suppressed. * @example * // Making the client a speaker * guild.me.voice.setSuppressed(false); * @example * // Making the client an audience member * guild.me.voice.setSuppressed(true); * @example * // Inviting another user to speak * voiceState.setSuppressed(false); * @example * // Moving another user to the audience, or cancelling their invite to speak * voiceState.setSuppressed(true); * @returns {Promise} */ async setSuppressed(suppressed) { if (typeof suppressed !== 'boolean') throw new TypeError('VOICE_STATE_INVALID_TYPE', 'suppressed'); const channel = this.channel; if (channel?.type !== 'stage') throw new Error('VOICE_NOT_STAGE_CHANNEL'); const target = this.client.user.id === this.id ? '@me' : this.id; await this.client.api.guilds(this.guild.id, 'voice-states', target).patch({ data: { channel_id: this.channelID, suppress: suppressed, }, }); } toJSON() { return super.toJSON({ id: true, serverDeaf: true, serverMute: true, selfDeaf: true, selfMute: true, sessionID: true, channelID: 'channel', }); } } module.exports = VoiceState;