# Accompanist

## Docs

- [Attributes and Artist: song metadata from LRC files](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/attributes.md): Attributes holds parsed LRC metadata: title, artist, album, timing offset, and duration. Artist represents a single credited artist with a type and name.
- [ILyricsExporter: implement a custom lyrics exporter](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/ilyrics-exporter.md): ILyricsExporter defines a single export() method for converting a SyncedLyrics object to a string representation of any target format.
- [ILyricsParser: interface for custom lyrics parsers](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/ilyrics-parser.md): ILyricsParser is the interface every lyrics parser implements. Provide canParse() and one parse() overload to support any custom or built-in lyrics format.
- [KaraokeLine: sealed interface for karaoke lyrics lines](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/karaoke-line.md): KaraokeLine is a sealed interface for syllable-level lyrics. Its two subtypes are MainKaraokeLine for lead vocals and AccompanimentKaraokeLine for backing.
- [KaraokeSyllable: per-syllable timing and phonetic data](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/karaoke-syllable.md): KaraokeSyllable holds the text content, start/end timestamps, and optional phonetic annotation for a single syllable within a KaraokeLine.
- [PhoneticProvider: romanization interface for parsers](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/phonetic-provider.md): PhoneticProvider supplies romanization at line or syllable level. TTMLParser calls it as a fallback when a TTML file has no existing phonetic annotations.
- [SyncedLine and ISyncedLine: line-level lyrics types](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/synced-line.md): SyncedLine represents a single lyrics line with start/end timestamps and optional translation. ISyncedLine is the common interface for all line types.
- [SyncedLyrics: the root data model for parsed lyrics](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/api/synced-lyrics.md): SyncedLyrics is the root model returned by all parsers. It holds lyrics lines, song metadata, and binary-search helpers for current-line lookup.
- [EnhancedLrcExporter: syllable-level LRC export](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/exporters/enhanced-lrc-exporter.md): EnhancedLrcExporter converts SyncedLyrics to Enhanced LRC format, preserving syllable timing, background vocal lines, and translation lines.
- [LrcExporter: convert SyncedLyrics to standard LRC](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/exporters/lrc-exporter.md): LrcExporter converts a SyncedLyrics object to standard LRC format with line-level timestamps, ID3 tags, and optional translation lines.
- [Export lyrics to LRC, Enhanced LRC, and TTML formats](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/exporters/overview.md): Accompanist Lyrics Core includes three exporters for converting SyncedLyrics to standard LRC, Enhanced LRC with syllable timing, or Apple Music TTML XML.
- [TTMLExporter: convert lyrics to Apple Music TTML XML](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/exporters/ttml-exporter.md): TTMLExporter converts a SyncedLyrics object to Apple Music TTML XML with syllable spans, multi-agent voice support, and translation metadata.
- [Write a custom lyrics parser and register it with AutoParser](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/guides/custom-parser.md): Implement ILyricsParser to support any custom lyrics format, then register it with AutoParser for automatic detection alongside built-in parsers.
- [Add phonetic romanization to lyrics with PhoneticProvider](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/guides/phonetic-provider.md): Implement PhoneticProvider to supply romanization or pronunciation annotations for lyrics, then wire it into TTMLParser or AutoParser as a fallback.
- [Integrate lyrics with real-time playback highlighting](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/guides/playback-integration.md): Use SyncedLyrics timing methods and KaraokeLine progress helpers to synchronize lyrics highlighting with audio playback position in your player UI.
- [Install Accompanist Lyrics Core in your Kotlin project](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/installation.md): Add Accompanist Lyrics Core to a Kotlin Multiplatform or JVM project via Gradle. Covers version catalogs, platform targets, and repository setup.
- [Accompanist Lyrics Core: Kotlin lyrics parsing library](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/introduction.md): Accompanist Lyrics Core parses LRC, Enhanced LRC, TTML, Lyricify Syllable, and Kugou KRC into a unified Kotlin data model with syllable-level timing.
- [AutoParser: Automatic Lyrics Format Detection in Kotlin](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/auto-parser.md): AutoParser detects and delegates to the correct lyrics parser automatically. Configure parser order, add custom parsers, and integrate phonetic providers.
- [Parse Enhanced LRC files with syllable-level timing](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/enhanced-lrc.md): EnhancedLrcParser handles Enhanced LRC with syllable timing using angle brackets, voice tags v1/v2, and background vocal lines for karaoke applications.
- [Parsing Kugou KRC Lyrics Files with KugouKrcParser](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/kugou-krc.md): KugouKrcParser handles Kugou Music KRC format with line and word-level timestamps, embedded phonetics, translations, and colon-delimited role markers.
- [Parse standard LRC lyrics files with EnhancedLrcParser](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/lrc.md): EnhancedLrcParser handles standard LRC files with line-level timestamps and ID3 metadata tags like [ti:], [ar:], and [al:] for title, artist, and album.
- [Parse Lyricify Syllable Format Lyrics with Kotlin SDK](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/lyricify-syllable.md): LyricifySyllableParser handles the Lyricify Syllable format with (startMs,durationMs) notation and attribute codes for alignment and vocal type.
- [Lyrics Parsers Overview in Accompanist Lyrics Core](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/overview.md): Overview of all lyrics parsers in Accompanist Lyrics Core: AutoParser, EnhancedLrcParser, TTMLParser, LyricifySyllableParser, and KugouKrcParser.
- [Parse Apple Music TTML Lyrics Files with TTMLParser](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/parsers/ttml.md): TTMLParser parses Apple Music TTML lyrics with syllable timing, transliterations, translations, background vocals, and multi-agent voice alignment.
- [Quickstart: Parse lyrics with Accompanist Lyrics Core](https://mintlify.wiki/6xingyv/accompanist-lyrics-core/quickstart.md): Parse your first lyrics file with Accompanist Lyrics Core using AutoParser, then access syllable timing, translations, and export to LRC.