Package net.dv8tion.jda.api.managers
Interface AudioManager
public interface AudioManager
AudioManager deals with creating, managing and severing audio connections to
VoiceChannels
. Also controls audio handlers.- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final long
static final org.slf4j.Logger
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Close down the current audio connection of thisGuild
and disconnects from theAudioChannel
.TheAudioChannelUnion
that JDA currently has an audio connection to.The currentConnectionStatus
.long
The currently set timeout value, in milliseconds, used when waiting for an audio connection to be established.getGuild()
Gets theGuild
instance that this AudioManager is used for.getJDA()
Gets theJDA
instance that this AudioManager is a part of.The currently setAudioReceiveHandler
.The currently setAudioSendHandler
.TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
.boolean
Whether audio connections from this AudioManager automatically reconnectboolean
This can be used to find out if JDA currently has an active audio connection with aAudioChannel
.boolean
Whether connections from this AudioManager are deafened.boolean
Whether connections from this AudioManager are muted, if this istrue
packages by the registeredAudioSendHandler
will be ignored by Discord.void
openAudioConnection
(AudioChannel channel) Starts the process to create an audio connection with anAudioChannel
or, if an audio connection is already open, JDA will move the connection to the provided AudioChannel.void
setAutoReconnect
(boolean shouldReconnect) Sets whether audio connections from this AudioManager should automatically reconnect or not.void
setConnectionListener
(ConnectionListener listener) Sets theConnectionListener
for this AudioManager.void
setConnectTimeout
(long timeout) Sets the amount of time, in milliseconds, that will be used as the timeout when waiting for the audio connection to successfully connect.void
setReceivingHandler
(AudioReceiveHandler handler) Sets theAudioReceiveHandler
that the manager will use to process audio data received from an audio connection.void
setSelfDeafened
(boolean deafened) Sets whether connections from this AudioManager should be deafened.void
setSelfMuted
(boolean muted) Set this totrue
if the current connection should be displayed as muted, this will cause theAudioSendHandler
packages to not be ignored by Discord!void
setSendingHandler
(AudioSendHandler handler) Sets theAudioSendHandler
that the manager will use to provide audio data to an audio connection.void
TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
.default void
setSpeakingMode
(SpeakingMode... mode) TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
.
-
Field Details
-
DEFAULT_CONNECTION_TIMEOUT
static final long DEFAULT_CONNECTION_TIMEOUT- See Also:
-
LOG
static final org.slf4j.Logger LOG
-
-
Method Details
-
openAudioConnection
Starts the process to create an audio connection with anAudioChannel
or, if an audio connection is already open, JDA will move the connection to the provided AudioChannel.
Note: Currently you can only be connected to a singleAudioChannel
perGuild
.This method will automatically move the current connection if one connection is already open in this underlying
Guild
.
Current connections can be closed withcloseAudioConnection()
.- Parameters:
channel
- TheAudioChannel
to open an audio connection with.- Throws:
IllegalArgumentException
-- If the provided channel was
null
. - If the provided channel is not part of the Guild that the current audio connection is connected to.
- If the provided channel was
UnsupportedOperationException
- If audio is disabled due to an internal JDA errorInsufficientPermissionException
-- If the currently logged in account does not have the Permission
VOICE_CONNECT
- If the currently logged in account does not have the Permission
VOICE_MOVE_OTHERS
and theuser limit
has been exceeded!
- If the currently logged in account does not have the Permission
-
closeAudioConnection
void closeAudioConnection()Close down the current audio connection of thisGuild
and disconnects from theAudioChannel
.
If this is called when JDA doesn't have an audio connection, nothing happens. -
setSpeakingMode
TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
. By default this will useSpeakingMode.VOICE
.
Example:EnumSet.of(SpeakingMode.PRIORITY_SPEAKER, SpeakingMode.VOICE)
- Parameters:
mode
- The speaking modes- Throws:
IllegalArgumentException
- If the provided collection is null or empty- See Also:
- Incubating:
- Discord has not officially confirmed that this feature will be available to bots
-
setSpeakingMode
TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
. By default this will useSpeakingMode.VOICE
.- Parameters:
mode
- The speaking modes- Throws:
IllegalArgumentException
- If the provided array is null or empty- See Also:
- Incubating:
- Discord has not officially confirmed that this feature will be available to bots
-
getSpeakingMode
TheSpeakingMode
that should be used when sending audio via the providedAudioSendHandler
fromsetSendingHandler(AudioSendHandler)
. By default this will useSpeakingMode.VOICE
.- Returns:
- The current speaking mode, represented in an
EnumSet
- See Also:
- Incubating:
- Discord has not officially confirmed that this feature will be available to bots
-
getJDA
Gets theJDA
instance that this AudioManager is a part of.- Returns:
- The corresponding JDA instance
-
getGuild
Gets theGuild
instance that this AudioManager is used for.- Returns:
- The Guild that this AudioManager manages.
-
getConnectedChannel
TheAudioChannelUnion
that JDA currently has an audio connection to.
If JDA currently doesn't have an active audio connection, this will returnnull
.- Returns:
- The
AudioChannelUnion
the audio connection is connected to, ornull
if not connected.
-
isConnected
boolean isConnected()This can be used to find out if JDA currently has an active audio connection with aAudioChannel
. If this returns true, thengetConnectedChannel()
will return theAudioChannel
which JDA is connected to.- Returns:
- True, if JDA currently has an active audio connection.
-
setConnectTimeout
void setConnectTimeout(long timeout) Sets the amount of time, in milliseconds, that will be used as the timeout when waiting for the audio connection to successfully connect. The default value is 10 second (10,000 milliseconds).
Note: If you set this value to 0, you can remove timeout functionality and JDA will wait FOREVER for the connection to be established. This is no advised as it is possible that the connection may never be established.- Parameters:
timeout
- The amount of time, in milliseconds, that should be waited when waiting for the audio connection to be established.
-
getConnectTimeout
long getConnectTimeout()The currently set timeout value, in milliseconds, used when waiting for an audio connection to be established.- Returns:
- The currently set timeout.
-
setSendingHandler
Sets theAudioSendHandler
that the manager will use to provide audio data to an audio connection.
The handler provided here will persist between audio connection connect and disconnects. Furthermore, you don't need to have an audio connection to set a handler. When JDA sets up a new audio connection it will use the handler provided here.
Setting this to null will remove the audio handler.JDA recommends LavaPlayer as an
AudioSendHandler
. It provides a demo targeted at JDA users.- Parameters:
handler
- TheAudioSendHandler
used to provide audio data.
-
getSendingHandler
The currently setAudioSendHandler
. If there is no sender currently set, this method will returnnull
.- Returns:
- The currently active
AudioSendHandler
ornull
.
-
setReceivingHandler
Sets theAudioReceiveHandler
that the manager will use to process audio data received from an audio connection.The handler provided here will persist between audio connection connect and disconnects. Furthermore, you don't need to have an audio connection to set a handler. When JDA sets up a new audio connection it will use the handler provided here.
Setting this to null will remove the audio handler.- Parameters:
handler
- TheAudioReceiveHandler
used to process received audio data.
-
getReceivingHandler
The currently setAudioReceiveHandler
. If there is no receiver currently set, this method will returnnull
.- Returns:
- The currently active
AudioReceiveHandler
ornull
.
-
setConnectionListener
Sets theConnectionListener
for this AudioManager. It will be informed about meta data of any audio connection established through this AudioManager. Further information can be found in theConnectionListener
documentation!- Parameters:
listener
- AConnectionListener
instance
-
getConnectionListener
- Returns:
- The current
ConnectionListener
instance for this AudioManager.
-
getConnectionStatus
The currentConnectionStatus
.
This status indicates represents the connection status of an audio connection.- Returns:
- The current
ConnectionStatus
.
-
setAutoReconnect
void setAutoReconnect(boolean shouldReconnect) Sets whether audio connections from this AudioManager should automatically reconnect or not. Defaulttrue
- Parameters:
shouldReconnect
- Whether audio connections from this AudioManager should automatically reconnect
-
isAutoReconnect
boolean isAutoReconnect()Whether audio connections from this AudioManager automatically reconnect- Returns:
- Whether audio connections from this AudioManager automatically reconnect
-
setSelfMuted
void setSelfMuted(boolean muted) Set this totrue
if the current connection should be displayed as muted, this will cause theAudioSendHandler
packages to not be ignored by Discord!- Parameters:
muted
- Whether the connection should stop sending audio and display as muted.
-
isSelfMuted
boolean isSelfMuted()Whether connections from this AudioManager are muted, if this istrue
packages by the registeredAudioSendHandler
will be ignored by Discord.- Returns:
- Whether connections from this AudioManager are muted
-
setSelfDeafened
void setSelfDeafened(boolean deafened) Sets whether connections from this AudioManager should be deafened.
This does not include being muted, that value can be set individually fromsetSelfMuted(boolean)
and checked viaisSelfMuted()
- Parameters:
deafened
- Whether connections from this AudioManager should be deafened.
-
isSelfDeafened
boolean isSelfDeafened()Whether connections from this AudioManager are deafened.
This does not include being muted, that value can be set individually fromsetSelfMuted(boolean)
and checked viaisSelfMuted()
- Returns:
- True, if connections from this AudioManager are deafened
-