OptionalfilenameExact file name, including any extension, next to the audio. A non-empty value replaces all automatic file candidates and ignores format; source and type still apply. Empty means automatic lookup. Must be a valid single Windows filename, without path syntax, device names or trailing dots/spaces; invalid names fail with INVALID_PARAMS.
OptionalformatSidecar extension to try; .lrc candidates are tried before .txt with any. Applies to automatic sidecar lookup only; a non-empty filename takes precedence.
OptionalpathTrack path; a |subsong:N suffix selects a subsong. Omit it for the playing track; with nothing playing the call fails with NO_ACTIVE_ITEM. The playing track keeps its subsong.
OptionalsourceWhere to look: the embedded tags, the sidecar files, or both in that order.
OptionaltypeKeep only synced lyrics (with LRC timestamps) or only unsynced ones.
Parameters for
lyrics.get. Read non-empty lyrics from the five known lyrics tags, then files next to the audio. Automatic lookup tries the audio file's stem only for a verified single-track file, followed by<first artist> - <title>; subsongs use only the latter. Unknown input layouts skip the audio-stem candidate. No numbered or shared album fallback is used. Results are cached for 1200 ms per track, filename and filters. Successful file saves and metadata changes invalidate the cache. Invalid UTF-8 in the returned lyrics is replaced with U+FFFD; no encoding is guessed and the source is not rewritten.