Skip to content

$queue

$queue will return the current guild queue list.

Usage

$queue[page?;limit?;format?;separator?]

Parameters

FieldTypeDescriptionRequired
page?numberqueue pagefalse
limit?numbermaximum of songs to displayfalse
format?stringformat to display information about the songs (see below)false
separator?stringThe separator between songsfalse

Formatting

FieldReturnsDescription
{position} numberSong position in the queue
{title}stringSong title
{thumbnail}stringSong thumbnail (if any)
{url}stringSong url
{duration}stringSong duration
{artist}stringSong author
{platform}stringTrack player platform
{identifier}stringTrack identifier
{isSeekable}booleanReturn true if the track is seekable
{isStream}booleanReturn true if the track is streaming
{isrc}stringTrack isrc
{durationMs}numberSong duration in milliseconds
{queueLength}numberPlayer queue length
{albumName}stringSong album name (if any)
{albumUrl}stringSong album url (if any)
{artist.artworkUrl}stringArtist artwork url (if any)
{artist.url}stringArtist url (if any)
{requester.username}stringRequester username
{requester.id}snowflakeRequester user id
{requester.avatar}stringRequester user avatar
{requester.banner}stringRequester user banner
{requester.mention}stringRequester mention

Example(s)

This will return the current queue in the {position}) {title} - {requester.user.name} format

1
client.command({
2
name: "queue",
3
code: `
4
$queue[1;10;{position}) {title} - {requester.user.name}]
5
`
6
});