Discord Player

TrackJSON

JSON-compatible representation of a Track.

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

JSON-compatible representation of a Track.

Properties

sourceReferenceoptional

Inherited from TrackData.sourceReference

sourceReference?: ProviderReference

Portable provider payload; exclude secrets and live resources.

lyricsReferenceoptional

Inherited from TrackData.lyricsReference

lyricsReference?: ProviderReference

Optional portable lyrics provider affinity.

rawoptional

Inherited from TrackData.raw

raw?: Record<string, any>

Process-local legacy data, never persisted.

engineoptional

Inherited from TrackData.engine

engine?: unknown

Legacy source location or engine object, never persisted.

queryTypeoptional

Inherited from TrackData.queryType

queryType?: string

Legacy query hint.

requestMetadataoptional

Inherited from TrackData.requestMetadata

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

Legacy asynchronous metadata provider, never persisted.

cleanTitleoptional

Inherited from TrackData.cleanTitle

cleanTitle?: string

Legacy display title.

requesteroptional

Inherited from TrackData.requester

requester?: TrackRequester | null

Alias for requestedBy.

sourceoptional

Inherited from TrackData.source

source?: string

Provider-defined source name or identifier.

liveoptional

Inherited from TrackData.live

live?: boolean

Whether this is a live stream without a fixed duration.

metadataoptional

Inherited from TrackData.metadata

metadata?: Metadata | null

Arbitrary source-plugin metadata.

idoverride

Overrides TrackData.id

id: string

Stable track identifier.

titleoverride

Overrides TrackData.title

title: string

Display title.

authoroverride

Overrides TrackData.author

author: string

Track author or artist.

descriptionoverride

Overrides TrackData.description

description: string

Track description.

urloverride

Overrides TrackData.url

url: string

Source page URL.

thumbnailoverride

Overrides TrackData.thumbnail

thumbnail: string

Thumbnail URL.

durationoverride

Overrides TrackData.duration

duration: string

Human-readable duration.

durationMSoverride

Overrides TrackData.durationMS

durationMS: number

Duration in milliseconds.

viewsoverride

Overrides TrackData.views

views: number

View or play count.

requestedByoverride

Overrides TrackData.requestedBy

requestedBy: string | null

Serialized requester identity, or null when no requester is known.

playlistoverride

Overrides TrackData.playlist

playlist: PlaylistJSON | null

Serialized playlist metadata, or null when omitted.

On this page