Package net.dv8tion.jda.core.entities

Interface GuildVoiceState

All Superinterfaces:

VoiceState

public interface GuildVoiceState
extends VoiceState

Represents the voice state of a Member in a Guild.

Method Summary

Modifier and Type	Method	Description
VoiceChannel	getChannel()	Returns the current VoiceChannel that the Member is in.
Guild	getGuild()	Returns the current Guild of the Member's VoiceChannel.
Member	getMember()	Returns the Member corresponding to this GuildVoiceState instance (Backreference)
boolean	inVoiceChannel()	Used to determine if the Member is currently in a VoiceChannel in the Guild returned from getGuild(). If this is false, getChannel() will return null.
boolean	isDeafened()	Returns whether the Member is deafened, either by choice VoiceState.isSelfDeafened() or deafened by an admin isGuildDeafened()
boolean	isGuildDeafened()	Returns whether the Member got deafened by an Admin
boolean	isGuildMuted()	Returns whether the Member got muted by an Admin
boolean	isMuted()	Returns whether the Member is muted, either by choice VoiceState.isSelfMuted() or deafened by an admin isGuildMuted()
boolean	isSuppressed()	Returns true if this Member is unable to speak because the channel is actively suppressing audio communication.

Methods inherited from interface net.dv8tion.jda.core.entities.VoiceState

getAudioChannel, getJDA, getSessionId, isSelfDeafened, isSelfMuted

Method Detail

isMuted

boolean isMuted()

Returns whether the Member is muted, either by choice VoiceState.isSelfMuted() or deafened by an admin isGuildMuted()

Returns:

the Member's mute status

isDeafened

boolean isDeafened()

Returns whether the Member is deafened, either by choice VoiceState.isSelfDeafened() or deafened by an admin isGuildDeafened()

Returns:

the Member's deaf status

isGuildMuted

boolean isGuildMuted()

Returns whether the Member got muted by an Admin

Returns:

the Member's guild-mute status

isGuildDeafened

boolean isGuildDeafened()

Returns whether the Member got deafened by an Admin

Returns:

the Member's guild-deaf status

isSuppressed

boolean isSuppressed()

Returns true if this Member is unable to speak because the channel is actively suppressing audio communication. This occurs only in VoiceChannels where the Member either doesn't have Permission#VOICE_SPEAK or if the channel is the designated AFK channel.

Returns:

True, if this Member's audio is being suppressed.

getChannel

VoiceChannel getChannel()

Returns the current VoiceChannel that the Member is in. If the Member is currently not in a VoiceChannel, this returns null.

Returns:

The VoiceChannel that the Member is in, or null.

getGuild

Guild getGuild()

Returns the current Guild of the Member's VoiceChannel. If the Member is currently not in a VoiceChannel, this returns null

Returns:

the Member's Guild

getMember

Member getMember()

Returns the Member corresponding to this GuildVoiceState instance (Backreference)

Returns:

the Member that holds this GuildVoiceState

inVoiceChannel

boolean inVoiceChannel()

Used to determine if the Member is currently in a VoiceChannel in the Guild returned from getGuild().
If this is false, getChannel() will return null.

Returns:

True, if the Member is currently in a VoiceChannel in this Guild.