- getAllocatedMemory() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of allocated memory, in bytes.
- getAudioNodes() - Method in class samophis.lavalink.client.entities.LavaClient
-
Used to fetch an unmodifiable list of all the
AudioNodes
this client can connect to.
- getAverageFrameDeficitPerMinute() - Method in interface samophis.lavalink.client.entities.Statistics.Frames
-
Fetches the average amount of deficit frames per minute, zero-if-null.
- getAverageFramesNulledPerMinute() - Method in interface samophis.lavalink.client.entities.Statistics.Frames
-
Fetches the average amount of null frames per minute, zero-if-null.
- getAverageFramesSentPerMinute() - Method in interface samophis.lavalink.client.entities.Statistics.Frames
-
Fetches the average amount of frames sent per minute, zero-if-null.
- getBalancer() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Fetches the
not-null LoadBalancer
that is responsible for determining the penalty imposed on the node.
- getBaseReconnectInterval() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the "default" interval, which is used to set the actual interval before and after successful reconnects.
- getBaseReconnectInterval() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Returns a user-specified (or default) "base" interval used for reconnection purposes.
- getBestNode() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the
AudioNode
with the least amount of load on it, used to balance the load of
LavaPlayers
on different nodes.
- getCacheExpireAfterAccessMs() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the amount of time from which track data will removed from the cache after being accessed (after being written).
- getCacheExpireAfterWriteMs() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the amount of time from which track data will be removed from the cache after being written without being accessed.
- getCallback() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the possibly-null callback used to execute code directly after a connection attempt while preserving order.
- getChannelId() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the ID of the Voice Channel this player is associated with.
- getClient() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the
not-null LavaClient
associated with this node object.
- getClient() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the
LavaClient
instance associated with this entry.
- getClient() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the
LavaClient
instance specified during construction of this event waiter.
- getClient() - Method in interface samophis.lavalink.client.entities.LavaHttpManager
-
Fetches the
LavaClient
associated with this manager.
- getClient() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the
LavaClient
instance this player is attached to.
- getConnectedNode() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the
AudioNode
this player will attempt to send data to.
- getConnectionCallback() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns a
possibly-null SocketConnectionHandler
specified by the user after
a WebSocket Connection to this node successfully opens.
- getCpuCores() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of CPU Cores.
- getCpuPenalty() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches the CPU penalty imposed on the attached
AudioNode
.
- getDeficitFramePenalty() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches the deficit frame penalty on the attached
AudioNode
.
- getDisconnectionCallback() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns a
possibly-null SocketConnectionHandler
specified by the user after
the WebSocket Connection to this node closes.
- getEndpoint() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the Voice Server Endpoint as set by the end-user.
- getEndpoint() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
The last Voice Server Endpoint previously used to connect to a Lavalink Node, stored by LavaClient for later use with re-connecting.
- getEntry() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the actual,
not-null entry
used to create this node object.
- getFrames() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the possibly-null Frames information.
- getFreeMemory() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of free memory, in bytes.
- getGlobalBaseReconnectInterval() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default "base" interval for reconnecting purposes, used for default values and "expansion".
- getGlobalIntervalExpander() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default interval "expander", used to change the reconnect interval for the next reconnect attempt.
- getGlobalIntervalTimeUnit() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default TimeUnit which is used to actually wait for the intervals in a good unit, such as MILLISECONDS, HOURS, etc.
- getGlobalMaximumReconnectInterval() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default maximum interval for reconnecting purposes, used to cap the provided reconnect interval
so that it never gets too high.
- getGlobalRestPort() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default REST API port for all
AudioNodes
the client has access to.
- getGlobalServerPassword() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default password for all
AudioNodes
the client has access to.
- getGlobalWebSocketPort() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the default WebSocket port for all
AudioNodes
the client has access to.
- getGuildId() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the ID of the Guild to open an Audio Stream to, as specified by the end-user.
- getGuildId() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the ID of the Guild this player is associated with.
- getHandlerByName(String) - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Attempts to fetch a
SocketHandler
registered to this entry associated with a given name.
- getHandlerMap() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
- getHandlers() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches an unmodifiable list containing all the
SocketHandlers
registered to this entry.
- getHttpAddress() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
- getHttpManager() - Method in class samophis.lavalink.client.entities.LavaClient
-
Used to fetch the
LavaHttpManager
associated with this client, which is used to get track data from an identifier.
- getIdentifierCache() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the internal identifier cache used by LavaClient to cut down the impact of loading the same sources in quick succession.
- getIntervalExpander() - Method in interface samophis.lavalink.client.entities.AudioNode
-
- getIntervalExpander() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Returns a user-specified (or default)
ReconnectIntervalFunction
used to
change the next interval for the next reconnect attempt.
- getIntervalTimeUnit() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the time unit LavaClient will attempt to wait in before attempting to reconnect.
- getIntervalTimeUnit() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Returns a user-specified (or default) TimeUnit needed for LavaClient to know how long to wait for.
- getLavalinkLoad() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of Lavalink load.
- getListeners() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Retrieves an unmodifiable list of all the listeners
attached to this player.
- getLoadedTracks() - Method in interface samophis.lavalink.client.entities.AudioWrapper
-
Returns an unmodifiable,
NOT-null list containing all the
TrackDataPairs
.
- getLoadType() - Method in interface samophis.lavalink.client.entities.AudioWrapper
-
Returns the type of loading that occurred.
- getMaximumReconnectInterval() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the maximum interval LavaClient will wait before attempting to reconnect.
- getMaximumReconnectInterval() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Returns a user-specified (or default) maximum interval used for reconnection purposes.
- getName() - Method in interface samophis.lavalink.client.entities.SocketHandler
-
Returns the not-null name of this handler (the name of the OP it responds to).
- getNode() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the
not-null AudioNode
this EventWaiter will send an update to.
- getNode() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches The
AudioNode
attached to this LoadBalancer.
- getNode() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the
AudioNode
connected to this Statistics object.
- getNodeByIdentifier(String, int) - Method in class samophis.lavalink.client.entities.LavaClient
-
- getNullFramePenalty() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches the null frame penalty on the attached
AudioNode
.
- getPassword() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the password of the associated
AudioNode
.
- getPlayerByGuildId(long) - Method in class samophis.lavalink.client.entities.LavaClient
-
- getPlayerMap() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches an unmodifiable view of the internal player map.
- getPlayerPenalty() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches the penalty of the players imposed on the attached
AudioNode
.
- getPlayers() - Method in class samophis.lavalink.client.entities.LavaClient
-
Used to fetch an unmodifiable list of all the
LavaPlayers
associated with this client.
- getPlayers() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the total amount of all connected players.
- getPlayingPlayers() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of playing players.
- getPlayingTrack() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the Lavaplayer AudioTrack currently playing, as updated internally by LavaClient.
- getPlaylistName() - Method in interface samophis.lavalink.client.entities.AudioWrapper
-
Returns the possibly-null name of the playlist this object wraps.
- getPosition() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches The position of the player.
- getRawAddress() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the server address of the
AudioNode
this entry represents,
as provided by the user through an
AudioNodeEntryBuilder
.
- getReconnectAttempts() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the current amount of reconnects that have been attempted by LavaClient, set to zero if either none
have been attempted or right after a reconnect succeeds.
- getReconnectInterval() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the interval last used to try to reconnect to this node, set to the base reconnect interval if a reconnect hasn't
been attempted, or just after a reconnect has succeeded.
- getReservableMemory() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of reservable memory, in bytes.
- getRestPort() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the REST API port of the associated
AudioNode
.
- getSelectedTrack() - Method in interface samophis.lavalink.client.entities.AudioWrapper
-
Returns the
possibly-null TrackDataPair
resembling the selected track of the playlist this object wraps.
- getSessionId() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the Session ID as set by the end-user.
- getSessionId() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
The last Session ID previously used to connect to a Lavalink Node, stored by LavaClient for later use with re-connecting.
- getShardCount() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the amount of shards specified during the construction of the LavaClient instance.
- getSocket() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns the raw, possibly-null, third-party WebSocket connection to the node.
- getSocketInitializer() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the
possibly-null SocketInitializer
used to "initialize" a LavaClient WebSocket connection.
- getState() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Returns the
not-null current
State
of this player.
- getStatistics() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Fetches the
possibly-null Statistics
data sent from this specific node, updated every minute.
- getSystemLoad() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of system load.
- getTimestamp() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the UNIX Timestamp as provided by the player update events from the Lavalink-Server.
- getToken() - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Fetches the Voice Token (NOT the same as an Account Token) as set by the end-user.
- getTotalPenalty() - Method in interface samophis.lavalink.client.entities.LoadBalancer
-
Fetches the total penalty on the attached
AudioNode
.
- getTrack() - Method in interface samophis.lavalink.client.entities.TrackDataPair
-
Returns the actual AudioTrack object itself, constructed from the provided, encoded track data.
- getTrackData() - Method in interface samophis.lavalink.client.entities.TrackDataPair
-
Returns the encoded track data as provided by the Lavalink Server.
- getUptime() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the uptime of the
AudioNode
, in milliseconds.
- getUsedMemory() - Method in interface samophis.lavalink.client.entities.Statistics
-
Fetches the amount of used memory, in bytes.
- getUserId() - Method in class samophis.lavalink.client.entities.LavaClient
-
Fetches the User ID of the Bot User specified during the construction of the LavaClient instance.
- getVoiceToken() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
The last Voice Token previously used to connect to a Lavalink Node, stored by LavaClient for later use with re-connecting.
- getVolume() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Fetches the current volume of the player.
- getWebSocketAddress() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the WebSocket address (with the
'ws://'
scheme) of the
AudioNode
this entry represents.
- getWebSocketFactory() - Method in interface samophis.lavalink.client.entities.AudioNode
-
Returns a user-specified WebSocketFactory or the default LavaClient-provided one used to create WebSocket instances.
- getWebSocketFactory() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Returns a user-specified (or default) WebSocketFactory used to create the sockets needed to connect to nodes.
- getWebSocketPort() - Method in interface samophis.lavalink.client.entities.AudioNodeEntry
-
Fetches the WebSocket port of the associated
AudioNode
.
- samophis.lavalink.client.entities - package samophis.lavalink.client.entities
-
Contains all the entities and their implementations LavaClient uses.
- samophis.lavalink.client.exceptions - package samophis.lavalink.client.exceptions
-
Contains all the Exception classes LavaClient makes use of.
- samophis.lavalink.client.util - package samophis.lavalink.client.util
-
Contains utility singletons/classes which contain helpful code independent of other classes.
- seek(long) - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Skips to a certain position in a track.
- setNode(AudioNode) - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Sets the node to connect and send data to.
- setPaused(boolean) - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Sets whether or not to pause playback.
- setServerAndTryConnect(String, String) - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Sets the Voice Token and Endpoint, attempting to connect if the Session ID has also been set.
- setSessionIdAndTryConnect(String) - Method in interface samophis.lavalink.client.entities.EventWaiter
-
Sets the Session ID and tries to connect if both the Voice Token and Endpoint have also been set.
- setVolume(int) - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Sets the volume of playback.
- shutdown() - Method in class samophis.lavalink.client.entities.LavaClient
-
Shuts down LavaClient (also resetting the state).
- shutdown() - Method in interface samophis.lavalink.client.entities.LavaHttpManager
-
Shuts down the internal HTTP Client used to make requests in the first place.
- SocketConnectionException - Exception in samophis.lavalink.client.exceptions
-
Error thrown during an attempt from LavaClient to connect to an
AudioNode
.
- SocketConnectionException(Throwable) - Constructor for exception samophis.lavalink.client.exceptions.SocketConnectionException
-
Captures a previously thrown Throwable and re-throws it as a SocketConnectionException.
- SocketConnectionHandler - Interface in samophis.lavalink.client.entities
-
A handler/callback which accepts an
AudioNode
and an
WebSocket
, both of which
shouldn't be
null
if called from LavaClient and not manually.
- SocketHandler - Interface in samophis.lavalink.client.entities
-
A handler which takes incoming messages from Lavalink Nodes and responds in some way.
- SocketInitializer - Interface in samophis.lavalink.client.entities
-
Represents an initializer that allows users to modify the raw WebSocket instance before LavaClient opens a connection to it.
- State - Enum in samophis.lavalink.client.entities
-
- Statistics - Interface in samophis.lavalink.client.entities
-
Represents the statistics for a given
AudioNode
, updated every minute.
- Statistics.Frames - Interface in samophis.lavalink.client.entities
-
Represents the possibly-null frame statistics provided every minute by the Lavalink-Server.
- stopTrack() - Method in interface samophis.lavalink.client.entities.LavaPlayer
-
Requests the Lavalink Server to stop playback