Skip to content

Commit

Permalink
add sources.
Browse files Browse the repository at this point in the history
Added sources. All but youtube links are missing.
  • Loading branch information
mplatypus committed Jul 20, 2024
1 parent 93102f8 commit 9085ada
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 0 deletions.
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
```
### 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.

### 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.

### 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.

### 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
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

0 comments on commit 9085ada

Please sign in to comment.