Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/devoxin/Lavalink.py
/ functions
Functions
307 in github.com/devoxin/Lavalink.py
⨍
Functions
307
◇
Types & classes
83
Method
destroy
|coro| Closes the WebSocket gracefully, and stops any further reconnecting. Useful when needing to remove a node.
lavalink/transport.py:135
Method
destroy
|coro| Destroys the current player instance. Shortcut for :func:`PlayerManager.destroy`.
lavalink/abc.py:231
Method
disconnect
Handles the disconnect. Cleans up running player and leaves the voice client.
examples/music.py:83
Method
empty
(cls)
lavalink/server.py:338
Function
encode_track
Encodes a track dict into a base64 string, readable by the Lavalink server. A track should have *at least* the following keys: ``title``
lavalink/utils.py:231
Function
exact_version
(release: Release)
lavalink/__main__.py:208
Method
find_all
Returns a list of players that match the given predicate. Parameters ---------- predicate: Optional[Callable[[:class
lavalink/playermanager.py:82
Function
format_time
Formats the given time into HH:MM:SS. Parameters ---------- time: :class:`int` The time in milliseconds. Returns --
lavalink/utils.py:97
Method
from_dict
(cls, mapping: Dict[str, Any])
lavalink/server.py:263
Method
from_dict
(cls, mapping: dict)
lavalink/server.py:360
Method
from_error
(cls, error: LoadResultError)
lavalink/server.py:356
Method
from_playlist
(cls, tracks: Sequence[Union[AudioTrack, 'DeferredAudioTrack']], playlist_info: Optional[PlaylistInfo] = None,
lavalink/server.py:351
Method
from_search
(cls, tracks: Sequence[Union[AudioTrack, 'DeferredAudioTrack']], playlist_info: Optional[PlaylistInfo] = None,
lavalink/server.py:342
Method
from_track
(cls, track: Union[AudioTrack, 'DeferredAudioTrack'], plugin_info: Optional[Dict[str, Any]] = None)
lavalink/server.py:347
Method
get_filter
Returns the corresponding filter, if it's enabled. Example ------- .. code:: python from lavalink.filte
lavalink/player.py:526
Method
get_info
|coro| Retrieves information about this node. Returns ------- :class:`RawInfo` A raw response containing
lavalink/node.py:301
Method
get_local_tracks
|coro| Searches :attr:`sources` registered to this client for the given query. Parameters ---------- query: :class:`
lavalink/client.py:350
Method
get_nodes_by_region
Get a list of nodes by their region. This does not account for node availability, so the nodes returned could be either avail
lavalink/nodemanager.py:158
Method
get_player
|coro| Retrieves a player from the node. This returns raw data, to retrieve a player you can interact with, use :func:`PlayerManager.
lavalink/node.py:337
Method
get_players
|coro| Retrieves a list of players from the node. This returns raw data, to retrieve players you can interact with, use :attr:`player
lavalink/node.py:354
Method
get_rest_latency
|coro| Measures the REST latency for this node. This simply calls :func:`get_version` but measures the time between when the request
lavalink/node.py:142
Method
get_routeplanner_status
|coro| Retrieves the status of the target node's routeplanner. Returns ------- Optional[:class:`RawRouteplanner`]
lavalink/node.py:248
Method
get_source
Gets a registered source by the given name. Parameters ---------- source_name: :class:`str` The name of
lavalink/client.py:291
Method
get_stats
|coro| Retrieves statistics about this node. Returns ------- :class:`RawStats` A raw response containing
lavalink/node.py:313
Method
get_tracks
|coro| Retrieves a list of results pertaining to the provided query. If ``check_local`` is set to ``True`` and any of the sources re
lavalink/client.py:372
Function
gt
(release: Release)
lavalink/__main__.py:223
Function
gte
(release: Release)
lavalink/__main__.py:213
Method
handle_event
Handles the given event as necessary. Parameters ---------- event: :class:`Event` The event to handle.
lavalink/player.py:619
Method
http_uri
Returns a 'base' URI pointing to the node's address and port, also factoring in SSL.
lavalink/transport.py:100
Function
init
Add node to bot on ready
examples/hikari_music.py:34
Method
is_connected
Returns whether the player is connected to a voicechannel or not.
lavalink/player.py:130
Method
is_playing
Returns the player's track state.
lavalink/player.py:125
Function
join
Connect the bot to the voice channel the user is currently in and create a player_manager if it doesn't exist yet.
examples/hikari_music.py:98
Function
leave
Leaves the voice channel the bot is in, clearing the queue.
examples/hikari_music.py:117
Function
listener
Marks this function as an event listener for Lavalink.py. This **must** be used on class methods, and you must ensure that you register d
lavalink/__init__.py:28
Function
load
(bot: lightbulb.BotApp)
examples/hikari_music.py:193
Method
load
(self, client)
examples/custom_source.py:14
Method
load_item
(self, client, query: str)
examples/custom_source.py:32
Method
lowpass
Sets the strength of the low pass filter.
examples/music.py:288
Function
lte
(release: Release)
lavalink/__main__.py:218
Method
mark
Marks the current position of the buffer to allow rewinding.
lavalink/dataio.py:51
Method
node_unavailable
|coro| Called when a player's node becomes unavailable. Useful for changing player state before it's moved to another node.
lavalink/player.py:652
Method
nodes
Convenience shortcut for :attr:`NodeManager.nodes`.
lavalink/client.py:127
Method
on_queue_end
(self, event: QueueEndEvent)
examples/music.py:218
Method
on_track_start
(self, event: TrackStartEvent)
examples/music.py:204
Method
on_voice_server_update
(self, data)
examples/music.py:47
Method
on_voice_state_update
(self, data)
examples/music.py:56
Function
parse_time
Parses the given time into days, hours, minutes and seconds. Useful for formatting time yourself. Parameters ---------- time: :c
lavalink/utils.py:116
Method
penalty
Returns the load-balancing penalty for this node.
lavalink/node.py:123
Function
play
Searches the query on youtube, or adds the URL to the queue.
examples/hikari_music.py:138
Method
players
Convenience shortcut for :attr:`PlayerManager.players`.
lavalink/client.py:134
Method
players
Returns a list of all players on this node. Returns ------- Sequence[:class:`BasePlayer`]
lavalink/node.py:112
Method
position
Returns the track's elapsed playback time in milliseconds, adjusted for Lavalink stat interval.
lavalink/player.py:135
Method
queue_finish
(self, event: lavalink.QueueEndEvent)
examples/hikari_music.py:29
Method
register_source
Registers a :class:`Source` that Lavalink.py will use for looking up tracks. Parameters ---------- source: :class:`S
lavalink/client.py:277
Method
remaining
The amount of bytes left to be read.
lavalink/dataio.py:45
Method
remove
Removes a player from the internal cache. Parameters ---------- guild_id: :class:`int` The player to rem
lavalink/playermanager.py:119
Method
remove_event_hooks
Removes the given hooks from the event hook registry. Parameters ---------- events: Sequence[:class:`Event`]
lavalink/client.py:237
Method
remove_filters
|coro| Removes multiple filters from the player, undoing any effects applied to the audio. This is similar to :func:`remove_filter` b
lavalink/player.py:560
Method
remove_node
Removes a node. Make sure you have called :func:`Node.destroy` to close any resources used by this Node. .. deprecated:: 5.
lavalink/nodemanager.py:128
Method
requester
(self)
lavalink/server.py:199
Method
reset
(self)
lavalink/backoff.py:47
Method
rewind
Rewinds the buffer back to its marked position. If a position has not been marked, this will raise ``IOError``. After rewind
lavalink/dataio.py:57
Method
routeplanner_free_address
|coro| Frees up the provided IP address in the target node's routeplanner. Parameters ---------- address: :class:`st
lavalink/node.py:266
Method
routeplanner_free_all_failing
|coro| Frees up all IP addresses in the target node that have been marked as failing. Returns ------- :class:`bool`
lavalink/node.py:286
Method
selected_track
Convenience method for returning the selected track using :attr:`PlaylistInfo.selected_track`. This could be ``None`` if :at
lavalink/server.py:385
Method
serialize
(self)
lavalink/filters.py:78
Method
serialize
(self)
lavalink/filters.py:160
Method
serialize
(self)
lavalink/filters.py:254
Method
serialize
(self)
lavalink/filters.py:342
Method
serialize
(self)
lavalink/filters.py:402
Method
serialize
(self)
lavalink/filters.py:462
Method
serialize
(self)
lavalink/filters.py:498
Method
serialize
(self)
lavalink/filters.py:534
Method
serialize
(self)
lavalink/filters.py:609
Method
serialize
(self)
lavalink/filters.py:672
Method
session_id
The session ID for this node. Could be ``None`` if a ready event has not yet been received from the server.
lavalink/node.py:85
Method
set_filters
|coro| This sets multiple filters at once. Applies the corresponding filters within Lavalink. This will overwrite any identi
lavalink/player.py:415
Method
set_loop
Sets whether the player loops between a single track, queue or none. 0 = off, 1 = single track, 2 = queue. Parameters
lavalink/player.py:342
Method
set_pause
|coro| Sets the player's paused state. Parameters ---------- pause: :class:`bool` Whether to pause the p
lavalink/player.py:369
Method
set_request_tracebacks
Enables or disables request tracebacks for debugging purposes. This applies to all nodes managed by this client instance. For
lavalink/client.py:140
Method
set_request_tracebacks
Enables or disables request tracebacks for this node. When enabled, this will return any error traces in responses if an error occurs.
lavalink/node.py:130
Method
set_shuffle
Sets the player's shuffle state. Parameters ---------- shuffle: :class:`bool` Whether to shuffle the pla
lavalink/player.py:358
Method
set_volume
|coro| Sets the player's volume Note ---- A limit of 1000 is imposed by Lavalink. Parameters ------
lavalink/player.py:382
Method
skip
|coro| Plays the next track in the queue, if any. Warning ------- Multiple calls to this method within a short timef
lavalink/player.py:330
Method
stream
Property indicating whether this track is a stream. .. deprecated:: 5.3.0 To be consistent with attribute naming, this p
lavalink/server.py:188
Function
timestamp_to_millis
Converts a timestamp such as 03:28 or 02:15:53 to milliseconds. Example ------- .. code:: python await player.play(track, s
lavalink/utils.py:50
Method
track_end
(self, event: lavalink.TrackEndEvent)
examples/hikari_music.py:21
Method
track_exception
(self, event: lavalink.TrackExceptionEvent)
examples/hikari_music.py:25
Method
track_start
(self, event: lavalink.TrackStartEvent)
examples/hikari_music.py:17
Method
update
Modifies the player volume. This uses LavaDSP's volume filter, rather than Lavaplayer's native volume changer. Note
lavalink/filters.py:54
Method
update
(self, *, bands: Sequence[Tuple[int, float]])
lavalink/filters.py:91
Method
update
(self, *, level: float)
lavalink/filters.py:174
Method
update
(self, *, speed: float)
lavalink/filters.py:266
Method
update
(self, *, frequency: float)
lavalink/filters.py:354
Method
update
(self, *, frequency: float)
lavalink/filters.py:414
Method
update
Note ---- The limits are: 0 ≤ rotation_hz Parameters ---------- rotation_hz: :class:`fl
lavalink/filters.py:474
Method
update
Note ---- The limits are: 0 ≤ leftToLeft ≤ 1.0 0 ≤ leftToRight ≤ 1.0 0 ≤ rightToLeft ≤
lavalink/filters.py:548
Method
update
Parameters ---------- sin_offset: :class:`float` The sin offset. sin_scale: :class:`float` Th
lavalink/filters.py:623
Method
update_filter
|coro| Updates a filter using the upsert method; if the filter exists within the player, its values will be updated; if the f
lavalink/player.py:482
← previous
next →
201–300 of 307, ranked by callers