Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/calmerism/Tamed/llms.txt

Use this file to discover all available pages before exploring further.

Tamed fetches synchronized and unsynchronized lyrics from up to ten different sources simultaneously and merges results based on a configurable priority order. Each provider can be toggled individually, the fallback chain is drag-to-reorder, and a queue pre-loader warms up lyrics for upcoming tracks. This page documents every preference key involved in lyrics configuration.

​
Provider Overview

Tamed queries lyrics providers in a ranked order stored in LyricsProviderOrderKey. When the first provider returns a result, the remaining providers are skipped. If a provider returns no result or fails, the next one in the list is tried. The default order is defined in DefaultLyricsProviderOrder: 
listOf(
    PreferredLyricsProvider.BETTER_LYRICS,
    PreferredLyricsProvider.LRCLIB,
    PreferredLyricsProvider.KUGOU,
    PreferredLyricsProvider.SIMPMUSIC,
    PreferredLyricsProvider.UNISON,
    PreferredLyricsProvider.PAXSENIX_APPLE_MUSIC,
    PreferredLyricsProvider.PAXSENIX_NETEASE,
    PreferredLyricsProvider.PAXSENIX_SPOTIFY,
    PreferredLyricsProvider.PAXSENIX_MUSIXMATCH,
    PreferredLyricsProvider.PAXSENIX_YOUTUBE,
)
The provider order is persisted as a comma-separated string of enum names (e.g. "BETTER_LYRICS,LRCLIB,KUGOU,..."). The deserializeLyricsProviderOrder() function parses this string and fills in any missing providers from the default list so the chain is always complete.

​
Provider Keys

​
Priority Order

Preference KeyDataStore KeyTypeDefault
LyricsProviderOrderKeylyricsProviderOrderString (CSV of enum names)"" (uses DefaultLyricsProviderOrder)
PreferredLyricsProviderKeylyricsProviderString (PreferredLyricsProvider enum)LRCLIB
LyricsProviderOrderKey stores the full drag-sorted list. PreferredLyricsProviderKey is a legacy single-provider preference; the order list takes precedence.

​
Individual Provider Toggles

Each provider can be disabled independently. Disabled providers are skipped even if they appear early in the priority order.
Preference KeyDataStore KeyProviderNotes
EnableBetterLyricsKeyenableBetterLyricsBetterLyricsDefault first in chain
EnableLrcLibKeyenableLrclibLrcLibOpen-source community lyrics database
EnableKugouKeyenableKugouKuGouLarge Chinese lyrics catalogue
EnableSimpMusicLyricsKeyenableSimpMusicLyricsSimpMusic—
EnableUnisonLyricsKeyenableUnisonLyricsUnison—
EnablePaxsenixAppleMusicLyricsKeyenablePaxsenixAppleMusicLyricsPaxsenix (Apple Music)Requires Paxsenix parent toggle
EnablePaxsenixNeteaseLyricsKeyenablePaxsenixNeteaseLyricsPaxsenix (Netease)Requires Paxsenix parent toggle
EnablePaxsenixSpotifyLyricsKeyenablePaxsenixSpotifyLyricsPaxsenix (Spotify)Requires Paxsenix parent toggle
EnablePaxsenixMusixmatchLyricsKeyenablePaxsenixMusixmatchLyricsPaxsenix (Musixmatch)Requires Paxsenix parent toggle
EnablePaxsenixYouTubeLyricsKeyenablePaxsenixYouTubeLyricsPaxsenix (YouTube)Requires Paxsenix parent toggle
The five Paxsenix sub-providers (Apple Music, Netease, Spotify, Musixmatch, YouTube) are only queried when the parent EnablePaxsenixLyricsKey (enablePaxsenixLyrics) is enabled. You can view live Paxsenix server health statistics from within the app’s Lyrics settings screen.

​
Queue Pre-Loading

Preference KeyDataStore KeyTypeDefaultDescription
PreloadQueueLyricsEnabledKeypreload_queue_lyrics_enabledBooleantrueFetches lyrics for upcoming tracks in the queue before they start playing, eliminating loading spinners.
QueueLyricsPreloadCountKeyqueue_lyrics_preload_countInt (0–10)1How many tracks ahead to pre-load. 0 effectively disables pre-loading even if the toggle is on.

​
Display Mode

Preference KeyDataStore KeyTypeDefaultDescription
ShowLyricsKeyshowLyricsBooleanfalseControls whether lyrics are displayed in the player view.
UseLyricsV2KeyuseLyricsV2BooleanfalseEnables the V2 lyrics rendering engine. When false, the standard lyrics engine is used regardless of LyricsModeKey.
Preference KeyDataStore KeyTypeDefaultDescription
LyricsModeKeylyricsModeString (LyricsMode enum)ENHANCEDSelects the rendering engine for synchronized lyrics. Applies when UseLyricsV2Key is true.
LyricsMode values
ValueDescription
V2Custom Tamed lyrics renderer with bounce, glow, fill-transition animations, and karaoke highlighting
ENHANCEDEnhanced synchronized lyrics mode with standard scrolling
Animation settings are only available when LyricsModeKey is V2.
Preference KeyDataStore KeyTypeDefaultDescription
LyricsAnimationStyleKeylyricsAnimationStyleString (LyricsAnimationStyle enum)APPLEControls how the active lyrics line is highlighted.
LyricsAnimationStyle values
ValueDescription
NONENo animation — active line changes instantly
FADEActive line fades in
GLOWActive line emits a glow halo
SLIDEActive line slides into position
KARAOKEWord-by-word karaoke fill animation
APPLEApple Music–style fluid character fill (default)
Preference KeyDataStore KeyTypeDescription
LyricsV2BounceFactorKeylyricsV2BounceFactorFloatControls the spring-bounce amplitude of the active line transition.
LyricsV2GlowFactorKeylyricsV2GlowFactorFloatIntensity of the glow halo applied to the active line.
LyricsV2FillTransitionWidthKeylyricsV2FillTransitionWidthFloatWidth of the fill-progress gradient edge in karaoke/Apple animations.
LyricsV2LrcBounceEnabledKeylyricsV2LrcBounceEnabledBooleanEnables the bounce spring effect when LRC timestamp-synced lines advance.
LyricsLineBlurKeylyricsLineBlurBooleanApplies a soft blur to inactive lyrics lines to draw focus to the active line.

​
Display Settings

Preference KeyDataStore KeyTypeDefaultRangeDescription
LyricsTextSizeKeylyricsTextSizeFloat (sp)2616–36Font size of lyrics text.
LyricsLineSpacingKeylyricsLineSpacingFloat (multiplier)1.31.0–2.0Line-height multiplier between lyrics lines.
LyricsTextPositionKeylyricsTextPositionString (LyricsPosition enum)LEFT—Horizontal alignment of lyrics text: LEFT, CENTER, or RIGHT.
Preference KeyDataStore KeyTypeDefaultDescription
LyricsClickKeylyricsClickBooleantrueTapping a lyrics line seeks playback to that timestamp.
LyricsScrollKeylyricsScrollKeyBooleantrueAutomatically scrolls the lyrics view to keep the active line centered during playback.

​
Romanization

Tamed can automatically romanize (transliterate to Latin script) lyrics in several languages using the keys below. All default to true.
Preference KeyDataStore KeyLanguage
LyricsRomanizeJapaneseKeylyricsRomanizeJapaneseJapanese (Hiragana/Katakana/Kanji → Rōmaji)
LyricsRomanizeKoreanKeylyricsRomanizeKoreanKorean (Hangul → Revised Romanization)
LyricsRomanizeChineseKeylyricsRomanizeChineseChinese (Hanzi → Pinyin)
LyricsRomanizeHindiKeylyricsRomanizeHindiHindi (Devanagari → Latin)
LyricsRomanizeOtherLanguagesKeylyricsRomanizeOtherLanguagesAll other non-Latin scripts

​
Translation

Preference KeyDataStore KeyTypeDefaultDescription
TranslateLyricsKeytranslateLyricsBoolean—Displays a translated version of lyrics beneath each line.
EnableTranslatorKeyenableTranslatorBoolean—Master switch for the translation engine.
TranslatorTargetLangKeytranslatorTargetLangString (BCP-47 code)—Language code of the translation target (e.g. en, ja, ko).
TranslatorContextsKeytranslatorContextsString—Additional context hints passed to the translation engine to improve accuracy.

​
Supported Translation Target Languages

The following BCP-47 locale codes are accepted by TranslatorTargetLangKey, drawn from the app’s LanguageCodeToName map:
CodeLanguage
enEnglish (US)
en-GBEnglish (UK)
ja日本語
ko한국어
viTiếng Việt
zh中文
zh-CN简体中文
zh-TW繁體中文
frFrançais
deDeutsch
esEspañol
ptPortuguês
pt-BRPortuguês (Brasil)
ruРусский
itItaliano
nlNederlands
plPolski
trTürkçe
arالعربية
hiहिन्दी
thไทย
idBahasa Indonesia
msBahasa Melayu
ukУкраїнська
csČeština
elΕλληνικά
heעברית
huMagyar
roRomână
fiSuomi
daDansk
noNorsk
svSvenska
skSlovenčina
bgБългарски
hrHrvatski
srСрpsки
ltLietuvių
lvLatviešu
etEesti

Build docs developers (and LLMs) love

Get started for freeTalk to us