Skip to main content

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 stores your entire library — songs, albums, artists, playlists, listening history, and app preferences — in a local Room database on your device. Nothing is uploaded to external servers. Because all data lives locally, creating and managing your own backups is the only way to protect your library from device loss, resets, or app reinstallation. The Backup & Restore screen gives you full control over both manual and scheduled automatic backups.

What Gets Backed Up

Every backup file captures the complete state of the VIVI Music Room database, which includes:
  • Local library — all songs, albums, artists, and playlists you have saved or downloaded
  • Playlist contents — every track in every playlist, including custom ordering
  • Listening history — your play-event log used to power Top Songs, statistics, and recommendations
  • Search history — recent local and online search queries
  • App preferences — settings stored via DataStore (audio quality, theme, lyrics providers, and all other preference keys defined in PreferenceKeys.kt)

Manual Backup

To create a backup at any time:
1

Open Settings

Tap the gear icon on the home screen or in the navigation bar to open Settings.
2

Navigate to Backup & Restore

Scroll to the Backup & Restore section and tap it. You will see three primary actions: Auto Backup Settings, Create Backup, and Restore Backup.
3

Tap Create Backup

Tap Create Backup. The system file picker opens and prompts you to choose a save location. The default filename is ViviMusic_<timestamp>.backup (for example, ViviMusic_20250614183045.backup).
4

Choose a destination and save

Select a folder — local storage, an SD card, or a cloud-backed folder — and confirm. VIVI Music exports the database as a binary backup file. The export completes within seconds for most libraries.
Save your backup files to a cloud storage folder (Google Drive, Dropbox, Nextcloud) or copy them to a second device. Because all data is strictly local, a backup stored only on the same device offers no protection if that device is lost or wiped.

Manual Restore

To restore from a previously created backup:
1

Open Settings → Backup & Restore

Navigate to Settings > Backup & Restore.
2

Tap Restore Backup

Tap Restore Backup. The system file picker opens, filtered to application/octet-stream files so only valid VIVI Music backup files are listed.
3

Select your backup file

Browse to the location where you saved your .backup file and select it.
4

Wait for the restore to complete

VIVI Music imports the database. A loading indicator is shown during the process. The app may restart automatically to apply the restored library.
Restoring from a backup completely replaces your current library data. Any songs, playlists, or history added after the backup was created will be permanently lost. If you want to preserve your current state, create a new manual backup before restoring an older one.

Importing Playlists from Other Sources

In addition to the native backup format, the Backup & Restore screen also supports:
  • Import M3U playlist (online) — imports an .m3u file and matches tracks against the YouTube Music catalog, then lets you save them to a playlist.
  • Import from CSV — imports a CSV playlist file using a column-mapping dialog that lets you specify which columns map to song title, artist, and album.
  • Import from Spotify — navigates to the dedicated Spotify import screen to transfer your Spotify playlists into VIVI Music.

Automatic Backups

VIVI Music includes a built-in scheduler for hands-free backups. Access it from Settings > Backup & Restore > Auto Backup Settings. The automatic backup system is controlled by three preference keys:
Preference keyDefaultDescription
AutoBackupEnabledKeytrueMaster toggle — enables or disables all automatic backups
AutoBackupWeeklyKeyfalseWhen enabled alongside the master toggle, schedules a backup every week using Android’s WorkManager
AutoBackupBeforeUpdateKeytrueTriggers an automatic backup immediately before an OTA update is applied

Enabling automatic backups

  1. Open Settings > Backup & Restore > Auto Backup Settings.
  2. Tap the Enable Automatic Backup capsule toggle at the top of the screen to turn it on. The card changes colour to confirm the active state.
  3. Optionally check Weekly Backup to have a fresh backup created every seven days in the background.
  4. Optionally check Backup Before Update to ensure a snapshot is always taken before any OTA update is installed.

Viewing and managing stored backups

The Stored Backups section at the bottom of the Auto Backup Settings screen lists every automatic backup that has been saved to the app’s internal backup directory. Each entry shows the date and time of the backup, the backup type (weekly or pre-update), and the file size.
  • Tap a backup to restore from it. A confirmation dialog appears before any data is changed.
  • Tap the delete icon on a backup entry to permanently remove that backup file after confirming the deletion prompt.
Enable both Weekly Backup and Backup Before Update for the best coverage. The weekly backup keeps a recent copy of your library under normal use, and the pre-update backup ensures you can always roll back if an update introduces a bug.

Build docs developers (and LLMs) love