A powerful Lavalink library for Discord.py.

I'm getting this error when I try and play music on using my discord bot.

Task exception was never retrieved future: <Task finished name='Task-32' coro=<Websocket.process_data() done, defined at C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py:137> exception=TypeError("'coroutine' object is not callable")> Traceback (most recent call last): File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py", line 156, in process_data event, payload = await self._get_event_payload(data['type'], data) File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py", line 184, in get_event_payload track = await self.node.build_track(cls=wavelink.Track, identifier=base64) File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\pool.py", line 294, in build_track return cls(identifier, data) TypeError: 'coroutine' object is not callable Task exception was never retrieved future: <Task finished name='Task-39' coro=<Websocket.process_data() done, defined at C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py:137> exception=TypeError("'coroutine' object is not callable")> Traceback (most recent call last): File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py", line 156, in process_data event, payload = await self._get_event_payload(data['type'], data) File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\websocket.py", line 184, in get_event_payload track = await self.node.build_track(cls=wavelink.Track, identifier=base64) File "C:\Users\icep2\AppData\Local\Programs\Python\Python39\lib\site-packages\wavelink\pool.py", line 294, in build_track return cls(identifier, data) TypeError: 'coroutine' object is not callable

Was broken in this commit: https://github.com/PythonistaGuild/Wavelink/commit/f126755662cdf17199b7814dbe4abcb5f038966b After first track has been replaced with Player.play(track), track_end event triggered after Player.play done. So, after first track replaced, Player._source is always None and Player.is_playing() always returns False.

Consider changing code from commit above to something like this:

if event == 'track_end' and payload.get('reason') == 'FINISHED':
    player._source = None

This PR is Implemented in #66

Added New attributes

• resume_session: bool
• resume_timeout: float
• resume_key: str (Best left None)
• payload_timeout: float This is basically how recent requests shall be sent to the server
• Websocket.reset() method.

What are the new features?

Websocket queueing.

• Websocket._send() method now queues any data that is requested to be sent while the WS is disconnected.
• New method Websocket.send_queue() which is called when connecting, and sends queue only when a session is resumed and Websocket is connected.
• New exception NodeSessionClosedError raised when node closes a session or doesn't resume the old session. Handled within _connect method.

Resuming

• example of use of new features

import string
import secret
class key:
    def __init__(self, len, first_key="NoSnoopingOnMyLava"):
        self.len = len
        self.persistent = first_key

    def __str__(self):
        return self.persistent

    def __repr__(self):
        """This should generate a key and shall make it persistent """
        self.persistent = SomeSecurePasswordGenerator(self.len)
        return self.persistent

---------------

 async def start_nodes(self) -> None:
    """Connect and intiate nodes."""
    nodes = {'MAIN': {'host': 'lavaserver.badhost.com',
                      'port': 80,
                      'rest_uri': 'http://lavaserver.badhost.com',
                      'password': "verytrivialpassword",
                      'identifier': 'MAIN',
                      'region': 'us_central',
                      'heartbeat': 40.0, # ping the server every 40s
                      'resume_session': True,
                      'resume_timeout': 90.0,
                      'resume_key': key(10) # or "Astring"
                      'payload_timeout': 40.0
                      }}

    for n in nodes.values():
        await self.bot.wavelink.initiate_node(**n)

• or simply by setting 'resume_session': True

 async def start_nodes(self) -> None:
    """Connect and intiate nodes."""
    nodes = {'MAIN': {'host': 'lavaserver.badhost.com',
                      'port': 80,
                      'rest_uri': 'http://lavaserver.badhost.com',
                      'password': "verytrivialpassword",
                      'identifier': 'MAIN',
                      'region': 'us_central',
                      'resume_session': True
                      }}

    for n in nodes.values():
        await self.bot.wavelink.initiate_node(**n)

Though the former has more use cases by using a Key Object we can:

• Make the key persistent across Clusters
• log the events, since __str__ is called when configuring the server, while __repr__ is called when the Node's session is closed to generate a new key.
• To Generate a more secure password
• Increase length of the password (The default is 32 characters)
• Use

How does resuming work?

When the bot disconnects from the node (eg: 1006) then the lavalink server keeps on playing the music until session timeout, this allows the bot to reconnect and take control of the session. This PR implements this lavalink feature. The changes are not breaking, assuming no-one initializes Node instances directly.

How does Queueing work?

After the Node disconnects, we try to reconnect twice before timeout. during this time the requests to the node are queued in an asyncio.Queue subclass whose payload expires after some time. This could be useful when you have an higher timeout but want to only send recent requests

In addition to the Client/Node.build_track method, this adds the corresponding POST to /decodetracks to batch decode track identifiers. Useful if there are a large number of tracks that need to be decoded.

The definition of the endpoint can be found here: https://github.com/Frederikam/Lavalink/blob/18ee6778674b7f9a817893b676a91a9b96e642f3/LavalinkServer/src/main/java/lavalink/server/player/AudioLoaderRestHandler.java#L140

Hi I am trying to make a setvolume command but I keep getting this error: AttributeError: '_MissingSentinel' object has no attribute 'guild'

Code:

@bot.command()
async def setVolume(ctx, *, volume: float):
    vc = ctx.voice_client
    custom_player = CustomPlayer()

    if not vc:
        await ctx.send("I ain't in a vc bro")
    else:
        await custom_player.set_volume(volume=volume)

I've finally got playing a local file (to lavalink) from the bot. (No more ffmpeg)

I'm Just throwing this out here as a general question:

is there a better way to search for a Local Track? I see SearchableTrack, having a return_first=true. Just trying to get my head around the API. Any help is apperciated?

    search = wavelink.PartialTrack(query=path, cls=wavelink.LocalTrack)

    if inter.user.voice is None:
        return await inter.send(f'You are not connected to any voice channel!')

    # If the bot isn't in a voice channel
    if not inter.guild.voice_client:
        vc: wavelink.Player = await inter.user.voice.channel.connect(cls=wavelink.Player)
    else:
      #See if the bot is in another channel
      if inter.guild.voice_client.channel != inter.user.voice.channel:
        await inter.guild.voice_client.move_to(inter.user.voice.channel) 
        await inter.send(f'Connected to {inter.user.voice.channel}.')
        
    vc: wavelink.Player = inter.guild.voice_client
   
    try: 
       await vc.play(search)
       await inter.send(f'Playing {search.title}')
    except:
       await inter.send(f'{path} Not found!') 

@bot.event async def on_wavelink_track_end(player: wavelink.Player, track: wavelink.Track, reason): ctx = player.ctx vc: player = ctx.voice_client if vc.loop: return await vc.play(track) next_song = vc.queue.get() await vc.play(next_song) await ctx.send(f"Now playing {next_song.title}")

• File "/home/container/discord-bot/main.py", line 118, in on_wavelink_track_end next_song = vc.queue.get() File "/home/container/.local/lib/python3.10/site-packages/wavelink/queue.py", line 212, in get raise QueueEmpty("No items in the queue.") wavelink.errors.QueueEmpty: No items in the queue.

Discord.py 2.0 introduced a new self_deaf and self_mute parameter to the connect method. This causes TypeError: Player.connect() got an unexpected keyword argument 'self_deaf'

Traceback (most recent call last): File "/Users/admin/Desktop/Cogs/music1.py", line 272, in bot = Bot() File "/Users/admin/Desktop/Cogs/music1.py", line 22, in init self.add_cog(Music(self)) File "/Users/admin/Desktop/Cogs/music1.py", line 69, in init self.bot.wavelink = wavelink.Client(bot=self.bot) AttributeError: module 'wavelink' has no attribute 'Client'

In the newest version (v1.2.0), the implementation of the YouTube Playlist searching has removed support for Python Version 3.8. The use of the method .removeprefix() is a python 3.9+ feature.

The line in question: https://github.com/PythonistaGuild/Wavelink/blob/8a4fb12404a5e908bd7a22ecba1ace7dc950d73f/wavelink/tracks.py#L187

PEP 616: String methods to remove prefixes and suffixes https://www.python.org/dev/peps/pep-0616/

If this is intentional to remove Python 3.8 version, then please can the documentation be updated. Otherwise, an implementation to get around this could be:

def removePrefix(url, prefix):
    if string.startswith(prefix):
        return string[len(prefix):]
    else:
        return string

Hello, Wavelink is working good but in my opinion there a a few missing things:

• loop song & queue
• lyrics command
• pitch (1.00 standard 5.00 max)
• option to keep the bot into the voicechannel even if nothing is playing.

This argument allows the user to pass arguments which will be directly sent to Lavalink in the play method. This gives the ability to interact with Lavalink plugins

File "/home/subrata/Wavelink/wavelink/node.py", line 106, in <genexpr>
    version_tuple = tuple(int(v) for v in version.split('.'))
ValueError: invalid literal for int() with base 10: 'c597fb10d9d323a174b69efa66fcebd616fb3f1e-SNAPSHOT_Unofficial'

Fixed bug with 'wavelink.NodePool.get_node(region="rotterdam")' raise ZeroConnectedNodes(f "No Nodes for region <{region}> exist on this pool."), although there is at least one node with this region.

I currently play an MP3 on the lavalink server in a loop. The loop has been accomplished by following code.

@commands.Cog.listener(name="on_wavelink_track_end")
    async def _on_track_end(self, player: RadioPlayer, track: wavelink.Track, reason: str):
        if reason != 'FINISHED':
            return
        await player.play(track)

This transition works fine so far. I also added on_wavelink_track_exception and on_wavelink_track_stuck for debug reasons, but both won't get triggered.

I experience that the player randomly stops playing. The client is still connected. The player got is_connected() and is_playing() set to True. But when checking the position it got an inappropriate high number set.

My track is about an hour long, but postion is set to 21h in seconds.

Pausing and resuming resumes the playback.

I try to use wavelink.YouTubePlaylist to search for youtubeplaylist and I get error

code @commands.command(aliases=['P', 'PLAY', 'Play','p']) async def play(self,ctx: commands.Context, *, search:wavelink.YouTubePlaylist): print(search)

error Ignoring exception in on_message Traceback (most recent call last): File "C:\Python3.10\lib\site-packages\discord\ext\commands\core.py", line 456, in _actual_conversion ret = await method(ctx, argument) File "C:\Python3.10\lib\site-packages\wavelink\tracks.py", line 218, in convert return results[0] TypeError: 'YouTubePlaylist' object is not subscriptable

Did i miss something?

and also sorry for my bad English