Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/devoxin/Lavalink.py
/ types & classes
Types & classes
83 in github.com/devoxin/Lavalink.py
⨍
Functions
307
◇
Types & classes
83
↓ 9 callers
Class
ClientError
Raised when something goes wrong within the client.
lavalink/errors.py:43
↓ 6 callers
Class
AudioTrack
.. _ISRC: https://en.wikipedia.org/wiki/International_Standard_Recording_Code Represents an AudioTrack. Parameters ---------- d
lavalink/server.py:91
↓ 3 callers
Class
InvalidTrack
Raised when an invalid track was passed.
lavalink/errors.py:51
↓ 2 callers
Class
DataWriter
lavalink/dataio.py:184
↓ 2 callers
Class
LoadResult
Attributes ---------- load_type: :class:`LoadType` The load type of this result. tracks: Sequence[Union[:class:`AudioTrack`,
lavalink/server.py:308
↓ 2 callers
Class
TrackLoadFailedEvent
This is a custom event, emitted when a deferred audio track fails to produce a playable track. The player will not do anything by itself,
lavalink/events.py:166
↓ 1 callers
Class
CustomAudioTrack
examples/custom_source.py:9
↓ 1 callers
Class
DataReader
lavalink/dataio.py:37
↓ 1 callers
Class
EventHandler
Events from the Lavalink server
examples/hikari_music.py:13
↓ 1 callers
Class
ExponentialBackoff
Basic exponential backoff calculator.
lavalink/backoff.py:27
↓ 1 callers
Class
IncomingWebSocketMessage
This event is emitted whenever the client receives a websocket message from the Lavalink server. You can use this to extend the functionalit
lavalink/events.py:353
↓ 1 callers
Class
LoadResultError
Attributes ---------- message: :class:`str` The error message. severity: :enum:`Severity` The severity of the error.
lavalink/server.py:274
↓ 1 callers
Class
LowPass
Applies a low-pass effect to the audio, whereby only low frequencies can pass, effectively cutting off high frequencies meaning more emphasis
lavalink/filters.py:502
↓ 1 callers
Class
Music
examples/music.py:119
↓ 1 callers
Class
Node
Represents a Node connection with Lavalink. Note ---- To construct a node, you should use :func:`Client.add_node` instead. Attr
lavalink/node.py:50
↓ 1 callers
Class
NodeChangedEvent
This is a custom event, emitted when a player changes to another Lavalink node. Keep in mind this event can be emitted multiple times if a no
lavalink/events.py:279
↓ 1 callers
Class
NodeConnectedEvent
This is a custom event, emitted when a connection to a Lavalink node is successfully established. Attributes ---------- node: :c
lavalink/events.py:241
↓ 1 callers
Class
NodeDisconnectedEvent
This is a custom event, emitted when the connection to a Lavalink node drops and becomes unavailable. Attributes ---------- node
lavalink/events.py:257
↓ 1 callers
Class
NodeManager
Represents the node manager that contains all lavalink nodes. len(x): Returns the total number of nodes. iter(x): Returns an
lavalink/nodemanager.py:47
↓ 1 callers
Class
NodeReadyEvent
This is a custom event, emitted when a node becomes ready. A node is considered ready once it receives the "ready" event from the Lavalink se
lavalink/events.py:302
↓ 1 callers
Class
Penalty
Represents the penalty of the stats of a Node. Attributes ---------- player_penalty: :class:`int` The number of playing play
lavalink/stats.py:35
↓ 1 callers
Class
PlayerErrorEvent
Raised when an error occurs within a :class:`BasePlayer`. Attributes ---------- player: :class:`BasePlayer` The player in wh
lavalink/events.py:374
↓ 1 callers
Class
PlayerManager
Represents the player manager that contains all the players. len(x): Returns the total number of stored players. iter(x):
lavalink/playermanager.py:45
↓ 1 callers
Class
PlayerUpdateEvent
This event is emitted when a player's progress changes. Attributes ---------- player: :class:`BasePlayer` The player that's
lavalink/events.py:212
↓ 1 callers
Class
QueueEndEvent
This is a custom event, emitted by the :class:`DefaultPlayer` when there are no more tracks in the queue. Attributes ----------
lavalink/events.py:196
↓ 1 callers
Class
RequestError
Raised when a request to the Lavalink server fails. Attributes ---------- status: :class:`int` The HTTP status code returned
lavalink/errors.py:59
↓ 1 callers
Class
Stats
Encapsulates the 'Statistics' emitted by Lavalink, usually every minute. Attributes ---------- is_fake: :class:`bool` Whethe
lavalink/stats.py:62
↓ 1 callers
Class
TrackEndEvent
This event is emitted when the player finished playing a track. Note ---- You do not need to manually trigger the start of the next
lavalink/events.py:139
↓ 1 callers
Class
TrackExceptionEvent
This event is emitted when a track encounters an exception during playback. Note ---- You do not need to manually trigger the start
lavalink/events.py:102
↓ 1 callers
Class
TrackStartEvent
This event is emitted when a track begins playing (e.g. via player.play()) Attributes ---------- player: :class:`BasePlayer`
lavalink/events.py:56
↓ 1 callers
Class
TrackStuckEvent
This event is emitted when the currently playing track is stuck (i.e. has not provided any audio). This is typically a fault of the track's u
lavalink/events.py:74
↓ 1 callers
Class
Transport
The class responsible for handling connections to a Lavalink server.
lavalink/transport.py:59
↓ 1 callers
Class
WebSocketClosedEvent
This event is emitted when an audio websocket to Discord is closed. This can happen happen for various reasons, an example being when a chann
lavalink/events.py:324
↓ 1 callers
Class
_MissingObj
lavalink/common.py:35
Class
AuthenticationError
Raised when a request fails due to invalid authentication.
lavalink/errors.py:47
Class
BasePlayer
Represents the BasePlayer all players must be inherited from. Attributes ---------- client: :class:`Client` The Lavalink cli
lavalink/abc.py:51
Class
ChannelMix
Allows passing the audio from one channel to the other, or isolating individual channels.
lavalink/filters.py:538
Class
Client
Represents a Lavalink client used to manage nodes and connections. Parameters ---------- user_id: Union[:class:`int`, :class:`str`]
lavalink/client.py:56
Class
CustomSource
examples/custom_source.py:28
Class
DefaultPlayer
The player that Lavalink.py uses by default. This should be sufficient for most use-cases. Attributes ---------- LOOP_NONE: :cl
lavalink/player.py:50
Class
DeferredAudioTrack
Similar to an :class:`AudioTrack`, however this track only stores metadata up until it's played, at which time :func:`load` is called to retr
lavalink/abc.py:294
Class
Distortion
As the name suggests, this distorts the audio.
lavalink/filters.py:613
Class
EndReason
lavalink/server.py:210
Class
Enum
lavalink/server.py:67
Class
Equalizer
Allows modifying the gain of 15 bands, to boost or reduce the volume of specific frequency ranges. For example, this could be used to boost t
lavalink/filters.py:82
Class
Event
The base for all Lavalink events.
lavalink/events.py:52
Class
Filter
A class representing a Lavalink audio filter. Parameters ---------- values: Union[Dict[str, Any], Sequence[Union[float, int]], float
lavalink/abc.py:371
Class
Karaoke
Allows for isolating a frequency range (commonly, the vocal range). Useful for karaoke/sing-along.
lavalink/filters.py:164
Class
LavalinkError
Base exception for all errors raised by Lavalink.py.
lavalink/errors.py:39
Class
LavalinkVoiceClient
This is the preferred way to handle external voice sending This client will be created via a cls in the connect method of the channel see
examples/music.py:22
Class
LoadError
Raised when a track fails to load. E.g. if a DeferredAudioTrack fails to find an equivalent.
lavalink/errors.py:55
Class
LoadError
examples/custom_source.py:5
Class
LoadType
lavalink/server.py:232
Class
PlaylistInfo
Attributes ---------- name: :class:`str` The name of the playlist. selected_track: :class:`int` The index of the sele
lavalink/server.py:246
Class
Plugin
Represents a Lavalink server plugin. Parameters ---------- data: Dict[str, Any] The data to initialise a Plugin from. A
lavalink/server.py:409
Class
RawCpu
lavalink/server.py:542
Class
RawFailingAddress
lavalink/server.py:493
Class
RawGit
lavalink/server.py:518
Class
RawInfo
lavalink/server.py:524
Class
RawIpBlock
lavalink/server.py:488
Class
RawMemory
lavalink/server.py:535
Class
RawPlayer
lavalink/server.py:478
Class
RawPlayerState
lavalink/server.py:443
Class
RawPlayerVoiceState
lavalink/server.py:450
Class
RawPlugin
lavalink/server.py:438
Class
RawRouteplannerDetails
lavalink/server.py:499
Class
RawSession
lavalink/server.py:557
Class
RawStats
lavalink/server.py:548
Class
RawTrack
lavalink/server.py:471
Class
RawTrackInfo
lavalink/server.py:457
Class
RawVersion
lavalink/server.py:509
Class
Release
lavalink/__main__.py:39
Class
Rotation
Phases the audio in and out of the left and right channels in an alternating manner. This is commonly used to create the 8D effect.
lavalink/filters.py:466
Class
Severity
lavalink/server.py:240
Class
Source
lavalink/abc.py:331
Class
Timescale
Allows speeding up/slowing down the audio, adjusting the pitch and playback rate.
lavalink/filters.py:258
Class
Tremolo
Applies a 'tremble' effect to the audio.
lavalink/filters.py:346
Class
Vibrato
Applies a 'wobble' effect to the audio.
lavalink/filters.py:406
Class
VoiceServerUpdateData
lavalink/common.py:52
Class
VoiceServerUpdatePayload
lavalink/common.py:63
Class
VoiceStateUpdateData
lavalink/common.py:45
Class
VoiceStateUpdatePayload
lavalink/common.py:58
Class
Volume
Adjusts the audio output volume.
lavalink/filters.py:47