Discord Player
Generated APITypeScript@discord-player/plugin-host

PlaylistData

Metadata used to construct a Playlist.

You are reading the v8 docsDev
InterfaceTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/structures/playlist.ts:11
interface PlaylistData

Metadata used to construct a Playlist.

Properties

idoptional

id?: string

Stable source playlist identifier.

urloptional

url?: string

Source page URL.

titleoptional

title?: string

Display title.

descriptionoptional

description?: string

Playlist description.

thumbnailoptional

thumbnail?: string

Thumbnail URL.

typeoptional

type?: "album" | "playlist"

Album or playlist classification.

sourceoptional

source?: string

Source name.

authoroptional

author?: {
  name: string;
  url: string;
}

Playlist author name and source URL.

tracksoptional

tracks?: (Track<unknown> | TrackData<unknown>)[]

Playlist entries.

OperationMap

Extensible source operation contracts. Augmented operations also need host definitions.

PlaylistJSON

JSON-compatible Playlist representation.

On this page

Propertiesidurltitledescriptionthumbnailtypesourceauthortracks