$playlist
$playlist
will return a list of tracks from the
playlist.
Usage
$playlist[name;userId?;page?;limit?;format?;separator?]
Parameters
Field | Type | Description | Required |
---|---|---|---|
name | string | Playlist name | true |
userID? | snowflake | User ID | false |
page? | number | queue page | false |
limit? | number | maximum of songs to display | false |
format? | string | format to display information about the songs (see below) | false |
separator? | string | The separator between songs | false |
You require
Playlist
setup in your manager instance.
Formatting
Field | Returns | Description |
---|---|---|
{position} |
number | Song position in the queue |
{title} |
string | Song title |
{thumbnail} |
string | Song thumbnail (if any) |
{url} |
string | Song url |
{duration} |
string | Song duration |
{artist} |
string | Song author |
{platform} |
string | Track player platform |
{identifier} |
string | Track identifier |
{isSeekable} |
boolean |
Return true if the track is seekable
|
{isStream} |
boolean |
Return true if the track is
streaming
|
{isrc} |
string | Track isrc |
{durationMs} |
number | Song duration in milliseconds |
{albumName} |
string | Song album name (if any) |
{albumUrl} |
string | Song album url (if any) |
{artist.avatar} |
string | Artist artwork url (if any) |
{artist.url} |
string | Artist url (if any) |
{playlist.name} |
string | Track playlist name |
{playlist.author} |
string | Track playlist author |
{playlist.thumbnail} |
string | Track playlist thumbnail |
{playlist.tracks} |
number | Total tracks in the playlist |
{playlist.url} |
string | Playlist URL |
Example(s)
This will return a list of tracks from the playlist in the
{position}) {title}
format
1client.command({2 name: 'playlist',3 code: `4 $playlist[My Playlist;$authorId;1;10;{position}) {title}]5 `6});
This will return a list of tracks from the playlist in the
{position}) {title}
format
1module.exports = [2 {3 name: 'playlist',4 code: `5 $playlist[My Playlist;$authorId;1;10;{position}) {title}]6 `7 }8];