Package net.dv8tion.jda.api.entities

Interface GuildVoiceState

All Superinterfaces:

ISnowflake

public interface GuildVoiceState
extends ISnowflake

Represents the voice state of a Member in a Guild.

See Also:

• Member.getVoiceState()

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	approveSpeaker()	Promote the member to speaker.
RestAction<Void>	declineSpeaker()	Reject this members request to speak or moves a speaker back to the audience.
AudioChannelUnion	getChannel()	Returns the current AudioChannelUnion that the Member is in.
Guild	getGuild()	Returns the Guild for the Member that this GuildVoiceState belongs to.
JDA	getJDA()	Returns the JDA instance of this VoiceState
Member	getMember()	Returns the Member corresponding to this GuildVoiceState instance (BackReference)
OffsetDateTime	getRequestToSpeakTimestamp()	The time at which the user requested to speak.
String	getSessionId()	The Session-Id for this VoiceState
boolean	inAudioChannel()	Used to determine if the Member is currently connected to an AudioChannel in the Guild returned from getGuild().
RestAction<Void>	inviteSpeaker()	Invite this member to become a speaker.
boolean	isDeafened()	Returns whether the Member is deafened, either by choice 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 isSelfMuted() or muted by an admin isGuildMuted()
boolean	isSelfDeafened()	Returns whether the Member deafened themselves.
boolean	isSelfMuted()	Returns whether the Member muted themselves.
boolean	isSendingVideo()	Returns true if this Member has their camera turned on.
boolean	isStream()	Returns true if this Member is currently streaming with Go Live.
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.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance of this VoiceState

Returns:

The corresponding JDA instance

isSelfMuted

boolean isSelfMuted()

Returns whether the Member muted themselves.

Returns:

The User's self-mute status

isSelfDeafened

boolean isSelfDeafened()

Returns whether the Member deafened themselves.

Returns:

The User's self-deaf status

isMuted

boolean isMuted()

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

Returns:

the Member's mute status

isDeafened

boolean isDeafened()

Returns whether the Member is deafened, either by choice 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 in VoiceChannels where the Member either doesn't have Permission#VOICE_SPEAK or if the channel is the designated AFK channel.
This is also used by StageChannels for listeners without speaker approval.

Returns:

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

See Also:

• getRequestToSpeakTimestamp()

isStream

boolean isStream()

Returns true if this Member is currently streaming with Go Live.

Returns:

True, if this member is streaming

isSendingVideo

boolean isSendingVideo()

Returns true if this Member has their camera turned on.
This does not include streams! See isStream()

Returns:

True, if this member has their camera turned on.

getChannel

@Nullable
AudioChannelUnion getChannel()

Returns the current AudioChannelUnion that the Member is in. If the Member is currently not connected to a AudioChannel, this returns null.

Note: This will return null if the member is not cached! You can use MemberCachePolicy.VOICE to cache members in voice channels.

Returns:

The AudioChannelUnion that the Member is connected to, or null.

getGuild

@Nonnull
Guild getGuild()

Returns the Guild for the Member that this GuildVoiceState belongs to.

Returns:

the Member's Guild

getMember

@Nonnull
Member getMember()

Returns the Member corresponding to this GuildVoiceState instance (BackReference)

Returns:

the Member that holds this GuildVoiceState

inAudioChannel

boolean inAudioChannel()

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

Returns:

True, if the Member is currently connected to an AudioChannel in this Guild

getSessionId

@Nullable
String getSessionId()

The Session-Id for this VoiceState

Returns:

The Session-Id

getRequestToSpeakTimestamp

@Nullable
OffsetDateTime getRequestToSpeakTimestamp()

The time at which the user requested to speak.
This is used for StageChannels and can only be approved by members with Permission.VOICE_MUTE_OTHERS on the channel.

Returns:

The request to speak timestamp, or null if this user didn't request to speak

approveSpeaker

@Nonnull
@CheckReturnValue
RestAction<Void> approveSpeaker()

Promote the member to speaker.

This requires a non-null getRequestToSpeakTimestamp(). You can use inviteSpeaker() to invite the member to become a speaker if they haven't requested to speak.

This does nothing if the member is not connected to a StageChannel.

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.VOICE_MUTE_OTHERS in the associated StageChannel

declineSpeaker

@Nonnull
@CheckReturnValue
RestAction<Void> declineSpeaker()

Reject this members request to speak or moves a speaker back to the audience.

This requires a non-null getRequestToSpeakTimestamp(). The member will have to request to speak again.

This does nothing if the member is not connected to a StageChannel.

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.VOICE_MUTE_OTHERS in the associated StageChannel

inviteSpeaker

@Nonnull
@CheckReturnValue
RestAction<Void> inviteSpeaker()

Invite this member to become a speaker.

This does nothing if the member is not connected to a StageChannel.

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.VOICE_MUTE_OTHERS in the associated StageChannel