AudioManager (JDA 3.8.1

```
public interface AudioManager
```
AudioManager deals with creating, managing and severing audio connections to VoiceChannels. Also controls audio handlers.

Field Summary

Fields
Modifier and Type Field Description

static long DEFAULT_CONNECTION_TIMEOUT

static org.slf4j.Logger LOG

Fields
Modifier and Type	Field	Description
`static long`	`DEFAULT_CONNECTION_TIMEOUT`
`static org.slf4j.Logger`	`LOG`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`closeAudioConnection()`	Close down the current audio connection of this `Guild` and disconnects from the `VoiceChannel`.
`VoiceChannel`	`getConnectedChannel()`	The `VoiceChannel` 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.
`Guild`	`getGuild()`	Gets the `Guild` instance that this AudioManager is used for.
`JDA`	`getJDA()`	Gets the `JDA` instance that this AudioManager is a part of.
`VoiceChannel`	`getQueuedAudioConnection()`	This can be used to find out what `VoiceChannel` JDA is currently attempting to setup an audio connection for.
`AudioReceiveHandler`	`getReceiveHandler()`	The currently set `AudioReceiveHandler`.
`AudioSendHandler`	`getSendingHandler()`	The currently set `AudioSendHandler`.
`java.util.EnumSet<SpeakingMode>`	`getSpeakingMode()`	The `SpeakingMode` that should be used when sending audio via the provided `AudioSendHandler` from `setSendingHandler(AudioSendHandler)`.
`boolean`	`isAttemptingToConnect()`	This can be used to find out if JDA is currently attempting to setup an audio connection.
`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 `VoiceChannel`.
`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(VoiceChannel channel)`	Starts the process to create an audio connection with a `VoiceChannel` or, if an audio connection is already open, JDA will move the connection to the provided VoiceChannel.
`void`	`setAutoReconnect(boolean shouldReconnect)`	Sets whether audio connections from this AudioManager should automatically reconnect or not.
`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`	`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(java.util.Collection<SpeakingMode> mode)`	The `SpeakingMode` that should be used when sending audio via the provided `AudioSendHandler` from `setSendingHandler(AudioSendHandler)`.
`default void`	`setSpeakingMode(SpeakingMode... mode)`	The `SpeakingMode` that should be used when sending audio via the provided `AudioSendHandler` from `setSendingHandler(AudioSendHandler)`.

- Field Detail
  - DEFAULT_CONNECTION_TIMEOUT
```
static final long DEFAULT_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - LOG
```
static final org.slf4j.Logger LOG
```
- Method Detail
  - openAudioConnection
```
void openAudioConnection(VoiceChannel channel)
```
    Starts the process to create an audio connection with a VoiceChannel or, if an audio connection is already open, JDA will move the connection to the provided VoiceChannel.
    Note: Currently you can only be connected to a single VoiceChannel 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 closeAudioConnection().
    Client accounts can only connect to a single VoiceChannel at once. It is an Account-Wide limitation!
    Parameters:
    
    channel - The VoiceChannel to open an audio connection with.
    
    Throws:
    java.lang.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.
    java.lang.UnsupportedOperationException - If audio is disabled due to an internal JDA error
    
    GuildUnavailableException - If the Guild is temporarily unavailable
    InsufficientPermissionException -
    
    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 the user limit has been exceeded!
  - closeAudioConnection
```
void closeAudioConnection()
```
    Close down the current audio connection of this Guild and disconnects from the VoiceChannel.
    If this is called when JDA doesn't have an audio connection, nothing happens.
  - setSpeakingMode
```
@Incubating
void setSpeakingMode(java.util.Collection<SpeakingMode> mode)
```
    The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from setSendingHandler(AudioSendHandler). By default this will use SpeakingMode.VOICE.
    Example: EnumSet.of(SpeakingMode.PRIORITY_SPEAKER, SpeakingMode.VOICE)
    
    Parameters:
    
    mode - The speaking modes
    
    Throws:
    
    java.lang.IllegalArgumentException - If the provided collection is null or empty
    
    See Also:
    
    getSpeakingMode(), setSpeakingMode(SpeakingMode...)
    
    Incubating:
    
    Discord has not officially confirmed that this feature will be available to bots
  - setSpeakingMode
```
@Incubating
default void setSpeakingMode(SpeakingMode... mode)
```
    The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from setSendingHandler(AudioSendHandler). By default this will use SpeakingMode.VOICE.
    
    Parameters:
    
    mode - The speaking modes
    
    Throws:
    
    java.lang.IllegalArgumentException - If the provided array is null or empty
    
    See Also:
    
    getSpeakingMode()
    
    Incubating:
    
    Discord has not officially confirmed that this feature will be available to bots
  - getSpeakingMode
```
@Incubating
java.util.EnumSet<SpeakingMode> getSpeakingMode()
```
    The SpeakingMode that should be used when sending audio via the provided AudioSendHandler from setSendingHandler(AudioSendHandler). By default this will use SpeakingMode.VOICE.
    
    Returns:
    
    The current speaking mode, represented in an EnumSet
    
    See Also:
    
    setSpeakingMode(Collection)
    
    Incubating:
    
    Discord has not officially confirmed that this feature will be available to bots
  - getJDA
```
JDA getJDA()
```
    Gets the JDA instance that this AudioManager is a part of.
    
    Returns:
    
    The corresponding JDA instance
  - getGuild
```
Guild getGuild()
```
    Gets the Guild instance that this AudioManager is used for.
    
    Returns:
    
    The Guild that this AudioManager manages.
  - isAttemptingToConnect
```
boolean isAttemptingToConnect()
```
    This can be used to find out if JDA is currently attempting to setup an audio connection.
    If this returns true then getQueuedAudioConnection() will return the VoiceChannel that JDA is attempting to setup an audio connection to.
    
    Returns:
    
    True, if JDA is currently attempting to create an audio connection.
  - getQueuedAudioConnection
```
VoiceChannel getQueuedAudioConnection()
```
    This can be used to find out what VoiceChannel JDA is currently attempting to setup an audio connection for. If JDA isn't trying to create an audio connection this will return null.
    In addition, if JDA is already connected, this will return null. To determine if JDA is already has an audio connection with a VoiceChannel use isConnected()
    
    Returns:
    
    The VoiceChannel that JDA is attempting to create an audio connection with, or null if JDA isn't attempting to create a connection.
  - getConnectedChannel
```
VoiceChannel getConnectedChannel()
```
    The VoiceChannel that JDA currently has an audio connection to. If JDA currently doesn't have an audio connection to a VoiceChannel this will return null.
    
    Returns:
    
    The VoiceChannel the audio connection is connected to or null if not connected.
  - isConnected
```
boolean isConnected()
```
    This can be used to find out if JDA currently has an active audio connection with a VoiceChannel. If this returns true, then getConnectedChannel() will return the VoiceChannel 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
```
void setSendingHandler(AudioSendHandler handler)
```
    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 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 - The AudioSendHandler used to provide audio data.
  - getSendingHandler
```
AudioSendHandler getSendingHandler()
```
    The currently set AudioSendHandler. If there is no sender currently set, this method will return null.
    
    Returns:
    
    The currently active AudioSendHandler or null.
  - setReceivingHandler
```
void setReceivingHandler(AudioReceiveHandler handler)
```
    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.
    
    Parameters:
    
    handler - The AudioReceiveHandler used to process received audio data.
  - getReceiveHandler
```
AudioReceiveHandler getReceiveHandler()
```
    The currently set AudioReceiveHandler. If there is no receiver currently set, this method will return null.
    
    Returns:
    
    The currently active AudioReceiveHandler or null.
  - setConnectionListener
```
void setConnectionListener(ConnectionListener listener)
```
    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!
    
    Parameters:
    
    listener - A ConnectionListener instance
  - getConnectionListener
```
ConnectionListener getConnectionListener()
```
    The currently set ConnectionListener or null if no ConnectionListener has been set.
    
    Returns:
    
    The current ConnectionListener instance for this AudioManager.
  - getConnectionStatus
```
ConnectionStatus getConnectionStatus()
```
    The current ConnectionStatus.
    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. Default true
    
    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 to true if the current connection should be displayed as muted, this will cause the AudioSendHandler 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 is true packages by the registered AudioSendHandler 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 from setSelfMuted(boolean) and checked via isSelfMuted()
    
    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 from setSelfMuted(boolean) and checked via isSelfMuted()
    
    Returns:
    
    True, if connections from this AudioManager are deafened

Interface AudioManager

Field Summary

Method Summary

Field Detail

DEFAULT_CONNECTION_TIMEOUT

LOG

Method Detail

openAudioConnection

closeAudioConnection

setSpeakingMode

setSpeakingMode

getSpeakingMode

getJDA

getGuild

isAttemptingToConnect

getQueuedAudioConnection

getConnectedChannel

isConnected

setConnectTimeout

getConnectTimeout

setSendingHandler

getSendingHandler

setReceivingHandler

getReceiveHandler

setConnectionListener

getConnectionListener

getConnectionStatus

setAutoReconnect

isAutoReconnect

setSelfMuted

isSelfMuted

setSelfDeafened

isSelfDeafened