Events

Error Impl's.

The error implemented classes.

PayloadEvent

PayloadEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    payload: str,
)

Bases: events_.OngakuEvent

Payload Event.

The event that is dispatched each time a message is received from the websocket.

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

payload property

payload: str

The payload received.

from_session classmethod

from_session(
    session: Session, payload: str
) -> PayloadEvent

Build the PayloadEvent with just a session.

ReadyEvent

ReadyEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    resumed: bool,
    session_id: str,
)

Bases: events_.OngakuEvent

Ready Event.

Dispatched by Lavalink upon successful connection and authorization. Contains fields determining if resuming was successful, as well as the session id.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

resumed property

resumed: bool

Whether or not the session has been resumed, or is a new session.

session_id property

session_id: str

The lavalink session id, for the current session.

from_session classmethod

from_session(
    session: Session, resumed: bool, session_id: str
) -> ReadyEvent

Build the ReadyEvent with just a session.

PlayerUpdateEvent

PlayerUpdateEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    state: State,
)

Bases: events_.OngakuEvent

Player Update Event.

Dispatched every x seconds (configurable in application.yml) with the current state of the player.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

state property

state: State

The player state.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    state: player_.State,
) -> PlayerUpdateEvent

Build the PlayerUpdateEvent with just a session.

StatisticsEvent

StatisticsEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    players: int,
    playing_players: int,
    uptime: int,
    memory: Memory,
    cpu: Cpu,
    frame_statistics: FrameStatistics | None,
)

Bases: events_.OngakuEvent

Statistics Event.

A collection of statistics sent every minute.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

players property

players: int

The amount of players connected to the session.

playing_players property

playing_players: int

The amount of players playing a track.

uptime property

uptime: int

The uptime of the session in milliseconds.

memory property

memory: Memory

The memory stats of the session.

cpu property

cpu: Cpu

The CPU stats of the session.

frame_stats property

frame_stats: FrameStatistics | None

The frame statistics of the session.

from_session classmethod

from_session(
    session: Session,
    players: int,
    playing_players: int,
    uptime: int,
    memory: Memory,
    cpu: Cpu,
    frame_statistics: FrameStatistics | None,
) -> StatisticsEvent

Build the StatisticsEvent with just a session.

TrackStartEvent

TrackStartEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
)

Bases: events_.OngakuEvent

Track start event.

Dispatched when a track starts playing.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

track property

track: Track

The track related to this event.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
) -> TrackStartEvent

Build the TrackStartEvent with just a session.

TrackEndEvent

TrackEndEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    reason: events_.TrackEndReasonType,
)

Bases: events_.OngakuEvent

Track end event.

Dispatched when a track ends.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

track property

track: Track

The track related to this event.

reason property

reason: events_.TrackEndReasonType

The reason for the track ending.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    reason: events_.TrackEndReasonType,
) -> TrackEndEvent

Build the TrackEndEvent with just a session.

TrackException

TrackException(
    message: str | None,
    severity: errors_.SeverityType,
    cause: str,
)

Bases: errors_.ExceptionError

message property

message: str | None

The message of the exception.

severity property

severity: errors_.SeverityType

The severity of the exception.

cause property

cause: str

The cause of the exception.

TrackExceptionEvent

TrackExceptionEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    exception: errors_.ExceptionError,
)

Bases: events_.OngakuEvent

Track exception event.

Dispatched when a track throws an exception.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

track property

track: Track

The track related to this event.

exception property

exception: errors_.ExceptionError

The occurred exception.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    exception: errors_.ExceptionError,
) -> TrackExceptionEvent

Build the TrackExceptionEvent with just a session.

TrackStuckEvent

TrackStuckEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    threshold_ms: int,
)

Bases: events_.OngakuEvent

Track stuck event.

Dispatched when a track gets stuck while playing.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

track property

track: Track

The track related to this event.

threshold_ms property

threshold_ms: int

The threshold in milliseconds that was exceeded.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    threshold_ms: int,
) -> TrackStuckEvent

Build the PayloadEvent with just a session.

WebsocketClosedEvent

WebsocketClosedEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    code: int,
    reason: str,
    by_remote: bool,
)

Bases: events_.OngakuEvent

Websocket Closed Event.

Dispatched when an audio WebSocket (to Discord) is closed. This can happen for various reasons (normal and abnormal), e.g. when using an expired voice server update. 4xxx codes are usually bad. See the Discord Docs.

Reference

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

code property

code: int

The error code that discord responded with.

reason property

reason: str

The close reason.

by_remote property

by_remote: bool

Whether the connection was closed by Discord.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    code: int,
    reason: str,
    by_remote: bool,
) -> WebsocketClosedEvent

Build the PayloadEvent with just a session.

QueueEmptyEvent

QueueEmptyEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    old_track: track_.Track,
)

Bases: events_.OngakuEvent

Queue empty event.

Dispatched when the player finishes all the tracks in the queue.

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

old_track property

old_track: Track

The track that was previously playing.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    old_track: track_.Track,
) -> QueueEmptyEvent

Build the PayloadEvent with just a session.

QueueNextEvent

QueueNextEvent(
    app: hikari.RESTAware,
    client: Client,
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    old_track: track_.Track,
)

Bases: events_.OngakuEvent

Queue next event.

Dispatched when the player starts playing a new track.

client property

client: Client

The ongaku client attached to the event.

session property

session: Session

The session attached to the event.

guild_id property

guild_id: hikari.Snowflake

The guild related to this event.

track property

track: Track

The track related to this event.

old_track property

old_track: Track

The track that was previously playing.

from_session classmethod

from_session(
    session: Session,
    guild_id: hikari.Snowflake,
    track: track_.Track,
    old_track: track_.Track,
) -> QueueNextEvent

Build the PayloadEvent with just a session.