Documentation Index
Fetch the complete documentation index at: https://mintlify.com/vivizzz007/vivi-music/llms.txt
Use this file to discover all available pages before exploring further.
VIVI Music’s Content settings shape what you see and hear: the language of YouTube Music’s catalog, which lyrics providers are active and in what priority order, what types of content are filtered out, how the artist page behaves, and how the app connects to the internet. Access these settings from Settings → Content.
Language
Lyrics
Filters
Network
Language & Region
These settings control the language of YouTube Music content returned by the API as well as the language used in the app interface itself.| Preference Key | Type | Default | Description |
|---|
contentLanguage | String | "system" | Sets the language for music catalog content (song titles, album names, artist names) returned by the YouTube Music API. Accepts BCP-47 language codes or "system" to follow the device locale. |
contentCountry | String | "system" | Sets the country for the YouTube Music catalog, determining which tracks, albums, and playlists are available. Accepts ISO 3166-1 alpha-2 codes or "system". |
appLanguage | String | SYSTEM_DEFAULT | Sets the language of the VIVI Music user interface itself. On Android 13 (Tiramisu) and later, this redirects to the system per-app language settings screen. On earlier Android versions, it is handled in-app. |
suggestionRegion | String | "system" | Sets the region used for search suggestion rankings and trending charts. Independent of contentCountry — useful if you want US charts while browsing a local catalog. |
ContentLanguageKey and ContentCountryKey affect what YouTube Music’s API returns. AppLanguageKey only affects text inside VIVI Music’s own UI. You can have the app in English while browsing a Japanese content catalog.
LanguageCodeToName and CountryCodeToName in PreferenceKeys.kt. The SuggestionRegionSlugToName map covers 40 regions for search suggestions, from "system" (device default) to specific markets like India, Japan, and Brazil.Home Screen
| Preference Key | Type | Default | Description |
|---|
randomizeHomeOrder | Boolean | true | Randomizes the order of home screen recommendation sections on each visit so the feed feels fresh. |
discover | String (enum) | QUICK_PICKS | Determines what content appears in the Quick Picks row on the home screen. |
QuickPicksKey accepts values from the QuickPicks enum:| Value | Description |
|---|
QUICK_PICKS | YouTube Music’s curated quick pick recommendations |
LAST_LISTEN | The last song you listened to, for fast resumption |
Top Charts Length
| Preference Key | Type | Default | Description |
|---|
topSize | String | "50" | Number of tracks to show in the Top Charts / My Top lists. Adjustable from 1 to 100 via a slider dialog. |
Lyrics Providers
VIVI Music fetches synchronized lyrics from multiple third-party providers simultaneously and picks the best available result. You can enable or disable each provider individually and drag them into your preferred priority order.Individual Provider Toggles
| Preference Key | Type | Default | Description |
|---|
enableLrclib | Boolean | true | Enables LrcLib — an open, crowd-sourced synchronized lyrics database. |
enableKugou | Boolean | true | Enables Kugou Music’s lyrics API, which has excellent coverage for Chinese and Asian music. |
enableBetterLyrics | Boolean | true | Enables the BetterLyrics service for enhanced synchronized lyrics. |
enableMusixmatch | Boolean | true | Enables Musixmatch — the world’s largest lyrics database, supporting word-level and line-level sync. |
enableSimpMusic | Boolean | true | Enables the SimpMusic lyrics provider. |
enableYouLyPlus | Boolean | true | Enables YouLyPlus — the LyricsPlus multi-server provider using the YouLy+ extension backend. |
enablePaxsenix | Boolean | true | Enables PaxSenix — delivers Apple Music–quality synced lyrics with syllable-level timing. |
Provider Priority Order
| Preference Key | Type | Description |
|---|
lyricsProviderOrder | String (serialized list) | Stores the drag-sorted priority order of enabled lyrics providers. Tap Lyrics Provider Priority in the settings to open a drag-and-drop reorder dialog. |
Priority order matters when multiple providers return results for the same track. VIVI Music uses the first enabled provider in the list that successfully returns synchronized lyrics. Put your preferred provider at the top.
Only enabled providers appear in the priority reorder dialog. Disabled providers are moved to the end of the internal order automatically.
Lyrics Romanization
VIVI Music can romanize (transliterate to Latin script) lyrics in several non-Latin scripts. Navigate to Settings → Content → Lyrics Romanization to configure romanization for Japanese, Korean, Chinese, Russian, Ukrainian, Serbian, Bulgarian, Belarusian, Kyrgyz, Macedonian, Hindi, and Punjabi.Content Filters
These toggles remove specific categories of content from search results, the home feed, and library views.Content Type Filters
| Preference Key | Type | Default | Description |
|---|
hideExplicit | Boolean | false | Hides tracks marked as explicit by YouTube Music from all results and recommendations. |
hideVideoSongs | Boolean | false | Hides songs that are only available as music videos (no standalone audio track) from results. |
hideYoutubeShorts | Boolean | false | Removes YouTube Shorts from search results and the home feed. |
Artist Page Settings
These settings control the information panels and media displayed on an artist’s page.| Preference Key | Type | Default | Description |
|---|
showArtistDescription | Boolean | true | Shows the artist’s biography text at the top of their page. |
showArtistSubscriberCount | Boolean | true | Shows the artist’s YouTube subscriber count on their page. |
showMonthlyListeners | Boolean | true | Shows the artist’s Spotify-style monthly listener count when available. |
showArtistVideo | Boolean | true | Shows the artist’s featured music video on their page. |
showArtistBackgroundVideo | Boolean | true | Plays a looping background video behind the artist header when available. |
Album Canvas
| Preference Key | Type | Default | Description |
|---|
albumCanvasEnabled | Boolean | false | Enables animated Canvas visuals on the album detail page. |
The full-screen player Canvas source and animation settings are configured separately under Settings → Appearance → VIVI Canvas.
Network & Proxy
VIVI Music gives you direct control over the IP version used for all network requests and supports both HTTP and SOCKS5 proxy configurations.IP Version
| Preference Key | Type | Default | Description |
|---|
ipVersion | String (enum) | AUTO | Forces all network requests through a specific IP version. |
IpVersionKey accepts values from the IpVersion enum:| Value | Description |
|---|
AUTO | Let the OS resolve addresses with either IPv4 or IPv6 (default) |
IPV4 | Force all connections to use IPv4 |
IPV6 | Force all connections to use IPv6 |
If you experience connection issues or inconsistent geo-restricted content, try switching from AUTO to IPV4. Some YouTube CDN nodes behave differently across IP versions.
Proxy Configuration
| Preference Key | Type | Default | Description |
|---|
proxyEnabled | Boolean | false | Enables the custom proxy for all VIVI Music network requests. |
proxyType | String | HTTP | Proxy protocol. Options: HTTP or SOCKS (SOCKS5). |
proxyUrl | String | "host:port" | The proxy server address and port in host:port format. |
proxyUsername | String | "" | Optional username for proxy authentication. Leave blank if the proxy requires no authentication. |
proxyPassword | String | "" | Optional password for proxy authentication. |
Enable the proxy
Toggle Enable Proxy on. A Configure Proxy item will appear below.
Open the proxy configuration dialog
Tap Configure Proxy to open the configuration dialog where you can set the type, URL, and optional credentials.
Select the proxy type
Choose HTTP for standard HTTP/HTTPS proxies or SOCKS for SOCKS5 proxies.
Enter the host and port
Type the address in host:port format, for example proxy.example.com:8080.
Add authentication if required
Toggle Enable Authentication and enter your username and password. Tap Save to apply.
YTM Library Sync
| Preference Key | Type | Default | Description |
|---|
ytmSync | Boolean | — | Enables synchronization of your YouTube Music library (likes, playlists) to VIVI Music’s local database. |
selectedYtmPlaylists | String | — | Stores the comma-separated list of YouTube Music playlist IDs selected for sync. |