Bot is unable to stream audio on stage in certain scenarios

rxsto commented 4 months ago

General Troubleshooting

[X] I have checked for similar issues on the Issue-tracker.
[X] I have checked for PRs that might already address this issue.

Version of JDA

5.0.0-beta.22

Expected Behaviour

When joining a stage, the bot should be able to stream audio in all cases.

The original discussion about this behavior started in a help post on the JDA Discord server: https://discord.com/channels/125227483518861312/1229423364385538150/1229423364385538150

While building the reproduction repo we were able to further define the underlying issue, as this only happens in very specific cases.

(Scenario 1) The bot is unable to send audio to the stage channel, when these steps are followed:

Supply the bot with the stage moderator permissions
Start a stage by yourself
Let the bot join via typing !play in a text channel The bot will the join the stage and automatically be promoted to a speaker as it has the moderator permissions, but it will not transmit any audio.

(Scenario 2) This issue can be resolved by using following workaround:

Remove the stage moderator permissions from the bot
Start the stage yourself
Let the bot join via typing !play in a text channel
Accept the bot as a speaker when it raises its hand The bot will then be able to stream audio properly. Removing the bot from the stage by using !kill and repeating all the steps from Scenario 1 will allow the bot to properly stream audio regardless. This might be due to the bot having the stage instance loaded properly before.

(Scenario 3) The bot is able to steam audio in an active stage, as long as it has started it itself:

Join the stage without starting it
Supply the bot with stage moderator permissions
Use the command !play and let the bot join the stage as well as start it The bot will be promoted to being a speaker immediately, the same as in Scenario 1, but is able to start streaming audio since the stage has been created by itself.

When disconnecting and killing the bot application (as in restarting) whilst it was able to properly stream audio to the channel as a stage moderator, and getting it to play audio again via !play, it will fail again. This might as well be related to the same issue explained in the workaround from Scenario 2.

Code Example for Reproduction Steps

https://github.com/rxsto/jda-stage-repro

Code for JDABuilder or DefaultShardManagerBuilder used

https://github.com/rxsto/jda-stage-repro

Exception or Error

N/A

MinnDevelopment commented 4 months ago

Could this be a race condition issue on discord's end? It seems like simply delaying the request to speak a bit solves the problem for me.

rxsto commented 4 months ago

Interesting catch! And yes indeed, delaying the request to speak seems to solve this problem, at least sometimes. The durations I tested delaying the request to speak with seemed quite arbitrary, since sometimes the exact same amount of delay failed to mitigate the issue, and at other times it worked perfectly fine.

Using 500 milliseconds as the delay seems to be quite consistent though.

Regardless, we're pretty unsure as to how to figure out, if this problem could potentially be on Discord's end.

MinnDevelopment commented 4 months ago

It seems like discord has issues if you send it before the audio gateway is fully connected, you can listen for this using ConnectionListener.

audioManager.setConnectionListener(new ConnectionListener() {
  @Override
  public void onStatusChange(ConnectionStatus status) {
    if (status == CONNECTED) {
     channel.requestToSpeak().queue();
    }
  }
});

rxsto commented 4 months ago

That's it! Awaiting the CONNECTED status resolves this issue for us. Again, interesting catch - it doesn't really make sense how a requestToSpeak request can cause the audio streaming to break.

Thanks for figuring this out! ~ Cheers

discord-jda / JDA