Package net.dv8tion.jda.api.entities
Interface GuildVoiceState
-
public interface GuildVoiceState- See Also:
Member.getVoiceState()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VoiceChannelgetChannel()Returns the currentVoiceChannelthat theMemberis in.GuildgetGuild()JDAgetJDA()Returns theJDAinstance of this VoiceStateMembergetMember()Returns theMembercorresponding to this GuildVoiceState instance (Backreference)StringgetSessionId()The Session-Id for this VoiceStatebooleaninVoiceChannel()Used to determine if theMemberis currently in aVoiceChannelin theGuildreturned fromgetGuild().
If this isfalse,getChannel()will returnnull.booleanisDeafened()Returns whether theMemberis deafened, either by choiceisSelfDeafened()or deafened by an adminisGuildDeafened()booleanisGuildDeafened()Returns whether theMembergot deafened by an AdminbooleanisGuildMuted()Returns whether theMembergot muted by an AdminbooleanisMuted()Returns whether theMemberis muted, either by choiceisSelfMuted()or deafened by an adminisGuildMuted()booleanisSelfDeafened()Returns whether theMemberdeafened themselves.booleanisSelfMuted()Returns whether theMembermuted themselves.booleanisStream()Returns true if thisMemberis currently streaming with Go Live.booleanisSuppressed()Returns true if thisMemberis unable to speak because the channel is actively suppressing audio communication.
-
-
-
Method Detail
-
getJDA
@Nonnull JDA getJDA()
Returns theJDAinstance of this VoiceState- Returns:
- The corresponding JDA instance
-
isSelfMuted
boolean isSelfMuted()
Returns whether theMembermuted themselves.- Returns:
- The User's self-mute status
-
isSelfDeafened
boolean isSelfDeafened()
Returns whether theMemberdeafened themselves.- Returns:
- The User's self-deaf status
-
isMuted
boolean isMuted()
Returns whether theMemberis muted, either by choiceisSelfMuted()or deafened by an adminisGuildMuted()- Returns:
- the Member's mute status
-
isDeafened
boolean isDeafened()
Returns whether theMemberis deafened, either by choiceisSelfDeafened()or deafened by an adminisGuildDeafened()- Returns:
- the Member's deaf status
-
isGuildMuted
boolean isGuildMuted()
Returns whether theMembergot muted by an Admin- Returns:
- the Member's guild-mute status
-
isGuildDeafened
boolean isGuildDeafened()
Returns whether theMembergot deafened by an Admin- Returns:
- the Member's guild-deaf status
-
isSuppressed
boolean isSuppressed()
Returns true if thisMemberis unable to speak because the channel is actively suppressing audio communication. This occurs only inVoiceChannelswhere the Member either doesn't havePermission#VOICE_SPEAKor if the channel is the designated AFK channel.- Returns:
- True, if this
Member'saudio is being suppressed.
-
isStream
boolean isStream()
Returns true if thisMemberis currently streaming with Go Live.- Returns:
- True, if this member is streaming
-
getChannel
@Nullable VoiceChannel getChannel()
Returns the currentVoiceChannelthat theMemberis in. If theMemberis currently not in aVoiceChannel, this returns null.- Returns:
- The VoiceChannel that the Member is in, or null.
-
getGuild
@Nonnull Guild getGuild()
Returns the currentGuildof theMember'sVoiceChannel. If theMemberis currently not in aVoiceChannel, this returns null- Returns:
- the Member's Guild
-
getMember
@Nonnull Member getMember()
Returns theMembercorresponding to this GuildVoiceState instance (Backreference)- Returns:
- the Member that holds this GuildVoiceState
-
inVoiceChannel
boolean inVoiceChannel()
Used to determine if theMemberis currently in aVoiceChannelin theGuildreturned fromgetGuild().
If this isfalse,getChannel()will returnnull.- Returns:
- True, if the
Memberis currently in aVoiceChannelin thisGuild.
-
-