Player

Player.

The player function, for all player related things.

Player

Player(
    session: Session,
    guild: hikari.SnowflakeishOr[hikari.Guild],
)

Base player.

The class that allows the player, to play songs, and more.

PARAMETER	DESCRIPTION
session	The session that the player is attached too. TYPE: Session
guild	The Guild the bot is attached too. TYPE: hikari.SnowflakeishOr[hikari.Guild]

session property

session: Session

The session this player is included in.

app property

app: hikari.GatewayBotAware

The session this player is included in.

guild_id property

guild_id: hikari.Snowflake

The guild id this player is attached too.

channel_id property

channel_id: hikari.Snowflake | None

The channel id this player is attached too.

None if not connected to a channel.

is_alive property

is_alive: bool

Is alive.

Whether the player is alive and attached to lavalink.

position property

position: int

Position.

The position of the track in milliseconds.

volume property

volume: int

The volume of the player.

If -1 the player has not been connected to lavalink and updated.

is_paused property

is_paused: bool

Whether the player is currently paused.

autoplay property

autoplay: bool

Autoplay.

Whether or not the next song will play, when this song ends.

loop property

loop: bool

Whether the current track will play again.

connected property

connected: bool

Connected.

Whether or not the player is connected to discords gateway.

queue property

queue: t.Sequence[track_.Track]

The current queue of tracks.

voice property

voice: player_.Voice | None

The player's voice state.

state property

state: player_.State | None

The player's player state.

filters property

filters: Filters | None

Filters for the player.

connect async

connect(
    channel: hikari.SnowflakeishOr[
        hikari.GuildVoiceChannel
    ],
    *,
    mute: bool = False,
    deaf: bool = True
) -> None

Connect.

Connect the current player to a voice channel.

Example

await player.connect(channel_id)

PARAMETER	DESCRIPTION
channel	The channel (or channel id) that you wish to connect the bot to. TYPE: hikari.SnowflakeishOr[hikari.GuildVoiceChannel]
mute	Whether or not to mute the player. TYPE: bool DEFAULT: False
deaf	Whether or not to deafen the player. TYPE: bool DEFAULT: True

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
PlayerConnectError	Raised when the voice state of the bot cannot be updated, or the voice events required could not be received.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

disconnect async

disconnect() -> None

Disconnect.

Disconnect the player from the discord channel, and stop the currently playing track.

Example

await player.disconnect()

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

play async

play(
    track: track_.Track | None = None,
    requestor: RequestorT | None = None,
) -> None

Play.

Play a new track, or start the playing of the queue.

Example

await player.play(track)

PARAMETER	DESCRIPTION
track	The track you wish to play. If none, pulls from the queue. TYPE: track_.Track | None DEFAULT: None
requestor	The member who requested the track. TYPE: RequestorT | None DEFAULT: None

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
PlayerConnectError	Raised when the player is not connected to a channel.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

add

add(
    tracks: (
        t.Sequence[track_.Track]
        | playlist_.Playlist
        | track_.Track
    ),
    requestor: RequestorT | None = None,
) -> None

Add tracks.

Add tracks to the queue.

Note

This will not automatically start playing the songs. please call .play() after, with no track, if the player is not already playing.

Example

await player.add(tracks)

PARAMETER	DESCRIPTION
tracks	The list of tracks or a singular track you wish to add to the queue. TYPE: t.Sequence[track_.Track] | playlist_.Playlist | track_.Track
requestor	The user/member who requested the song. TYPE: RequestorT | None DEFAULT: None

pause async

pause(value: bool | None = None) -> None

Pause the player.

Allows for the user to pause the currently playing track on this player.

Info

True will force pause the player, False will force unpause the player. Leaving it empty, will toggle it from its current state.

Example

await player.pause()

PARAMETER	DESCRIPTION
value	How you wish to pause the bot. TYPE: bool | None DEFAULT: None

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

stop async

stop() -> None

Stop current track.

Stops the audio, by setting the song to none.

Note

This does not touch the current queue, just clears the player of its track.

Example

await player.stop()

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

shuffle

shuffle() -> None

Shuffle.

Shuffle the current queue.

Note

This will not touch the first track.

RAISES	DESCRIPTION
PlayerQueueError	Raised when the queue has 2 or less tracks in it.

skip async

skip(amount: int = 1) -> None

Skip songs.

skip a selected amount of songs in the queue.

Example

await player.skip()

PARAMETER	DESCRIPTION
amount	The amount of songs you wish to skip. TYPE: int DEFAULT: 1

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
ValueError	Raised when the amount set is 0 or negative.
PlayerQueueError	Raised when the queue is empty.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

remove

remove(value: track_.Track | int) -> None

Remove track.

Removes the track, or the track in that position.

Warning

This does not stop the track if its in the first position.

Example

await player.remove()

PARAMETER	DESCRIPTION
value	Remove a selected track. If Track, then it will remove the first occurrence of that track. If an integer, it will remove the track at that position. TYPE: track_.Track | int

RAISES	DESCRIPTION
PlayerQueueError	Raised when the removal of a track fails.

clear async

clear() -> None

Clear the queue.

Clear the current queue, and also stop the audio from the player.

Example

player.clear()

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

set_autoplay

set_autoplay(enable: bool | None = None) -> bool

Set autoplay.

whether to enable or disable autoplay.

Example

await player.set_autoplay()

PARAMETER	DESCRIPTION
enable	Whether or not to enable autoplay. If left empty, it will toggle the current status. TYPE: bool | None DEFAULT: None

set_volume async

set_volume(volume: int = 100) -> None

Set the volume.

The volume you wish to set for the player.

Example

await player.set_volume(10)

Note

If you don't set a value to volume, it will simply become 100 (The default.)

PARAMETER	DESCRIPTION
volume	The volume you wish to set, from 0 to 1000. TYPE: int DEFAULT: 100

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
ValueError	Raised when the value is below 0, or above 1000.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

set_position async

set_position(value: int) -> None

Set the position.

Change the currently playing track's position.

Example

await player.set_position(10000)

PARAMETER	DESCRIPTION
value	The value, of the position, in milliseconds. TYPE: int

RAISES	DESCRIPTION
SessionStartError	Raised when the players session has not yet been started.
ValueError	Raised when the position given is negative, or the current tracks length is greater than the length given.
PlayerQueueError	Raised when the queue is empty.
RestEmptyError	Raised when a return type was requested, yet nothing was received.
RestStatusError	Raised when nothing was received, but a 4XX/5XX error was reported.
RestRequestError	Raised when a rest error is returned with a 4XX/5XX error.
BuildError	Raised when a construction of a ABC class fails.

set_filters async

set_filters(filters: Filters | None = None) -> None

Set Filters.

Set a new filter for the player.

PARAMETER	DESCRIPTION
filters	The filter to set the player with. TYPE: Filters | None DEFAULT: None

set_loop

set_loop(enable: bool | None = None) -> bool

Set loop.

whether to enable or disable looping of the current track.

Example

await player.set_loop()

PARAMETER	DESCRIPTION
enable	Whether or not to enable looping. If left empty, it will toggle the current status. TYPE: bool | None DEFAULT: None

transfer async

transfer(session: Session) -> Player

Transfer.

Transfer this player to another session.

Warning

This will kill the current player, and return a new player.

PARAMETER	DESCRIPTION
session	The session you wish to add the new player to. TYPE: Session

RETURNS	DESCRIPTION
Player	The new player.