Titleformat and ReplayGain reference
Cross-page reference for title formatting and ReplayGain helpers. Primary owners remain:
titleformat.eval
Evaluate one titleformat expression for one file.
Runtime authority: src/api/TitleformatApi.cpp (titleformat.eval).
titleformat.evalBatch
Evaluate the same expression across many files.
Runtime authority: src/api/TitleformatApi.cpp (titleformat.evalBatch).
titleformat.evalFields
Evaluate multiple named fields for one file. Preferred for structured UIs.
Runtime authority: src/api/TitleformatApi.cpp (titleformat.evalFields).
titleformat.evalFieldsBatch
Evaluate multiple named fields across many files. Useful for custom list columns.
Runtime authority: src/api/TitleformatApi.cpp (titleformat.evalFieldsBatch).
titleformat.getBuiltinFields
Returns a convenience map of built-in field expressions.
Typical uses:
- custom list columns (
%play_count%,%rating%,%added%) - conditional display such as
$if(%album%,%album%,Unknown) - optional foo_playcount fields when the component is installed
Runtime authority: src/api/TitleformatApi.cpp (titleformat.getBuiltinFields).
replaygain.get
Read ReplayGain data for one or more paths (trackGain, trackPeak, albumGain, albumPeak, plus per-item status fields from the handler).
Runtime authority: src/api/ReplayGainApi.cpp (replaygain.get).
replaygain.scan
Trigger ReplayGain scanning for the provided paths (via the context-menu workflow exposed by the handler).
Runtime authority: src/api/ReplayGainApi.cpp (replaygain.scan).
replaygain.clear
Clear ReplayGain data for the provided paths.
Runtime authority: src/api/ReplayGainApi.cpp (replaygain.clear).
Related configuration APIs
Mode/preamp helpers live on the Audio owner page:
replaygain.getModereplaygain.setModereplaygain.getPreampreplaygain.setPreampreplaygain.getSettings