# Accompanist

## Docs

- [Color and Brush Utilities | Accompanist Lyrics UI API](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/color-brush-utils.md): API reference for Color.copyHsl() and Brush.easedHorizontalGradient(): HSL color channel overriding and eased gradient creation in Accompanist Lyrics UI.
- [Custom Easing Functions | Accompanist Lyrics UI API](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/easing-functions.md): API reference for DipAndRise, Swell, Bounce, EasingOutCubic, and NewtonPolynomialInterpolationEasing — custom easing classes for Lyrics UI animations.
- [KaraokeBreathingDots: Animated Dots Composable API Reference](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/karaoke-breathing-dots.md): API reference for KaraokeBreathingDots — animated pulsing dots for instrumental intros and interludes, with configurable timing and appearance.
- [KaraokeLineText: Karaoke Line Composable API Reference](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/karaoke-line-text.md): API reference for KaraokeLineText — renders a karaoke line with syllable fill animation, character bounce effects, translation, and phonetic annotations.
- [KaraokeLyricsView: Karaoke Lyrics Composable API Reference](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/karaoke-lyrics-view.md): Full parameter reference for KaraokeLyricsView, the main composable for scrolling karaoke and synced lyrics with syllable animations and auto-scroll.
- [Lyrics Layout Calculator | Accompanist Lyrics UI API](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/lyrics-layout-calculator.md): API reference for measureSyllablesAndDetermineAnimation, calculateBalancedLines, calculateStaticLineLayout, calculateRowRenderData, and groupIntoWords.
- [LyricsLineItem: Line Wrapper Composable API Reference](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/lyrics-line-item.md): API reference for LyricsLineItem — a wrapper composable that applies focus-based alpha, scale, blur, and blend mode to lyric line content.
- [springPlacement Modifier | Accompanist Lyrics UI API](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/spring-placement-modifier.md): API reference for springPlacement Modifier: spring-physics placement animation using LookaheadScope, DeferredTargetAnimation, and configurable stiffness.
- [SyllableLayout Data Class | Accompanist Lyrics UI API](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/syllable-layout.md): API reference for SyllableLayout and WordAnimationInfo data classes — all fields, default values, and per-syllable animation metadata for Lyrics UI.
- [SyncedLineText: Synced Line Composable API Reference](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/synced-line-text.md): API reference for SyncedLineText — renders a single time-synced (non-karaoke) lyric line with optional translation and automatic RTL detection.
- [WrappedLine & RowRenderData | Accompanist Lyrics UI](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/api/wrapped-line.md): API reference for WrappedLine and RowRenderData — the intermediate and final layout data structures from the Accompanist Lyrics UI calculator pipeline.
- [Accompanist Lyrics UI Animation System: Three Layers](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/concepts/animations.md): Explore how Accompanist Lyrics UI animates lyrics with karaoke fill gradients, per-character bounce effects, and spring-physics list placement.
- [Supported Lyric File Formats in Accompanist: TTML, LRC, LYS](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/concepts/lyric-formats.md): Accompanist Lyrics UI accepts Apple Music TTML, LRC, and the native LYS format via the lyrics-core library, enabling full karaoke rendering.
- [Accompanist Lyrics Data Model: Lines and Syllables](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/concepts/lyrics-model.md): Learn how SyncedLyrics, KaraokeLine, SyncedLine, and KaraokeSyllable form the data model that drives Accompanist Lyrics UI rendering.
- [Rendering Karaoke Lyrics with KaraokeLyricsView](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/guides/karaoke-lyrics.md): Set up KaraokeLyricsView to render syllable-level animated karaoke lyrics, configure auto-scrolling, and handle user interactions like seek and share.
- [Displaying Multi-Voice and Duet Lyrics](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/guides/multivoice-duet.md): Learn how Accompanist Lyrics UI renders duet and multi-voice lyrics using KaraokeLine.AccompanimentKaraokeLine with separate alignment and animated visibility.
- [Rendering Synced (Non-Karaoke) Lyrics](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/guides/synced-lyrics.md): Use KaraokeLyricsView with SyncedLine data to display line-synced lyrics from LRC files without syllable-level animation.
- [Theming and Styling Accompanist Lyrics UI](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/guides/theming-styling.md): Customize text styles, colors, blend modes, blur effects, and breathing dot appearance in Accompanist Lyrics UI to match your app's design.
- [Showing Translations and Phonetic Text](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/guides/translations-phonetics.md): Add translations and phonetic ruby text (e.g., pinyin or romaji) to karaoke and synced lyrics lines in Accompanist Lyrics UI.
- [Install Accompanist Lyrics UI in Your Android Project](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/installation.md): Add Accompanist Lyrics UI to your Android or Compose Multiplatform project. Covers Gradle setup, version catalog, and minimum SDK requirements.
- [Accompanist Lyrics UI — Karaoke Lyrics for Compose](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/introduction.md): Compose Multiplatform library for Apple Music-style karaoke lyrics with syllable animations, multi-voice support, and breathing dot interludes.
- [Quickstart: Karaoke Lyrics in Compose Multiplatform](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/quickstart.md): Learn how to add karaoke lyrics rendering to your Compose Multiplatform app in four steps, from dependency setup to your first animated lyrics view.
- [Accompanist Sample App Overview](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/sample/overview.md): Explore the Accompanist sample app — a full-featured music player demonstrating karaoke lyrics, flowing light backgrounds, share sheets, and adaptive layouts.
- [Player Screen Implementation Guide](https://mintlify.wiki/6xingyv/accompanist-lyrics-ui/sample/player-screen.md): Deep-dive into the sample app's PlayerScreen: the frame-loop position provider, adaptive layouts, glow blend mode setup, and lyric share sheet integration.