Rest#

Rest client.

All REST based actions, happen in here.

RESTClient #

RESTClient(client: Client)

Base REST Client.

The base REST client, for all rest related actions.

Warning

Please do not create this on your own. Please use the rest attribute, in the base client object you created.

load_track `async` #

load_track(
    query: str, *, session: Session | None = None
) -> Playlist | typing.Sequence[Track] | Track | None

Load tracks.

Loads tracks from a site, a playlist or a track, to play on a player.

Lavalink Reference

Example

track = await client.rest.load_track("ytsearch:ajr")

await player.play(track)

PARAMETER	DESCRIPTION
`query`	The query for the search/link. TYPE: `str`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the track, playlist or search could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`typing.Sequence[Track]`	A sequence of tracks (a search result)
`Playlist`	A Playlist object.
`Track`	A Track object.
`None`	No result was returned.

decode_track `async` #

decode_track(
    track: str, *, session: Session | None = None
) -> Track

Decode a track.

Decode a track from its encoded state.

Lavalink Reference

Example

track = await client.rest.decode_track(BASE64)

await player.play(track)

PARAMETER	DESCRIPTION
`track`	The BASE64 code, from a previously encoded track. TYPE: `str`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the track could not be built
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Track`	The Track object.

decode_tracks `async` #

decode_tracks(
    tracks: typing.Sequence[str],
    *,
    session: Session | None = None
) -> typing.Sequence[Track]

Decode tracks.

Decode multiple tracks from their encoded state.

Lavalink Reference

Example

tracks = await client.rest.decode_tracks([BASE64_1, BASE64_2])

await player.add(tracks)

PARAMETER	DESCRIPTION
`tracks`	The BASE64 codes, from all the previously encoded tracks. TYPE: `typing.Sequence[str]`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the tracks could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`typing.Sequence[Track]`	The Track object.

fetch_players `async` #

fetch_players(
    session_id: str, *, session: Session | None = None
) -> typing.Sequence[Player]

Fetch all players.

Fetches all players on this session.

Lavalink Reference

Example

players = await client.rest.fetch_players(session_id)

for player in players:
    print(player.guild_id)

PARAMETER	DESCRIPTION
`session_id`	The Session ID that the players are attached too. TYPE: `str`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the players could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`typing.Sequence[Player]`	The Sequence of player objects.

fetch_player `async` #

fetch_player(
    session_id: str,
    guild: hikari.SnowflakeishOr[hikari.Guild],
    *,
    session: Session | None = None
) -> Player

Fetch a player.

Fetches a specific player from this session.

Lavalink Reference

Example

player = await client.rest.fetch_player(session_id, guild_id)

print(player.volume)

PARAMETER	DESCRIPTION
`session_id`	The Session ID that the players are attached too. TYPE: `str`
`guild`	The `guild` or `guild id` that the player is attached to. TYPE: `hikari.SnowflakeishOr[hikari.Guild]`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the player could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Player`	The player object.

update_player `async` #

update_player(
    session_id: str,
    guild: hikari.SnowflakeishOr[hikari.Guild],
    *,
    track: hikari.UndefinedNoneOr[Track] = hikari.UNDEFINED,
    position: hikari.UndefinedOr[int] = hikari.UNDEFINED,
    end_time: hikari.UndefinedOr[int] = hikari.UNDEFINED,
    volume: hikari.UndefinedOr[int] = hikari.UNDEFINED,
    paused: hikari.UndefinedOr[bool] = hikari.UNDEFINED,
    filters: hikari.UndefinedNoneOr[
        Filters
    ] = hikari.UNDEFINED,
    voice: hikari.UndefinedOr[Voice] = hikari.UNDEFINED,
    no_replace: bool = True,
    session: Session | None = None
) -> Player

Fetch a player.

Fetches a specific player from this session.

Lavalink Reference

Tip

Setting any value (except for session_id, or guild_id) to None, will set their values to None. To not modify them, do not set them to anything.

Warning

If you do not set any value (not including session_id or guild_id as they are required) you will receive a ValueError

Example

await client.rest.update_player(session_id, guild_id, paused=True)

PARAMETER	DESCRIPTION
`session_id`	The Session ID that the players are attached too. TYPE: `str`
`guild`	The `guild` or `guild id` that the player is attached to. TYPE: `hikari.SnowflakeishOr[hikari.Guild]`
`track`	The track you wish to set, or remove TYPE: `hikari.UndefinedNoneOr[Track]` DEFAULT: `hikari.UNDEFINED`
`position`	The new position for the track. TYPE: `hikari.UndefinedOr[int]` DEFAULT: `hikari.UNDEFINED`
`end_time`	The end time for the track. TYPE: `hikari.UndefinedOr[int]` DEFAULT: `hikari.UNDEFINED`
`volume`	The volume of the player. TYPE: `hikari.UndefinedOr[int]` DEFAULT: `hikari.UNDEFINED`
`paused`	Whether or not to pause the player. TYPE: `hikari.UndefinedOr[bool]` DEFAULT: `hikari.UNDEFINED`
`filters`	The filters to apply to the player. TYPE: `hikari.UndefinedNoneOr[Filters]` DEFAULT: `hikari.UNDEFINED`
`voice`	The player voice object you wish to set. TYPE: `hikari.UndefinedOr[Voice]` DEFAULT: `hikari.UNDEFINED`
`no_replace`	Whether or not the track can be replaced. TYPE: `bool` DEFAULT: `True`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`ValueError`	Raised when nothing new has been set.
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the track, playlist or search could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Player`	The player object.

delete_player `async` #

delete_player(
    session_id: str,
    guild: hikari.SnowflakeishOr[hikari.Guild],
    session: Session | None = None,
) -> None

Delete a player.

Deletes a specific player from this session.

Lavalink Reference

Example

await client.rest.delete_player(session_id, guild_id)

PARAMETER	DESCRIPTION
`session_id`	The Session ID that the players are attached too. TYPE: `str`
`guild`	The `guild` or `guild id` that the player is attached to. TYPE: `hikari.SnowflakeishOr[hikari.Guild]`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

update_session `async` #

update_session(
    session_id: str,
    *,
    resuming: bool | None = None,
    timeout: int | None = None,
    session: Session | None = None
) -> session_.Session

Update Lavalink session.

Updates the lavalink session.

Lavalink Reference

Example

await client.rest.update_session(session_id, False)

PARAMETER	DESCRIPTION
`session_id`	The session you wish to update. TYPE: `str`
`resuming`	Whether resuming is enabled for this session or not. TYPE: `bool \| None` DEFAULT: `None`
`timeout`	The timeout in seconds (default is 60s) TYPE: `int \| None` DEFAULT: `None`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the session could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Session`	The Session object.

fetch_info `async` #

fetch_info(*, session: Session | None = None) -> Info

Get information.

Gets the current sessions information.

Lavalink Reference

Example

info = await client.rest.fetch_info()

print(info.version.semver)

PARAMETER	DESCRIPTION
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the information could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Info`	The Info object.

fetch_version `async` #

fetch_version(*, session: Session | None = None) -> str

Get version.

Gets the current Lavalink version.

Lavalink Reference

Example

version = await client.rest.fetch_version()

print(version)

PARAMETER	DESCRIPTION
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`str`	The version, in string format.

fetch_stats `async` #

fetch_stats(
    *, session: Session | None = None
) -> Statistics

Get statistics.

Gets the current Lavalink statistics.

Lavalink Reference

Note

frame_statistics will always be None.

Example

stats = await client.rest.fetch_stats()

print(stats.players)

PARAMETER	DESCRIPTION
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the statistics could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`Statistics`	The Statistics object.

fetch_routeplanner_status `async` #

fetch_routeplanner_status(
    *, session: Session | None = None
) -> RoutePlannerStatus | None

Fetch routeplanner status.

Fetches the routeplanner status of the current session.

Lavalink Reference

Example

routeplanner_status = await client.rest.fetch_routeplanner_status()

if routeplanner_status:
    print(routeplanner_status.class_type.name)

PARAMETER	DESCRIPTION
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`BuildError`	Raised when the routeplanner status could not be built.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

RETURNS	DESCRIPTION
`RoutePlannerStatus`	The RoutePlannerStatus object.
`None`	The Route Planner for this server is not active.

update_routeplanner_address `async` #

update_routeplanner_address(
    address: str, *, session: Session | None = None
) -> None

Free routeplanner address.

Free's the specified routeplanner address.

Lavalink Reference

Example

await client.rest.update_routeplanner_address(address)

PARAMETER	DESCRIPTION
`address`	The address you wish to free. TYPE: `str`
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

update_all_routeplanner_addresses `async` #

update_all_routeplanner_addresses(
    *, session: Session | None = None
) -> None

Free all routeplanner addresses.

Frees every blocked routeplanner address.

Lavalink Reference

Example

await client.rest.update_all_routeplanner_addresses()

PARAMETER	DESCRIPTION
`session`	If provided, the session to use for this request. TYPE: `Session \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NoSessionsError`	Raised when there is no available sessions for this request to take place.
`TimeoutError`	Raised when the request takes too long to respond.
`RestEmptyError`	Raised when the request required a return type, but received nothing, or a 204 response.
`RestStatusError`	Raised when a 4XX or a 5XX status is received.
`RestRequestError`	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
`RestError`	Raised when an unknown error is caught.

Rest#

RESTClient #

load_track async #

decode_track async #

decode_tracks async #

fetch_players async #

fetch_player async #

update_player async #

delete_player async #

update_session async #

fetch_info async #

fetch_version async #

fetch_stats async #

fetch_routeplanner_status async #

update_routeplanner_address async #

update_all_routeplanner_addresses async #

load_track `async` #

decode_track `async` #

decode_tracks `async` #

fetch_players `async` #

fetch_player `async` #

update_player `async` #

delete_player `async` #

update_session `async` #

fetch_info `async` #

fetch_version `async` #

fetch_stats `async` #

fetch_routeplanner_status `async` #

update_routeplanner_address `async` #

update_all_routeplanner_addresses `async` #