Package net.dv8tion.jda.internal.managers

Class AudioManagerImpl

java.lang.Object

net.dv8tion.jda.internal.managers.AudioManagerImpl

All Implemented Interfaces:

AudioManager

public class AudioManagerImpl
extends Object
implements AudioManager

Field Summary

Fields

Modifier and Type	Field	Description
final ReentrantLock	CONNECTION_LOCK

Fields inherited from interface net.dv8tion.jda.api.managers.AudioManager

DEFAULT_CONNECTION_TIMEOUT, LOG

Constructor Summary

Constructors

Constructor	Description
AudioManagerImpl(GuildImpl guild)

Method Summary

Modifier and Type	Method	Description
void	closeAudioConnection()	Close down the current audio connection of this Guild and disconnects from the AudioChannel.
void	closeAudioConnection(ConnectionStatus reason)
AudioConnection	getAudioConnection()
AudioChannelUnion	getConnectedChannel()	The AudioChannelUnion that JDA currently has an audio connection to.
ConnectionListener	getConnectionListener()	The currently set ConnectionListener or null if no ConnectionListener has been set.
ConnectionStatus	getConnectionStatus()	The current ConnectionStatus.
long	getConnectTimeout()	The currently set timeout value, in milliseconds, used when waiting for an audio connection to be established.
GuildImpl	getGuild()	Gets the Guild instance that this AudioManager is used for.
JDAImpl	getJDA()	Gets the JDA instance that this AudioManager is a part of.
ConnectionListener	getListenerProxy()
AudioReceiveHandler	getReceivingHandler()	The currently set AudioReceiveHandler.
AudioSendHandler	getSendingHandler()	The currently set AudioSendHandler.
EnumSet<SpeakingMode>	getSpeakingMode()	The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from AudioManager.setSendingHandler(AudioSendHandler).
boolean	isAutoReconnect()	Whether audio connections from this AudioManager automatically reconnect
boolean	isConnected()	This can be used to find out if JDA currently has an active audio connection with a AudioChannel.
boolean	isSelfDeafened()	Whether connections from this AudioManager are deafened.
boolean	isSelfMuted()	Whether connections from this AudioManager are muted, if this is true packages by the registered AudioSendHandler will be ignored by Discord.
void	openAudioConnection(AudioChannel channel)	Starts the process to create an audio connection with an AudioChannel or, if an audio connection is already open, JDA will move the connection to the provided AudioChannel.
void	setAudioConnection(AudioConnection audioConnection)
void	setAutoReconnect(boolean shouldReconnect)	Sets whether audio connections from this AudioManager should automatically reconnect or not.
void	setConnectedChannel(AudioChannel channel)
void	setConnectionListener(ConnectionListener listener)	Sets the ConnectionListener 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	setQueueTimeout(long queueTimeout)
void	setReceivingHandler(AudioReceiveHandler handler)	Sets the AudioReceiveHandler 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 to true if the current connection should be displayed as muted, this will cause the AudioSendHandler packages to not be ignored by Discord!
void	setSendingHandler(AudioSendHandler handler)	Sets the AudioSendHandler that the manager will use to provide audio data to an audio connection.
void	setSpeakingMode(Collection<SpeakingMode> mode)	The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from AudioManager.setSendingHandler(AudioSendHandler).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.managers.AudioManager

setSpeakingMode

Field Details

CONNECTION_LOCK

public final ReentrantLock CONNECTION_LOCK

Constructor Details

AudioManagerImpl

public AudioManagerImpl(GuildImpl guild)

Method Details

getAudioConnection

public AudioConnection getAudioConnection()

openAudioConnection

public void openAudioConnection(@Nonnull
 AudioChannel channel)

Description copied from interface: AudioManager

Starts the process to create an audio connection with an AudioChannel 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 single AudioChannel per Guild.

This method will automatically move the current connection if one connection is already open in this underlying Guild.
Current connections can be closed with AudioManager.closeAudioConnection().

Specified by:

openAudioConnection in interface AudioManager

Parameters:

channel - The AudioChannel to open an audio connection with.

closeAudioConnection

public void closeAudioConnection()

Description copied from interface: AudioManager

Close down the current audio connection of this Guild and disconnects from the AudioChannel.
If this is called when JDA doesn't have an audio connection, nothing happens.

Specified by:

closeAudioConnection in interface AudioManager

closeAudioConnection

public void closeAudioConnection(ConnectionStatus reason)

setSpeakingMode

public void setSpeakingMode(@Nonnull
 Collection<SpeakingMode> mode)

Description copied from interface: AudioManager

The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from AudioManager.setSendingHandler(AudioSendHandler). By default this will use SpeakingMode.VOICE.
Example: EnumSet.of(SpeakingMode.PRIORITY_SPEAKER, SpeakingMode.VOICE)

Specified by:

setSpeakingMode in interface AudioManager

Parameters:

mode - The speaking modes

See Also:

• AudioManager.getSpeakingMode()
• AudioManager.setSpeakingMode(SpeakingMode...)

getSpeakingMode

@Nonnull
public EnumSet<SpeakingMode> getSpeakingMode()

Description copied from interface: AudioManager

The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from AudioManager.setSendingHandler(AudioSendHandler). By default this will use SpeakingMode.VOICE.

Specified by:

getSpeakingMode in interface AudioManager

Returns:

The current speaking mode, represented in an EnumSet

See Also:

• AudioManager.setSpeakingMode(Collection)

getJDA

@Nonnull
public JDAImpl getJDA()

Description copied from interface: AudioManager

Gets the JDA instance that this AudioManager is a part of.

Specified by:

getJDA in interface AudioManager

Returns:

The corresponding JDA instance

getGuild

@Nonnull
public GuildImpl getGuild()

Description copied from interface: AudioManager

Gets the Guild instance that this AudioManager is used for.

Specified by:

getGuild in interface AudioManager

Returns:

The Guild that this AudioManager manages.

getConnectedChannel

public AudioChannelUnion getConnectedChannel()

Description copied from interface: AudioManager

The AudioChannelUnion that JDA currently has an audio connection to.
If JDA currently doesn't have an active audio connection, this will return null.

Specified by:

getConnectedChannel in interface AudioManager

Returns:

The AudioChannelUnion the audio connection is connected to, or null if not connected.

isConnected

public boolean isConnected()

Description copied from interface: AudioManager

This can be used to find out if JDA currently has an active audio connection with a AudioChannel. If this returns true, then AudioManager.getConnectedChannel() will return the AudioChannel which JDA is connected to.

Specified by:

isConnected in interface AudioManager

Returns:

True, if JDA currently has an active audio connection.

setConnectTimeout

public void setConnectTimeout(long timeout)

Description copied from interface: AudioManager

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.

Specified by:

setConnectTimeout in interface AudioManager

Parameters:

timeout - The amount of time, in milliseconds, that should be waited when waiting for the audio connection to be established.

getConnectTimeout

public long getConnectTimeout()

Description copied from interface: AudioManager

The currently set timeout value, in milliseconds, used when waiting for an audio connection to be established.

Specified by:

getConnectTimeout in interface AudioManager

Returns:

The currently set timeout.

setSendingHandler

public void setSendingHandler(AudioSendHandler handler)

Description copied from interface: AudioManager

Sets the AudioSendHandler that the manager will use to provide audio data to an audio connection.
The handler provided here will persist between audio connection connects 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.

Specified by:

setSendingHandler in interface AudioManager

Parameters:

handler - The AudioSendHandler used to provide audio data.

getSendingHandler

public AudioSendHandler getSendingHandler()

Description copied from interface: AudioManager

The currently set AudioSendHandler. If there is no sender currently set, this method will return null.

Specified by:

getSendingHandler in interface AudioManager

Returns:

The currently active AudioSendHandler or null.

setReceivingHandler

public void setReceivingHandler(AudioReceiveHandler handler)

Description copied from interface: AudioManager

Sets the AudioReceiveHandler 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.

Specified by:

setReceivingHandler in interface AudioManager

Parameters:

handler - The AudioReceiveHandler used to process received audio data.

getReceivingHandler

public AudioReceiveHandler getReceivingHandler()

Description copied from interface: AudioManager

The currently set AudioReceiveHandler. If there is no receiver currently set, this method will return null.

Specified by:

getReceivingHandler in interface AudioManager

Returns:

The currently active AudioReceiveHandler or null.

setConnectionListener

public void setConnectionListener(ConnectionListener listener)

Description copied from interface: AudioManager

Sets the ConnectionListener for this AudioManager. It will be informed about meta data of any audio connection established through this AudioManager. Further information can be found in the ConnectionListener documentation!

Specified by:

setConnectionListener in interface AudioManager

Parameters:

listener - A ConnectionListener instance

getConnectionListener

public ConnectionListener getConnectionListener()

Description copied from interface: AudioManager

The currently set ConnectionListener or null if no ConnectionListener has been set.

Specified by:

getConnectionListener in interface AudioManager

Returns:

The current ConnectionListener instance for this AudioManager.

getConnectionStatus

@Nonnull
public ConnectionStatus getConnectionStatus()

Description copied from interface: AudioManager

The current ConnectionStatus.
This status indicates represents the connection status of an audio connection.

Specified by:

getConnectionStatus in interface AudioManager

Returns:

The current ConnectionStatus.

setAutoReconnect

public void setAutoReconnect(boolean shouldReconnect)

Description copied from interface: AudioManager

Sets whether audio connections from this AudioManager should automatically reconnect or not. Default true

Specified by:

setAutoReconnect in interface AudioManager

Parameters:

shouldReconnect - Whether audio connections from this AudioManager should automatically reconnect

isAutoReconnect

public boolean isAutoReconnect()

Description copied from interface: AudioManager

Whether audio connections from this AudioManager automatically reconnect

Specified by:

isAutoReconnect in interface AudioManager

Returns:

Whether audio connections from this AudioManager automatically reconnect

setSelfMuted

public void setSelfMuted(boolean muted)

Description copied from interface: AudioManager

Set this to true if the current connection should be displayed as muted, this will cause the AudioSendHandler packages to not be ignored by Discord!

Specified by:

setSelfMuted in interface AudioManager

Parameters:

muted - Whether the connection should stop sending audio and display as muted.

isSelfMuted

public boolean isSelfMuted()

Description copied from interface: AudioManager

Whether connections from this AudioManager are muted, if this is true packages by the registered AudioSendHandler will be ignored by Discord.

Specified by:

isSelfMuted in interface AudioManager

Returns:

Whether connections from this AudioManager are muted

setSelfDeafened

public void setSelfDeafened(boolean deafened)

Description copied from interface: AudioManager

Sets whether connections from this AudioManager should be deafened.
This does not include being muted, that value can be set individually from AudioManager.setSelfMuted(boolean) and checked via AudioManager.isSelfMuted()

Specified by:

setSelfDeafened in interface AudioManager

Parameters:

deafened - Whether connections from this AudioManager should be deafened.

isSelfDeafened

public boolean isSelfDeafened()

Description copied from interface: AudioManager

Whether connections from this AudioManager are deafened.
This does not include being muted, that value can be set individually from AudioManager.setSelfMuted(boolean) and checked via AudioManager.isSelfMuted()

Specified by:

isSelfDeafened in interface AudioManager

Returns:

True, if connections from this AudioManager are deafened

getListenerProxy

public ConnectionListener getListenerProxy()

setAudioConnection

public void setAudioConnection(AudioConnection audioConnection)

setConnectedChannel

public void setConnectedChannel(AudioChannel channel)

setQueueTimeout

public void setQueueTimeout(long queueTimeout)