lavalink-devs / youtube-source

A rewritten YouTube source manager for Lavaplayer.
MIT License
138 stars 19 forks source link

Improve Migration Guide for YoutubeAudioSourceManager #18

Closed adrianojsoares1 closed 3 months ago

adrianojsoares1 commented 3 months ago

Type of Change Documentation Update

Description I wanted to introduce some more context into migration from the deprecated YoutubeAudioSourceManager in the Lavaplayer repository. It may not be clear to developers that this class is still being instantiated by default, and that it should be excluded.

This is related to changes made to Lavaplayer in release 2.1.2

The following image demonstrates what happens when the supported YoutubeAudioSourceManager is registered without excluding the deprecated client. There are now two instances of the client, which could lead to unexpected behavior.

image

devoxin commented 3 months ago

As an aside, I think the use of excludeSources should be highlighted as a feature that only lavalink-devs/lavaplayer supports currently. This isn't a standard feature found within all Lavaplayer forks so users may get confused if they try to use an overload that doesn't exist.