LyricsResult

Provider-neutral lyrics record; either representation may be absent.

You are reading the v8 docsDev

InterfaceTypeScript@discord-player/plugin-host

TypeScript@discord-player/plugin-host@discord-player/plugin-host › LyricsResult

interface LyricsResult

Provider-neutral lyrics record; either representation may be absent.

Properties

trackId?: string

Canonical Track ID when lookup used Track input, preventing stale queue loads.

provider?: ProviderReference

Stable provider identity, stamped by dispatch when absent.

plain: {
  available: false;
} | {
  available: true;
  text: string;
}

Plain text availability and contents.

synced: {
  available: false;
} | {
  available: true;
  lines: readonly LyricsLine[];
}

Synchronized representation, sorted by timestamp.

metadata?: JSONValue

Optional provider-owned, serializable metadata.

LyricsRequest

Lookup input shared by local plugins and HTTP metadata transport.

MediaAccessPolicy

Access limits for remote media materialization. Providers execute trusted code; this is not a plugin sandbox.