Interface GuildVoiceState

    • Method Detail

      • 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
      • 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.
      • getMember

        @Nonnull
        Member getMember()
        Returns the Member corresponding to this GuildVoiceState instance (Backreference)
        Returns:
        the Member that holds this GuildVoiceState
      • getSessionId

        @Nullable
        java.lang.String getSessionId()
        The Session-Id for this VoiceState
        Returns:
        The Session-Id
      • getRequestToSpeakTimestamp

        @Nullable
        java.time.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