Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ This endpoint is used to resolve audio tracks for use with the [Update Player](#

Plugins may also implement prefixes to allow for more search engines to be utilised.

You can find more about sources [here](./sources.md)

```
GET /v4/loadtracks?identifier=dQw4w9WgXcQ
Expand Down
141 changes: 141 additions & 0 deletions docs/api/sources.md
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
```
Comment on lines +18 to +22
Copy link
Member

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

Copy link
Contributor Author

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


### 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add the isrc syntax here? ytsearch:"%ISRC%"
also search results don't give back playlists
you should also add the : at the end I think
perhaps also that you put a search term behind the :
this needs to be added to all searches 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.
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The 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

1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ nav:
- Websocket: api/websocket.md
- Rest: api/rest.md
- Plugins: api/plugins.md
- Sources: api/sources.md
- Changelog:
- changelog/index.md
- v4: changelog/v4.md
Expand Down