Skip to content

Commit

Permalink
add plugin info docs
Browse files Browse the repository at this point in the history
  • Loading branch information
topi314 committed Aug 13, 2023
1 parent fc22a2f commit 4458182
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,40 @@ plugins:
audioFormat: "mp3" # supported formats are: mp3, ogg_opus, ogg_vorbis, aac, wav, and flac. Default format is mp3
```

### Plugin Info

LavaSrc adds the following fields to tracks & playlists in Lavalink

#### Track

| Field | Type | Description |
|------------------|---------|--------------------------------|
| albumName | ?string | The name of the album |
| albumArtUrl | ?string | The url of the album art |
| artistUrl | ?string | The url of the artist |
| artistArtworkUrl | ?string | The url of the artist artwork |
| previewUrl | ?string | The url of the preview |
| isPreview | ?bool | Whether the track is a preview |

#### Playlist

| Field | Type | Description |
|-------------|----------------------------------|--------------------------------------------|
| type | [Playlist Type](#playlist-types) | The type of the playlist |
| url | ?string | The url of the playlist |
| artworkUrl | ?string | The url of the playlist artwork |
| author | ?string | The author of the playlist |
| totalTracks | ?int | The total number of tracks in the playlist |

#### Playlist Types

| Type | Description |
|-----------------|--------------------------------------------|
| album | The playlist is an album |
| playlist | The playlist is a playlist |
| artist | The playlist is an artist |
| recommendations | The playlist is a recommendations playlist |

---

## Supported URLs and Queries
Expand Down

0 comments on commit 4458182

Please sign in to comment.