Changelog¶

This page keeps a detailed human friendly rendering of what’s new and changed in specific versions.

Unreleased ¶

Added the missing auto_reconnect parameter to Client.create_node() for controlling whether the client should automatically attempt to reconnect to the node on disconnection. This defaults to True.
Added Node.reconnect() for manually triggering a reconnection to the node.
Added TrackStartEvent.original and TrackEndEvent.original to access the original track passed to Player.play().
Serializable extras are now forwarded to Lavalink as user_data and accessible via Playable.extras on reconstructed tracks. Non-serializable values are warned and accessible via .original.extras.

Fixed an issue where the client would not attempt to reconnect to a node after a disconnection, even if auto_reconnect was enabled.
Fixed an issue with using the speed extra, or the curl-cffi package where if would raise a CurlError and the library would fail to handle it properly, causing the node to be left in a broken state.

Recursion issue in sonolink.Player custom subclass and instance checks that raised a RecursionError during issubclass or isinstance checks.
sonolink.Player not properly disconnecting after Discord 4014 and 4022 voice close events, which could leave players stuck in an invalid voice session state.
sonolink.Player not disconnecting on stale LavaLink session.
Missing typings for sonolink.gateway.PlayerDisconnectEvent.extra_data on sonolink.gateway.PlayerDisconnectEvent.

Added support for Nextcord via NextcordPlayer.

See the Nextcord examples for usage.
Added sonolink.get_client for retrieving the active client instance.
Added Client.get_node() to retrieve a specific node from the client.
Added three new events:
Added Player.update() to quickly update multiple player settings at once. Player.autoplay_settings, Player.history_settings, and Player.queue_mode are now exposed and can be set directly.
Added TrackSourceType.DEEZER as a supported track source.
Added Queue.count and History.count properties.
Added Queue.autoplay_tracks and Queue.put_autoplay() to fix autoplay queue priority via a dedicated stream. Playable.autoplay is also now exposed.
Added AutoPlaySeedMissing, a specific error raised when autoplay has no seed tracks to generate from.
Added framework-specific import and mismatch exceptions:
- FrameworkClientMismatch
- FrameworkImportError
Added a Getting Started guide.
Added four new migration guides:
- Mafic
- Lavalink.py
- Lavaplay.py
- Pomice
The existing WaveLink guide has also been updated.
Added a py.typed marker file for improved typing compatibility with type checkers.
Added two new keyword arguments to Client.create_node(): host and port for specifying the node URI in parts as an alternative to the single uri string; uri is now optional to allow for this.
Added a Code of Conduct for project community guidelines.

WSCloseEvent has been renamed to WebSocketClosedEvent.
get_best_node() now prefers nodes with known stats over nodes with no reported stats.
Swapped asyncio.TimeoutError with the built-in TimeoutError throughout.
Cleaned up documentation for all enums.

Removed the fallback to discord.py as the default framework.
Removed the unused value argument from Player.pause(). Player.resume() is no longer an alias for unpausing — it must be called explicitly to resume playback.

Fixed incorrect generics on the PycordPlayer.
Fixed force parameter handling in Player.disconnect.
Fixed the library raising QueueEmpty when skipping tracks for the user internally.

sonolink.gateway.Node has been split into multiple components internally for better separation of concerns and maintainability. This is not a breaking change as the public API remains the same, but it should improve code readability and future extensibility.
Formatted the project with Ruff for consistent code style and linting.

Inconsistent environment variable usage across code and documentation
Fixed performance and memory issue in PlayerFactory caused by repeated metadata scans:
- Reduced connection time (~11x faster)
- Reduced memory peak (~12x lower)
- Eliminated repeated expensive importlib.metadata.packages_distributions() calls

Initial release. For more information on what this added, consider referring to the API Reference or the examples.