Skip to content

$queue

$queue will return the current song queue.

Usage

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

Parameters

FieldTypeDescriptionRequired
page?numberqueue pagefalse
limit?numbermaximum of songs to displayfalse
format?stringformat to display information about the songsfalse
separator?stringThe separator of queue, default = ”,“false
Types
PropertyReturnsSupports
{title}Returns the video/song titlestringYouTube, Spotify, SoundCloud, Url, LocalFile
{channelId}Returns the channel idstringYouTube
{artist}Returns the ArtiststringYouTube, Spotify, SoundCloud
{artistURL}Returns the Artist URLstringYouTube, SoundCloud
{artistAvatar}Returns the Artist AvatarstringSoundCloud
{duration}Returns the track/video duration in msnumberYouTube, Spotify, SoundCloud, Url, LocalFile
{identifier}soundcloud, youtube, localfile, url, spotifystringYouTube, Spotify, SoundCloud, Url, LocalFile
{views}Returns the amount of Views/Plays of the video/songstringYouTube, Spotify, SoundCloud, Url, LocalFile
{likes}Returns the amount of likes of the video/songnumberSpotify, SoundCloud, Url, LocalFile
{thumbnail}Returns the song/video thumbnailnumberYouTube, Spotify, SoundCloud
{id}Returns the song/video IDstringYouTube, Spotify, SoundCloud, Url, LocalFile
{description}Returns the video/song descriptionstringYouTube, Spotify, SoundCloud
{createdAt}Returns the Creation Date of the video/songstringYouTube, Spotify, SoundCloud
{platformType}Returns the platform TypenumberYouTube, Spotify, SoundCloud, Url, LocalFile
{rawData}Returns song information as objectobjectYouTube, Spotify, SoundCloud, Url, LocalFile
{formattedPlatforms}SoundCloud, YouTube, Localfile, Url, SpotifystringYouTube, Spotify, SoundCloud, Url, LocalFile
{requester}Returns the Song Requester (user object, .user.id, .user.name etc)stringYouTube, Spotify, SoundCloud, Url, LocalFile
{position}Returns the Song Position in the current QueuenumberYouTube, Spotify, SoundCloud, Url, LocalFile

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
});