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

deserialize

Reconstruct a Track from a versioned Track payload.

You are reading the v8 docsDev
FunctionTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/utils/serde.ts:58
function deserialize(value: SerializedTrack): Track

Reconstruct a Track from a versioned Track payload.

Parameters

NameTypeDescription
valueSerializedTrack

Versioned Track payload or supported v7 Track data.

Returns

Track

A Track instance with no source-plugin playback state.

function deserialize(value: SerializedPlaylist): Playlist

Reconstruct a Playlist from a versioned Playlist payload.

Parameters

NameTypeDescription
valueSerializedPlaylist

Versioned Playlist payload or supported v7 Playlist data.

Returns

Playlist

A Playlist instance containing reconstructed Track instances.

function deserialize(value: unknown): Playlist | Track<unknown>

Validate and reconstruct an untrusted versioned or supported legacy payload.

Parameters

NameTypeDescription
valueunknown

Serialized data to validate and reconstruct.

Returns

Playlist | Track<unknown>

A Track or Playlist instance.

definePlugin

Define a reusable source plugin.

deserializeSourceResult

Reconstruct source-host metadata in a consumer process without restoring private extractor objects. The normal Track retains the transient hint without requiring a second representation.