Discord Player

TrackData

Public metadata and optional portable source identity.

You are reading the v8 docsDev
InterfaceTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/structures/track-types.ts:13
interface TrackData<Metadata = unknown>

Public metadata and optional portable source identity.

Properties

sourceReferenceoptional

sourceReference?: ProviderReference

Portable provider payload; exclude secrets and live resources.

lyricsReferenceoptional

lyricsReference?: ProviderReference

Optional portable lyrics provider affinity.

rawoptional

raw?: Record<string, any>

Process-local legacy data, never persisted.

engineoptional

engine?: unknown

Legacy source location or engine object, never persisted.

queryTypeoptional

queryType?: string

Legacy query hint.

requestMetadataoptional

requestMetadata?: () => Promise<Metadata | null>

Legacy asynchronous metadata provider, never persisted.

cleanTitleoptional

cleanTitle?: string

Legacy display title.

idoptional

id?: string

Stable track identifier.

titleoptional

title?: string

Display title.

authoroptional

author?: string

Track author or artist.

descriptionoptional

description?: string

Track description.

urloptional

url?: string

Source page URL.

thumbnailoptional

thumbnail?: string

Thumbnail URL.

durationoptional

duration?: string

Human-readable duration.

durationMSoptional

durationMS?: number

Duration in milliseconds when known.

viewsoptional

views?: number

View or play count when available.

requestedByoptional

requestedBy?: TrackRequester | null

User or application identity that requested this track.

requesteroptional

requester?: TrackRequester | null

Alias for requestedBy.

sourceoptional

source?: string

Provider-defined source name or identifier.

liveoptional

live?: boolean

Whether this is a live stream without a fixed duration.

metadataoptional

metadata?: Metadata | null

Arbitrary source-plugin metadata.

playlistoptional

playlist?: Playlist | PlaylistData | null

Playlist containing this track, when present.

On this page