Events¶

Track¶

Track Start¶

sonolink.on_sonolink_track_start(player: sonolink.Player, payload: sonolink.gateway.TrackStartEvent)¶

Called when a track starts playing.

Parameters¶

player: sonolink.Player: The player that is playing the track.
payload: sonolink.gateway.TrackStartEvent: The event payload containing information about the track that started playing.

class sonolink.gateway.TrackStartEvent[source]¶

Attributes

node
track

Represents a track start event.

property node: Node¶: The node that received the event.

track¶: The track that started playing.

Track End¶

sonolink.on_sonolink_track_end(player: sonolink.Player, payload: sonolink.gateway.TrackEndEvent)¶

Called when a track ends.

Parameters¶

player: sonolink.Player: The player that was playing the track.
payload: sonolink.gateway.TrackEndEvent: The event payload containing information about the track that finished playing and the reason it ended.

class sonolink.gateway.TrackEndEvent[source]¶

Attributes

node
reason
track

Represents a track end event.

property node: Node¶: The node that received the event.

reason: TrackEndReason¶: The reason the track ended.

track¶: The track that ended playing.

Track Exception¶

sonolink.on_sonolink_track_exception(player: sonolink.Player, payload: sonolink.gateway.TrackExceptionEvent)¶

Called when an exception occurs while playing a track.

Parameters¶

player: sonolink.Player: The player that was playing the track.
payload: sonolink.gateway.TrackExceptionEvent: The event payload containing information about the track that caused the exception and the exception.

class sonolink.gateway.TrackExceptionEvent[source]¶

Attributes

exception
node
track

Represents a track exception event.

exception: events.TrackException¶: The occurred exception.

property node: Node¶: The node that received the event.

track¶: The track that thew the exception.

Track Stuck¶

sonolink.on_sonolink_track_stuck(player: sonolink.Player, payload: sonolink.gateway.TrackStuckEvent)¶

Called when a track gets stuck while playing.

Parameters¶

player: sonolink.Player: The player that was playing the track.
payload: sonolink.gateway.TrackStuckEvent: The event payload containing information about the track that got stuck and the threshold that was exceeded.

class sonolink.gateway.TrackStuckEvent[source]¶

Attributes

node
threshold
track

Represents a track stuck event.

property node: Node¶: The node that received the event.

threshold: int¶: The threshold in milliseconds that was exceeded.

track¶: The track that got stuck.

Node¶

Node Ready¶

sonolink.on_sonolink_node_ready(payload: sonolink.gateway.ReadyEvent)¶

Called when a node is ready.

Parameters¶

payload: sonolink.gateway.ReadyEvent: The event payload containing information about the node that is ready.

class sonolink.gateway.ReadyEvent[source]¶

Attributes

node
resumed
session_id

Represents a ready event.

property node: Node¶: The node that received the event.

resumed: bool¶: Whether the session was resumed, if this is False it implies a new connection was created.

session_id: str¶: The secret session ID.

Node Close¶

sonolink.on_sonolink_node_close(node: sonolink.Node)¶

Called when a node is closed.

Parameters¶

node: sonolink.Node: The node that was closed.

Player¶

Player Update¶

sonolink.on_sonolink_player_update(player: sonolink.Player, payload: sonolink.gateway.PlayerUpdateEvent)¶

Called when a player is updated.

Parameters¶

player: sonolink.Player: The player that was updated.
payload: sonolink.gateway.PlayerUpdateEvent: The event payload containing information about the player’s current state.

class sonolink.gateway.PlayerUpdateEvent[source]¶

Attributes

guild_id
node
state

Represents a player_update event.

guild_id: int¶: The guild ID of the player.

property node: Node¶: The node that received the event.

state: receive.PlayerState¶: The state of the player.

Miscellaneous¶

Unknown Event¶

sonolink.on_sonolink_unknown_event(player: sonolink.Player, payload: dict[str, Any])¶

Called when an unknown event is received. This can be from plugins/extensions on Lavalink.

Parameters¶

player: sonolink.Player: The player that received the unknown event.
payload: dict: The raw event payload that was received.