lavalink library

A wrapper for the Lavalink API.

Classes

ChannelMix
Information about a channel mix effect.
CpuStats
Statistics about a Lavalink server's CPU usage.
Distortion
Information about a distortion effect.
EmptyLoadResult
An empty LoadResult.
Equalizer
Information about an equalizer.
ErrorLoadResult
The LoadResult returned when an error occurred while loading.
ExceptionInfo
Information about an exception encountered by Lavalink.
FailingAddress
Information about an IP address determined to be failing.
Filters
Information about the filters a Player is using.
FrameStats
Git
Information about a Git revision.
HttpLavalinkClient
A Lavalink client that does not create a session on the server and can only make certain HTTP requests.
IpBlock
A block of IP addresses.
Karaoke
Information about a karaoke effect
LavalinkClient
A client that connects to a Lavalink server, providing methods to control the server and exposing events received from the server.
LavalinkConnection
A websocket connection to a Lavalink server.
LavalinkEvent
An event sent by a Lavalink server.
LavalinkInfo
Information about a Lavalink server.
LavalinkMessage
The base class for all messages sent on a LavalinkConnection.
LavalinkReadyMessage
A message sent when a Lavalink session is initialized.
LavalinkStats
A collection of statistics about a Lavalink server.
LoadResult
The result of loading a track, playlist or search.
LowPass
Information about a low pass filter effect.
MemoryStats
Statistics about a Lavalink server's memory usage.
Player
The state of the client playing audio in a guild.
PlayerState
The current state of a Player.
PlayerUpdateMessage
A message sent when a Player changes state.
Playlist
A playlist of tracks.
PlaylistInfo
Information about a playlist.
PlaylistLoadResult
The LoadResult for a playlist.
Plugin
Rotation
Information about a rotation effect.
RoutePlannerDetails
Information about the configuration of the RoutePlanner extension on a Lavalink server.
RoutePlannerStatus
Status about the RoutePlanner extension on a Lavalink server.
SearchLoadResult
The LoadResult for a search.
StatsMessage
A message containing statistics about the server.
Timescale
Information about a timescale effect.
Track
An audio track.
TrackEndEvent
An event sent when the end of a Track is reached.
TrackExceptionEvent
An event sent when an exception is encountered while playing a track.
TrackInfo
Information about a Track.
TrackLoadResult
The LoadResult for a single track.
TrackStartEvent
An event sent when a track starts playing.
TrackStuckEvent
An event sent when a Track gets stuck while playing.
Tremolo
Information about a tremolo effect.
Version
Information about a Lavalink version.
Vibrato
Information about a vibrato effect.
VoiceState
The state of a Player's voice session.
WebSocketClosedEvent
An event sent when the websocket connection to Discord's voice servers is lost.

Exceptions / Errors

LavalinkException
An exception thrown when a Lavalink API call returns an error.