Gets a player from cache. Parameters ---------- guild_id: :class:`int` The guild_id associated with the

Dispatches the given event to all registered hooks. Parameters ---------- event: :class:`Event` The even

.. _modified UTF: https://en.wikipedia.org/wiki/UTF-8#Modified_UTF-8 Reads an optional UTF string from the stream. Internal

Updates the internal values to match those provided.

Writes a utf string to the stream. Parameters ---------- utf_string: :class:`str` The string to write.

Adds a track to the queue. Parameters ---------- track: Union[:class:`AudioTrack`, :class:`DeferredAudioTrack`, Dict

Returns an iterator that yields only values.

Reads a UTF string from the stream. Returns ------- :class:`bytes`

|coro| This function intercepts websocket data from your Discord library and forwards the relevant information on to Lavalink, which

Shortcut for :func:`NodeManager.add_node`. Adds a node to Lavalink's node manager. Parameters ---------- ho

|coro| Called when a node change is requested for the current player instance. Parameters ---------- node: :class:`N

|coro| Destroys the transport and any underlying connections for this node. This will also cleanly close the websocket.

|coro| Destroys a player on the node. It's recommended that you use :func:`PlayerManager.destroy` to destroy a player. Retur

|coro| Retrieves a list of results pertaining to the provided query. Parameters ---------- query: :class:`str`

Reads a bool from the stream. Returns ------- :class:`bool`

.. _modified UTF: https://en.wikipedia.org/wiki/UTF-8#Modified_UTF-8 Reads a UTF string from the stream. This method is dif

Removes a node. Make sure you have called :func:`Node.destroy` to close any resources used by this Node. Parameters

|coro| Seeks to a given position in the track. Parameters ---------- position: :class:`int` The new posi

|coro| Stops the player.

Writes a single byte to the stream. Parameters ---------- byte: Any This can be anything ``BytesIO.write

Writes a long to the stream. Parameters ---------- long_value: :class:`int` The long to write.

Writes an optional string to the stream. Parameters ---------- utf_string: Optional[:class:`str`] The op

Scans the provided class ``cls`` for functions decorated with :func:`listener`, and sets them up to process Lavalink events.

|coro| Closes all active connections and frees any resources in use.

|coro| Shuts down the websocket connection if there is one.

Finds the best (least used) node in the given region, if applicable. Parameters ---------- region: Optional[:class:`

Finalizes the stream by writing the necessary flags, byte length etc. Returns ---------- :class:`bytes`

Check whether the client has any listeners for a specific event type.

|coro| Retrieves a base64 string that's playable by Lavalink. For example, you can use this method to search Lavalink for an identica

|coro| Loads a track with the given query. Parameters ---------- client: :class:`Client` The Lavalink cl

|coro| Plays the given track. This method differs from :func:`BasePlayer.play_track` in that it contains additional logic to

Reads a single byte from the stream. Returns ------- :class:`bytes`

Reads a long from the stream. Returns ------- :class:`int`

Reads an unsigned short from the stream. Returns ------- :class:`int`

|coro| Removes a filter from the player, undoing any effects applied to the audio. Example ------- .. code:: python

Writes a bool to the stream. Parameters ---------- boolean: :class:`bool` The bool to write.

Handles the event from Lavalink. Parameters ---------- data: :class:`dict` The data given from Lavalink.

Handles the response from the websocket. Parameters ---------- data: Union[Dict[Any, Any], List[Any]] Th

|coro| Called when a node is disconnected. Parameters ---------- node: :class:`Node` The node that has d

Listens for websocket messages.

Reads common fields between v1-3 AudioTracks. Returns ------- Tuple[str, str, int, str, bool, Optional[str]] A tuple contain

Sends a payload to Lavalink. Parameters ---------- data: :class:`dict` The data sent to Lavalink.

Attempts to establish a connection to Lavalink.

Connect the bot to the voice channel and create a player_manager if it doesn't exist yet.

Disconnects the player from the voice channel and clears its queue.

Retrieves the related value from the stored user data. Parameters ---------- key: :class:`object` The ke

Returns a Lavalink.py-friendly region from a Discord voice server address. Parameters ---------- endpoint: :class:`s

|coro| Retrieves the version of this node. Returns ------- str The version of this Lavalink server.

|coro| Handles an :class:`Event` received directly from the websocket. Parameters ---------- event: :class:`Event`

Returns whether the next track may be started from this event. This is mostly used as a hint to determine whether the ``track_end_ev

|coro| Called when a player's node becomes unavailable. Useful for changing player state before it's moved to another node.

Searches and plays a song from a given query.

|coro| .. _player object: https://lavalink.dev/api/rest.html#Player Plays the given track. Warning -------

Reads an int from the stream. Returns ------- :class:`int`

Transforms the internal values into a dict matching the structure Lavalink expects. Example: .. code:: python

|coro| Applies the corresponding filter within Lavalink. This will overwrite the filter if it's already applied. Example

Stores custom user data. Parameters ---------- key: :class:`object` The key of the object to store.