Skip to content

$songInfo

$songInfo will return given song’s information.

Usage

$songInfo[type?;position?]

Parameters

FieldTypeDescriptionRequired
type?stringinformation to retrievefalse
position?numbertrack positionfalse

Types

PropertyReturnsSupports
titleReturns the video/song titlestringYouTube, Spotify, SoundCloud, Url, LocalFile
channelIdReturns the channel idstringYouTube
artistReturns the ArtiststringYouTube, Spotify, SoundCloud
artistURLReturns the Artist URLstringYouTube, SoundCloud
artistAvatarReturns the Artist AvatarstringSoundCloud
durationReturns the track/video duration in msnumberYouTube, Spotify, SoundCloud, Url, LocalFile
identifiersoundcloud, youtube, localfile, url, spotifystringYouTube, Spotify, SoundCloud, Url, LocalFile
viewsReturns the amount of Views/Plays of the video/songstringYouTube, Spotify, SoundCloud, Url, LocalFile
likesReturns the amount of likes of the video/songnumberSpotify, SoundCloud, Url, LocalFile
thumbnailReturns the song/video thumbnailnumberYouTube, Spotify, SoundCloud
idReturns the song/video IDstringYouTube, Spotify, SoundCloud, Url, LocalFile
descriptionReturns the video/song descriptionstringYouTube, Spotify, SoundCloud
createdAtReturns the Creation Date of the video/songstringYouTube, Spotify, SoundCloud
platformTypeReturns the platform TypenumberYouTube, Spotify, SoundCloud, Url, LocalFile
rawDataReturns song information as objectobjectYouTube, Spotify, SoundCloud, Url, LocalFile
formattedPlatformsSoundCloud, YouTube, Localfile, Url, SpotifystringYouTube, Spotify, SoundCloud, Url, LocalFile
requesterReturns the Song Requester (user object, .user.id, .user.name etc)stringYouTube, Spotify, SoundCloud, Url, LocalFile
positionReturns the Song Position in the current QueuenumberYouTube, Spotify, SoundCloud, Url, LocalFile

Example(s)

This will return the current track name:

1
client.command({
2
name: "songInfo",
3
code: `
4
$songInfo[title]
5
`
6
});