Player#

Below, is an explanation of all the available functions for the player, and example usages.

Creating and fetching a player#

If you have followed the guide from Client as State the following methods will work for fetching the player.

ArcCrescentLightbulbTanjun

@arc.slash_command("name", "description")
async def some_command(ctx: arc.GatewayContext, client: ongaku.Client = arc.inject()) -> None:
    try:
        player = client.create_player(...)
    except:
        await ctx.respond("The player could not be created.")
        return
        # Or possibly raise an error when it fails to fetch the player.

    # Do stuff with the player.

@crescent.command("name", "description")
class SomeCommand:
    async def callback(self, ctx: crescent.Context) -> None:
        try:
            player = client.create_player(...)
        except:
            await ctx.respond("The player could not be created.")
            return
            # Or possibly raise an error when it fails to fetch the player.

        # Do stuff with the player.

@lightbulb.command("name", "description", auto_defer=False)
@lightbulb.implements(lightbulb.SlashCommand)
async def some_command(ctx: lightbulb.SlashContext) -> None:
    try:
        player = client.create_player(...)
    except:
        await ctx.respond("The player could not be created.")
        return
        # Or possibly raise an error when it fails to fetch the player.

    # Do stuff with the player.

@tanjun.as_slash_command("name", "description")
async def some_command(ctx: tanjun.abc.SlashContext, client: ongaku.Client = alluka.inject()) -> None:
    @bot.command()
@lightbulb.command("name", "description", auto_defer=False)
@lightbulb.implements(lightbulb.SlashCommand)
async def some_command(ctx: lightbulb.SlashContext) -> None:
    try:
        player = client.create_player(...)
    except:
        await ctx.create_initial_response("The player could not be created.")
        return
        # Or possibly raise an error when it fails to fetch the player.

    # Do stuff with the player.

Tip

When using client.fetch_player(...) this only attempts to search for that current player. Using client.create_player(...) will search for an existing player (and return it if it exists), otherwise, will just create a new player.

Getting tracks#

Getting tracks, uses a rest method. There is a few methods of fetching a track (or tracks!)

SearchingDecoding a track

This method allows for the user to search on a platform for a track.

track = await client.rest.load_track(...)

You need to replace the ... with a link, or a track with a searching parameter, then followed by the query.

ytsearch: - Searches Youtube for the track.
ytmsearch: - Searches Youtube Music for the track.
scsearch: - Searches SoundCloud for the track.

Examples:

ytsearch:Imagine Dragons - Radioactive (A Youtube search)
ytmsearch:Imagine Dragons - Believer (A Youtube music search)
scsearch:Imagine Dragons - Eyes Closed (A SoundCloud search)
https://music.youtube.com/watch?v=y4FiCl-tUJc (A link)

This method allows you to decode a track from its encoded state.

Note

The encoded state is attached to all track objects, and can be collected via track.encoded

track = await client.rest.decode_track(...)

Player Functions#

All of the functions you can do to a player.

Connecting and disconnecting#

Connecting#

You can connect to a channel, via the following methods

await player.connect(channel_id)

You can also mute and deafen the bot.

MutingDeafeningBoth

This will mute the bot.

await player.connect(channel_id, mute=True)

Tip

By default, mute is set to False.

This will un-deafen the bot.

await player.connect(channel_id, deaf=False)

Tip

By default, deaf is set to True.

This will un-deafen and mute the bot.

await player.connect(channel_id, mute=True, deaf=False)

Tip

By default, mute is set to False and deaf is set to True.

Tip

Replace channel_id with a GuildVoiceChannel or a integer of the channel id!

Disconnecting#

You can disconnect and stop the player, via the following methods.

await player.disconnect()

Play#

using the play method, has two different usages.

With addWithout add

Using play with add, works like the following.

# Add track(s) to your player.
await player.add(...)

# Leave .play() empty, to play the current queue.
await player.play()

Using play without add, works like the following.

await player.play(...)

What is ...

replace the ... with a track. Need help getting a track? check here

Note

.play() does not support multiple tracks. That is why the with .add() method exists.

Warning

if you attempt to call .play() without any tracks, the player will error out.

Add#

Using add, allows for the user to add tracks to the queue, without playing/pausing.

Example usage of adding is the following:

player.add(...)

What is ...

replace the ... with a track, multiple tracks or a playlist. Need help getting a track? check here

Pause#

Pausing, allows for you to play/pause the current track playing on the bot. There is a few options for pausing the tracks.

Force playingForce pausingToggling

The following method will force play the player, whether it is playing or not.

await player.pause(False)

The following method will force pause the player, whether it is playing or not.

await player.pause(True)

The following method will change it from its current state, to the opposite state.

await player.pause()

Stop#

Stopping the track, tells the lavalink player to play no song.

await player.stop()

Note

This does not touch any of the tracks in the queue.

Shuffle#

Shuffle the current queue.

player.shuffle()

Note

This does not touch the track in the first position.

Skip#

Skipping songs allows for you to skip one, or multiple songs.

OneMultiple

The following code, simply skips a singular track.

await player.skip()

The following code allows for skipping one or more tracks.

# This will skip 3 songs in the queue, starting from the first, playing track.
await player.skip(3)

Remove#

This allows for removing tracks. You can remove it via a track object, position or the tracks encoded value

TrackPosition

This method allows for removing a track via its track object.

player.remove(track)

This method allows for removing a track via its position.

player.remove(3)

Note

Please remember, pythons lists start at 0. So this example will actually remove the track in the 4th position of the queue.

Warning

If the track you remove is in the first position, it will not be stopped. It will continue playing.

Clear#

This is very similar to the Remove. It removes all tracks from the queue, and stops the player.

await player.clear()

Autoplay#

This allows you to toggle autoplay on or off.

Autoplay allows for playing the next track in the queue when the previous one ends.

Force enableForce pausingToggling

The following method will set autoplay to on.

player.set_autoplay(True)

The following method will set autoplay to off.

player.set_autoplay(False)

The following method will set autoplay to its opposite value.

player.set_autoplay()

Loop#

Pausing, allows for you to play/pause the current track playing on the bot. There is a few options for pausing the tracks.

Force loopingForce disable loopingToggling

The following method will force loop the player, whether it is looping or not.

player.set_loop(False)

The following method will force loop the player, whether it is looping or not.

player.set_loop(True)

The following method will change it from its current state, to the opposite state.

player.set_loop()

Volume#

This allows you to change the volume of the player.

ChangeReset

This allows you to change the volume of the player.

# The following sets the volume to half of its original.
await player.set_volume(50)

This will simply reset the player to its default value.

await player.set_volume()

Default value

The default value is 100.

Note

Any value above 100 will result in audio distortion, and artifacts.

Position#

This function allows for you to set the position of the track. This is in milliseconds.

await player.set_position(40000)

Filters#

This allows you to set or clear the current filter.

Change/SetClear

This allows you to change the current filter, or set a new one.

await player.set_filters(filters)

This allows you to completely clear the current filter.

await player.set_filters()

Tip

Learn more about filters here

This function, will put the track at 40 seconds.

Warning

If the position is outside of the track or there is no track playing, then it will result in an error.