Generated API TypeScript @discord-player/plugin-host

searchLyrics

Resolve lyrics through the same operation registry as source metadata.

You are reading the v8 docsDev

FunctionTypeScript@discord-player/plugin-host

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

View sourcepackages/plugin-host/src/lyrics.ts:125

function searchLyrics(
  plugins: PluginRegistry,
  input: string | Track<unknown>,
  signal?: AbortSignal,
): Promise<LyricsResult[]>

Resolve lyrics through the same operation registry as source metadata.

Parameters

Name	Type	Description
plugins	`PluginRegistry`	Shared registry.
input	`string \| Track<unknown>`	Track or raw query.
signal?	`AbortSignal`	Caller lifetime.

Returns

Promise<LyricsResult[]>

Results in provider priority order, preferring explicit and source affinity.

parseLyrics

Parse LRC once, including multiple timestamps and decimal-second fractions.

serialize

Serialize any model that follows the structural Serializable contract. The returned value is checked at runtime so custom implementations cannot emit non-JSON data.