Skip to content

Commit

Permalink
Deprecate and replace onUserSpeaking (#2496)
Browse files Browse the repository at this point in the history
  • Loading branch information
@MinnDevelopment
MinnDevelopment authored Jul 10, 2023
1 parent e513694 commit 1b6281c
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 6 deletions.
63 changes: 60 additions & 3 deletions src/main/java/net/dv8tion/jda/api/audio/hooks/ConnectionListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@

package net.dv8tion.jda.api.audio.hooks;

import net.dv8tion.jda.annotations.ForRemoval;
import net.dv8tion.jda.annotations.ReplaceWith;
import net.dv8tion.jda.api.audio.SpeakingMode;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.UserSnowflake;

import javax.annotation.Nonnull;
import java.util.EnumSet;
Expand Down Expand Up @@ -46,8 +49,6 @@ public interface ConnectionListener
*/
void onStatusChange(@Nonnull ConnectionStatus status);

// TODO: Deprecate and replace these onUserSpeaking methods.

/**
* This method is an easy way to detect if a user is talking. Discord sends us an event when a user starts or stops
* talking and it is parallel to the audio socket, so this event could come milliseconds before or after audio begins
Expand All @@ -69,8 +70,16 @@ public interface ConnectionListener
* Never-null {@link net.dv8tion.jda.api.entities.User User} who's talking status has changed.
* @param speaking
* If true, the user has begun transmitting audio.
*
* @deprecated This method no longer represents the actual speaking state of the user.
* Discord does not send updates when a user starts and stops speaking anymore.
* You can use {@link #onUserSpeakingModeUpdate(UserSnowflake, EnumSet)} to see when a user changes their speaking mode,
* or use an {@link net.dv8tion.jda.api.audio.AudioReceiveHandler AudioReceiveHandler} to check when a user is speaking.
*/
void onUserSpeaking(@Nonnull User user, boolean speaking);
@Deprecated
@ForRemoval
@ReplaceWith("onUserSpeakingModeUpdate(User, EnumSet<SpeakingMode>)")
default void onUserSpeaking(@Nonnull User user, boolean speaking) {}

/**
* This method is an easy way to detect if a user is talking. Discord sends us an event when a user starts or stops
Expand All @@ -97,7 +106,15 @@ public interface ConnectionListener
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.audio.SpeakingMode SpeakingMode
*
* @deprecated This method no longer represents the actual speaking state of the user.
* Discord does not send updates when a user starts and stops speaking anymore.
* You can use {@link #onUserSpeakingModeUpdate(UserSnowflake, EnumSet)} to see when a user changes their speaking mode,
* or use an {@link net.dv8tion.jda.api.audio.AudioReceiveHandler AudioReceiveHandler} to check when a user is speaking.
*/
@Deprecated
@ForRemoval
@ReplaceWith("onUserSpeakingModeUpdate(User, EnumSet<SpeakingMode>)")
default void onUserSpeaking(@Nonnull User user, @Nonnull EnumSet<SpeakingMode> modes) {}


Expand All @@ -124,6 +141,46 @@ default void onUserSpeaking(@Nonnull User user, @Nonnull EnumSet<SpeakingMode> m
* If true, the user has begun transmitting audio.
* @param soundshare
* If true, the user is using soundshare
*
* @deprecated This method no longer represents the actual speaking state of the user.
* Discord does not send updates when a user starts and stops speaking anymore.
* You can use {@link #onUserSpeakingModeUpdate(UserSnowflake, EnumSet)} to see when a user changes their speaking mode,
* or use an {@link net.dv8tion.jda.api.audio.AudioReceiveHandler AudioReceiveHandler} to check when a user is speaking.
*/
@Deprecated
@ForRemoval
@ReplaceWith("onUserSpeakingModeUpdate(User, EnumSet<SpeakingMode>)")
default void onUserSpeaking(@Nonnull User user, boolean speaking, boolean soundshare) {}

/**
* This method is used to listen for users changing their speaking mode.
* <p>Whenever a user joins a voice channel, this is fired once to define the initial speaking modes.
*
* <p>To detect when a user is speaking, a {@link net.dv8tion.jda.api.audio.AudioReceiveHandler AudioReceiveHandler} should be used instead.
*
* <p><b>Note:</b> This requires the user to be currently in the cache.
* You can use {@link net.dv8tion.jda.api.utils.MemberCachePolicy#VOICE MemberCachePolicy.VOICE} to cache currently connected users.
* Alternatively, use {@link #onUserSpeakingModeUpdate(UserSnowflake, EnumSet)} to avoid cache.
*
* @param user
* The user who changed their speaking mode
* @param modes
* The new speaking modes of the user
*/
default void onUserSpeakingModeUpdate(@Nonnull User user, @Nonnull EnumSet<SpeakingMode> modes) {}

/**
* This method is used to listen for users changing their speaking mode.
* <p>Whenever a user joins a voice channel, this is fired once to define the initial speaking modes.
*
* <p>To detect when a user is speaking, a {@link net.dv8tion.jda.api.audio.AudioReceiveHandler AudioReceiveHandler} should be used instead.
*
* <p>This method works independently of the user cache. The provided user might not be cached.
*
* @param user
* The user who changed their speaking mode
* @param modes
* The new speaking modes of the user
*/
default void onUserSpeakingModeUpdate(@Nonnull UserSnowflake user, @Nonnull EnumSet<SpeakingMode> modes) {}
}
23 changes: 22 additions & 1 deletion src/main/java/net/dv8tion/jda/api/audio/hooks/ListenerProxy.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

import net.dv8tion.jda.api.audio.SpeakingMode;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.UserSnowflake;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -94,7 +95,27 @@ public void onUserSpeaking(@Nonnull User user, @Nonnull EnumSet<SpeakingMode> mo
}

@Override
public void onUserSpeaking(@Nonnull User user, boolean speaking) {}
public void onUserSpeakingModeUpdate(@Nonnull UserSnowflake user, @Nonnull EnumSet<SpeakingMode> modes)
{
if (listener == null)
return;
ConnectionListener listener = this.listener;
try
{
if (listener != null)
{
listener.onUserSpeakingModeUpdate(user, modes);
if (user instanceof User)
listener.onUserSpeakingModeUpdate((User) user, modes);
}
}
catch (Throwable t)
{
log.error("The ConnectionListener encountered and uncaught exception", t);
if (t instanceof Error)
throw (Error) t;
}
}

public void setListener(ConnectionListener listener)
{
Expand Down
12 changes: 10 additions & 2 deletions src/main/java/net/dv8tion/jda/internal/audio/AudioWebSocket.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import net.dv8tion.jda.api.audio.hooks.ConnectionStatus;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.UserSnowflake;
import net.dv8tion.jda.api.entities.channel.middleman.AudioChannel;
import net.dv8tion.jda.api.events.ExceptionEvent;
import net.dv8tion.jda.api.utils.MiscUtil;
Expand Down Expand Up @@ -501,15 +502,22 @@ private void handleEvent(DataObject contentAll)
final long userId = content.getLong("user_id");

final User user = getUser(userId);

if (user == null)
{
//more relevant for audio connection
LOG.trace("Got an Audio USER_SPEAKING_UPDATE for a non-existent User. JSON: {}", contentAll);
break;
listener.onUserSpeakingModeUpdate(UserSnowflake.fromId(userId), speaking);
}
else
{
//noinspection deprecation
listener.onUserSpeaking(user, speaking);
listener.onUserSpeakingModeUpdate((UserSnowflake) user, speaking);
}

audioConnection.updateUserSSRC(ssrc, userId);
listener.onUserSpeaking(user, speaking);

break;
}
case VoiceCode.USER_DISCONNECT:
Expand Down

0 comments on commit 1b6281c

Please sign in to comment.