PluginInfo

Plugin Info is an object, provided by LAVALINK PLUGINS and the CLIENT mixed

What are Lavalink Plugins, which exist and how do they work? Check out those reference informations: https://github.com/lavalink-devs/Lavalink/blob/master/PLUGINS.md

The PluginInfo is only filled out when you use a lavalink plugin, like lavasrc, lavasearch, ...

If you want you can override pluginInfo.clientData if you want to have some custom track informations!

Overview

Parameter
Type
Description
Of Which Plugin

type

The Response type

albumName

The Album Name

albumArtUrl

The Album artwork

artistUrl

The Artist URL

artistArtUrl

The Artist artwork Url

previewUrl

The Preview Track Url

isPreview

Wether it's a preview track / not

totalTracks

Amount of tracks

identifier

The Identifier of smt

artworkUrl

The Artwork Url

author

The Author Name

-

url

A Url for smt (OLD)

-

uri

A Url for smt (OLD)

-

clientData

{ [key:string]: any }

Custom Client Data

  • custom

Note that it can always have more data then the interface, if a plugin returns that.

Interface

export interface PluginInfo {
    /** The Type provided by a plugin */
    type?: "album" | "playlist" | "artist" | "recommendations" | string;
    /** The Identifier provided by a plugin */
    albumName?: string;
    /** The url of the album art */
    albumArtUrl?: string;
    /** The url of the artist */
    artistUrl?: string;
    /** The url of the artist artwork */
    artistArtworkUrl?: string;
    /** The url of the preview */
    previewUrl?: string;
    /** Whether the track is a preview */
    isPreview?: boolean;
    /** The total number of tracks in the playlist */
    totalTracks?: number;
    /** The Identifier provided by a plugin */
    identifier?: string;
    /** The ArtworkUrl provided by a plugin */
    artworkUrl?: string;
    /** The Author Information provided by a plugin */
    author?: string;
    /** The Url provided by a Plugin */
    url?: string,
    /** The Url provided by a Plugin */
    uri?: string,
    /** You can put specific track information here, to transform the tracks... */
    clientData?: { [key:string] : any },
}

clientData is optional, and can be declared by you manually afterwards savly, without messing things up (if you want)

PreviousTrackInfoNextUnresolvedTrack

Last updated