Client

Client.

The base client for ongaku.

Client

Client(
    app: hikari.GatewayBotAware,
    *,
    session_handler: typing.Type[
        SessionHandler
    ] = BasicSessionHandler,
    logs: str | int = "INFO",
    attempts: int = 3
)

Client.

The client for ongaku.

Note

The lowest log level for ongaku is TRACE_ONGAKU which will result in all traces being printed to the terminal.

Example

bot = hikari.GatewayBot("...")
client = ongaku.Client(bot)

PARAMETER	DESCRIPTION
app	The application that the client will attach too. TYPE: hikari.GatewayBotAware
session_handler	The session handler to use for the current client. TYPE: typing.Type[SessionHandler] DEFAULT: BasicSessionHandler
logs	The log level for ongaku. TYPE: str | int DEFAULT: 'INFO'
attempts	The amount of attempts a session will try to connect to the server. TYPE: int DEFAULT: 3

app property

app: hikari.GatewayBotAware

The application this client is included in.

rest property

rest: RESTClient

The rest client for calling rest actions.

is_alive property

is_alive: bool

Whether the session handler is alive.

Note

If the hikari.StartedEvent has occurred, and this is False, ongaku is no longer running and has crashed. Check your logs.

entity_builder property

entity_builder: EntityBuilder

The entity builder.

session_handler property

session_handler: SessionHandler

Session handler.

The session handler that is currently controlling the sessions.

Warning

This should not be touched, or used if you do not know what you are doing. Please use the other methods in client for anything session handler related.

from_arc classmethod

from_arc(
    client: arc.GatewayClient,
    *,
    session_handler: typing.Type[
        SessionHandler
    ] = BasicSessionHandler,
    logs: str | int = "INFO",
    attempts: int = 3
) -> Client

From Arc.

This supports client and player injection for Arc

Example

bot = arc.GatewayBot(...)
client = arc.GatewayClient(bot)
ongaku_client = ongaku.Client.from_arc(client)

PARAMETER	DESCRIPTION
client	Your Gateway client for arc. TYPE: arc.GatewayClient
session_handler	The session handler to use for the current client. TYPE: typing.Type[SessionHandler] DEFAULT: BasicSessionHandler
logs	The log level for ongaku. TYPE: str | int DEFAULT: 'INFO'
attempts	The amount of attempts a session will try to connect to the server. TYPE: int DEFAULT: 3

from_tanjun classmethod

from_tanjun(
    client: tanjun.abc.Client,
    *,
    session_handler: typing.Type[
        SessionHandler
    ] = BasicSessionHandler,
    logs: str | int = "INFO",
    attempts: int = 3
) -> Client

From Tanjun.

This supports client injection for Tanjun

Example

bot = arc.GatewayBot(...)
client = tanjun.Client.from_gateway_bot(bot)
ongaku_client = ongaku.Client.from_tanjun(client)

PARAMETER	DESCRIPTION
client	Your Gateway client from tanjun. TYPE: tanjun.abc.Client
session_handler	The session handler to use for the current client. TYPE: typing.Type[SessionHandler] DEFAULT: BasicSessionHandler
logs	The log level for ongaku. TYPE: str | int DEFAULT: 'INFO'
attempts	The amount of attempts a session will try to connect to the server. TYPE: int DEFAULT: 3

create_session

create_session(
    name: str,
    ssl: bool = False,
    host: str = "127.0.0.1",
    port: int = 2333,
    password: str = "youshallnotpass",
) -> Session

Create Session.

Create a new session for the session handler.

Example

client = ongaku.Client(...)

client.add_session(host="192.168.68.69")

Warning

The name set must be unique, otherwise an error will be raised.

Parameters name The name of the session ssl Whether the server uses https or just http. host The host of the lavalink server. port The port of the lavalink server. password The password of the lavalink server. attempts The attempts that the session is allowed to use, before completely shutting down.

RETURNS	DESCRIPTION
Session	The session that was added to the handler.

RAISES	DESCRIPTION
UniqueError

fetch_session

fetch_session(name: str) -> Session

Fetch a session.

Fetch a session from the session handler.

PARAMETER	DESCRIPTION
name	The name of the session TYPE: str

RETURNS	DESCRIPTION
Session	The session that was requested.

RAISES	DESCRIPTION
SessionMissingError	Raised when the session does not exist.

delete_session async

delete_session(name: str) -> None

Delete a session.

Delete a session from the session handler.

PARAMETER	DESCRIPTION
name	The name of the session TYPE: str

RAISES	DESCRIPTION
SessionMissingError	Raised when the session does not exist.

create_player

create_player(
    guild: hikari.SnowflakeishOr[hikari.Guild],
) -> Player

Create a player.

Create a new player to play songs on.

Example

client = ongaku.Client(...)

player = await client.create_player(guild_id)

await player.connect(channel_id)

await player.play(track)

PARAMETER	DESCRIPTION
guild	The guild, or guild id you wish to create a player for. TYPE: hikari.SnowflakeishOr[hikari.Guild]

RETURNS	DESCRIPTION
Player	The player that was created.

RAISES	DESCRIPTION
NoSessionsError	When there is no available sessions.

fetch_player

fetch_player(
    guild: hikari.SnowflakeishOr[hikari.Guild],
) -> Player

Fetch a player.

Fetches an existing player.

Example

client = ongaku.Client(...)
player = await client.fetch_player(guild_id)

await player.pause()

PARAMETER	DESCRIPTION
guild	The guild, or guild id you wish to fetch the player for. TYPE: hikari.SnowflakeishOr[hikari.Guild]

RAISES	DESCRIPTION
PlayerMissingError	Raised when the player for the specified guild does not exist.

delete_player async

delete_player(
    guild: hikari.SnowflakeishOr[hikari.Guild],
) -> None

Delete a player.

Delete a pre-existing player.

Example

client = ongaku.Client(...)
await client.delete_player(...)

PARAMETER	DESCRIPTION
guild	The guild, or guild id you wish to delete the player from. TYPE: hikari.SnowflakeishOr[hikari.Guild]

RAISES	DESCRIPTION
PlayerMissingError	Raised when the player for the specified guild does not exist.