Skip to content

Commit 51375dd

Browse files
committed
Reformat Available Clients list.
1 parent 6ca6c87 commit 51375dd

File tree

2 files changed

+15
-35
lines changed

2 files changed

+15
-35
lines changed

README.md

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -182,43 +182,23 @@ plugins:
182182
## Available Clients
183183
Currently, the following clients are available for use:
184184

185-
- `MUSIC`
186-
- ✔ Provides support for searching YouTube music (`ytmsearch:`).
187-
- ❌ Cannot be used for playback, or playlist/mix/livestream loading.
188-
- `WEB`
189-
- ✔ Opus formats.
190-
- `MWEB`
191-
- ✔ Opus formats.
192-
- `WEBEMBEDDED`
193-
- ✔ Opus formats.
194-
- ✔ Limited age-restricted video playback.
195-
- ❌ No mix/playlist/search support.
196-
- `ANDROID`
197-
- ❌ Heavily restricted, frequently dysfunctional.
198-
- `ANDROID_MUSIC`
199-
- ✔ Opus formats.
200-
- ❌ No playlist/livestream support.
201-
- `ANDROID_VR`
202-
- ✔ Opus formats.
203-
- `IOS`
204-
- ❌ No Opus formats (requires transcoding).
205-
- `TV`
206-
- ✔ Opus formats.
207-
- ✔ OAuth compatibility.
208-
- ❌ No mix/playlist/search/video *lookup* support.
209-
- ❌ Playback only.
210-
- `TVHTML5EMBEDDED`
211-
- ✔ Opus formats.
212-
- ✔ OAuth compatibility.
213-
- ❌ No playlist support.
214-
- ❌ Playback requires sign-in.
185+
| Identifier | Opus Formats | OAuth | Age-restriction Support | Playback Support | Metadata Support | Additional Notes |
186+
|-------------------|--------------|-------|-------------------------|------------------|------------------------------|------------------------------------------------------|
187+
| `MUSIC` | Yes | Yes | No | No | Video | YouTube music support via `ytmsearch:` search prefix |
188+
| `WEB` | Yes | No | No | Yes + Livestream | Video, Search, Playlist, Mix | |
189+
| `MWEB` | Yes | No | No | Yes + Livestream | Video, Search, Playlist, Mix | |
190+
| `WEBEMBEDDED` | Yes | No | Limited | Yes + Livestream | Video | |
191+
| `ANDROID` | Yes | No | No | Yes + Livestream | Video, Search, Playlist, Mix | Heavily restricted, frequently dysfunctional |
192+
| `ANDROID_MUSIC` | Yes | No | No | Yes | Video, Search, Mix | |
193+
| `ANDROID_VR` | Yes | No | No | Yes + Livestream | Video, Search, Playlist, Mix | |
194+
| `IOS` | No | No | No | Yes + Livestream | Video, Search, Playlist, Mix | |
195+
| `TV` | Yes | Yes | With OAuth | Yes + Livestream | None | Playback requires sign-in |
196+
| `TVHTML5EMBEDDED` | Yes | Yes | With OAuth | Yes + Livestream | Video, Search, Mix | Playback requires sign-in |
215197

216198
> [!NOTE]
199+
> Clients that do not return Opus formats will require transcoding.
217200
> Livestreams do not yield Opus formats so will always require transcoding.
218201

219-
> [!NOTE]
220-
> Assume clients do not work with OAuth unless stated.
221-
222202

223203
## Using OAuth Tokens
224204
You may notice that some requests are flagged by YouTube, causing an error message asking you to sign in to confirm you're not a bot.

common/src/main/java/dev/lavalink/youtube/YoutubeAudioSourceManager.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ public void useOauth2(@Nullable String refreshToken, boolean skipInitialization)
172172
oauth2Handler.setRefreshToken(refreshToken, skipInitialization);
173173

174174
if (Arrays.stream(clients).noneMatch(Client::supportsOAuth)) {
175-
log.warn("OAuth has been enabled without registering any OAuth-enabled clients. " +
175+
log.warn("OAuth has been enabled without registering any OAuth-compatible clients. " +
176176
"Please consult https://github.com/lavalink-devs/youtube-source?tab=readme-ov-file#available-clients for a list of " +
177-
"OAuth-enabled clients.");
177+
"OAuth-compatible clients.");
178178
}
179179
}
180180

0 commit comments

Comments
 (0)