-
-
Notifications
You must be signed in to change notification settings - Fork 675
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add sources tab to lavalink API documentation. #1079
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
--- | ||
description: Lavalink Sources API documentation. | ||
--- | ||
|
||
# Sources | ||
|
||
Below is all the default sources that come with Lavalink. Make sure to have them enabled! | ||
|
||
## YouTube | ||
|
||
!!! note | ||
Make sure you have the YouTube plugin added! | ||
|
||
You can find it [here](https://github.com/lavalink-devs/youtube-source). | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
youtube: true | ||
``` | ||
|
||
### Searching {: #youtube-searching } | ||
|
||
Searching using Youtube. | ||
|
||
- `ytsearch`: This will search `youtube.com` for relevant tracks/playlists. | ||
- `ytmsearch`: This will search `music.youtube.com` for relevant tracks/playlists. | ||
Comment on lines
+28
to
+29
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you add the isrc syntax here? |
||
|
||
### URLs {: #youtube-url } | ||
|
||
Supported URL types | ||
|
||
- https://youtube.com/watch?v=dQw4w9WgXcQ | ||
- https://youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg | ||
- https://youtube.com/shorts/dQw4w9WgXcQ | ||
- https://youtube.com/live/dQw4w9WgXcQ | ||
- https://youtube.com/embed/dQw4w9WgXcQ | ||
- https://www.youtube.com/watch?v=dQw4w9WgXcQ | ||
- https://www.youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg | ||
- https://www.youtube.com/shorts/dQw4w9WgXcQ | ||
- https://www.youtube.com/live/dQw4w9WgXcQ | ||
- https://www.youtube.com/embed/dQw4w9WgXcQ | ||
- https://youtu.be/watch?v=dQw4w9WgXcQ | ||
- https://youtu.be/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg | ||
- https://music.youtube.com/watch?v=dQw4w9WgXcQ | ||
- https://music.youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg | ||
- https://music.youtube.com/embed/dQw4w9WgXcQ | ||
|
||
## Bandcamp | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
bandcamp: true | ||
``` | ||
|
||
### Searching {: #bandcamp-searching } | ||
|
||
Searching using Bandcamp. | ||
|
||
- `bcsearch`: This will search `bandcamp.com` for relevant tracks/playlists. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also no playlists & search term + |
||
|
||
### URLs {: #bandcamp-url } | ||
|
||
Supported URL types | ||
|
||
- FIXME: add url's | ||
|
||
## SoundCloud | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
soundcloud: true | ||
``` | ||
|
||
### Searching {: #soundcloud-searching } | ||
|
||
Searching using SoundCloud. | ||
|
||
- `scsearch`: This will search `soundcloud.com` for relevant tracks/playlists. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also no playlists & search term + |
||
|
||
### URLs {: #soundcloud-url } | ||
|
||
Supported URL types | ||
|
||
- FIXME: add url's | ||
|
||
## Twitch | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
twitch: true | ||
``` | ||
|
||
### URLs {: #twitch-url } | ||
|
||
Supported URL types | ||
|
||
- FIXME: add url's | ||
|
||
## Vimeo | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
vimeo: true | ||
``` | ||
|
||
### URLs {: #vimeo-url } | ||
|
||
Supported URL types | ||
|
||
- FIXME: add url's | ||
|
||
## Nico | ||
|
||
Enabling this option: | ||
|
||
```yml title="application.yml" | ||
server: | ||
sources: | ||
nico: true | ||
``` | ||
|
||
### URLs {: #nico-url } | ||
|
||
Supported URL types | ||
|
||
- FIXME: add url's | ||
Comment on lines
+127
to
+141
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. pretty sure the current nico implementation doesn't work anymore, so you can ignore it until fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this does not work for the new yt plugin you mentioned above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I do know that, didn't change it/haven't yet. Can do tommorrow :D