# videolan/vlc-android architecture

> Architecture diagram of the GitHub repository videolan/vlc-android, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/videolan/vlc-android
- Repository: https://github.com/videolan/vlc-android

## Overview

VLC for Android is a media player and library browser, with phone and TV interfaces. The main user journey is selecting local or network media, browsing or searching the library, and starting playback through the playback service and VLC engine. Other major capabilities include subtitle lookup, casting, metadata scraping, and remote access. The tree and excerpts show key modules, but not every runtime call; README-backed edges document product capabilities, while uncertain wiring is omitted or marked unverified.

Main entry points: [`application/vlc-android/src/org/videolan/vlc/PlaybackService.kt`](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/PlaybackService.kt) (Playback service), [`application/vlc-android/src/org/videolan/vlc/gui/browser`](https://github.com/videolan/vlc-android/tree/master/application/vlc-android/src/org/videolan/vlc/gui/browser) (Media browser), [`medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java`](https://github.com/videolan/vlc-android/blob/master/medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java) (Media library), [`application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt`](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt) (Playlist manager)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_discovery["Media discovery"]
  node_browser["Media browser"]
  node_storage["Storage provider<br/>[StorageProvider.kt]"]
  node_medialibrary[("Media library<br/>[Medialibrary.java]")]
  node_mediaitems["Media items<br/>[MediaWrapper.java]"]
  node_tvsearch["TV search<br/>[SearchFragment.kt]"]
end

subgraph group_playback["Playback"]
  node_playlist["Playlist manager<br/>[PlaylistManager.kt]"]
  node_playbackservice["Playback service<br/>[PlaybackService.kt]"]
  node_video["Video player"]
  node_engine["LibVLC engine"]
  node_options["Engine options<br/>[VLCOptions.kt]"]
end

subgraph group_services["Media services"]
  node_subtitles["Subtitle lookup"]
  node_scraping["Metadata scraping<br/>[MediaScraper.kt]"]
  node_metadata[("Metadata store")]
end

subgraph group_interfaces["User interfaces"]
  node_phoneui["Phone UI"]
  node_tvui["TV UI"]
end

subgraph group_remote["Remote access"]
  node_remoteui["Remote setup UI"]
  node_remoteservice["Remote service"]
  node_remoteserver["Remote server"]
end

node_listener(("VLC user"))
node_remoteclient(("Remote client"))
node_renderer(("Cast renderer"))
node_networkmedia(("Network media"))

node_listener -->|"browses"| node_phoneui
node_listener -->|"browses"| node_tvui
node_phoneui -.->|"opens browser"| node_browser
node_browser -->|"lists storage"| node_storage
node_browser -.->|"browses library"| node_medialibrary
node_tvsearch -->|"searches"| node_medialibrary
node_medialibrary -->|"provides media"| node_mediaitems
node_listener -->|"selects media"| node_networkmedia
node_browser -.->|"queues media"| node_playlist
node_playlist -->|"controls playback"| node_playbackservice
node_playbackservice -->|"plays media"| node_engine
node_playbackservice -->|"reads media"| node_medialibrary
node_options -.->|"configures"| node_engine
node_playbackservice -->|"opens video"| node_video
node_playbackservice -.->|"looks up subtitles"| node_subtitles
node_listener -.->|"requests metadata"| node_scraping
node_scraping -.->|"stores metadata"| node_metadata
node_listener -.->|"enables access"| node_remoteui
node_remoteui -.->|"configures service"| node_remoteservice
node_remoteservice -->|"starts server"| node_remoteserver
node_remoteclient -.->|"connects remotely"| node_remoteserver
node_playbackservice -->|"casts media"| node_renderer
node_networkmedia -->|"provides streams"| node_browser

click node_phoneui "https://github.com/videolan/vlc-android/tree/master/application/vlc-android/src/org/videolan/vlc/gui"
click node_tvui "https://github.com/videolan/vlc-android/tree/master/application/television/src/main/java/org/videolan/television/ui"
click node_browser "https://github.com/videolan/vlc-android/tree/master/application/vlc-android/src/org/videolan/vlc/gui/browser"
click node_storage "https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/providers/StorageProvider.kt"
click node_medialibrary "https://github.com/videolan/vlc-android/blob/master/medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java"
click node_mediaitems "https://github.com/videolan/vlc-android/blob/master/medialibrary/src/org/videolan/medialibrary/interfaces/media/MediaWrapper.java"
click node_tvsearch "https://github.com/videolan/vlc-android/blob/master/application/television/src/main/java/org/videolan/television/ui/SearchFragment.kt"
click node_playlist "https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt"
click node_playbackservice "https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/PlaybackService.kt"
click node_video "https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/gui/video/VideoPlayerActivity.kt"
click node_options "https://github.com/videolan/vlc-android/blob/master/application/resources/src/main/java/org/videolan/resources/VLCOptions.kt"
click node_subtitles "https://github.com/videolan/vlc-android/blob/master/application/resources/src/main/java/org/videolan/resources/opensubtitles/OpenSubtitleService.kt"
click node_scraping "https://github.com/videolan/vlc-android/blob/master/application/moviepedia/src/main/java/org/videolan/moviepedia/MediaScraper.kt"
click node_metadata "https://github.com/videolan/vlc-android/blob/master/application/moviepedia/src/main/java/org/videolan/moviepedia/database/MoviePediaDatabase.kt"
click node_remoteui "https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/gui/remoteaccess/RemoteAccessShareActivity.kt"
click node_remoteservice "https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessService.kt"
click node_remoteserver "https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessServer.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_browser,node_storage,node_medialibrary,node_mediaitems,node_tvsearch,node_listener,node_remoteclient toneBlue
class node_playlist,node_playbackservice,node_video,node_engine,node_options toneAmber
class node_subtitles,node_scraping,node_metadata toneMint
class node_phoneui,node_tvui toneRose
class node_remoteui,node_remoteservice,node_remoteserver,node_renderer,node_networkmedia toneIndigo
```

## Components

### Media discovery

- [Media browser](https://github.com/videolan/vlc-android/tree/master/application/vlc-android/src/org/videolan/vlc/gui/browser): `application/vlc-android/src/org/videolan/vlc/gui/browser`
- [Storage provider](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/providers/StorageProvider.kt): `application/vlc-android/src/org/videolan/vlc/providers/StorageProvider.kt`
- [Media library](https://github.com/videolan/vlc-android/blob/master/medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java): `medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java`
- [Media items](https://github.com/videolan/vlc-android/blob/master/medialibrary/src/org/videolan/medialibrary/interfaces/media/MediaWrapper.java): `medialibrary/src/org/videolan/medialibrary/interfaces/media/MediaWrapper.java`
- [TV search](https://github.com/videolan/vlc-android/blob/master/application/television/src/main/java/org/videolan/television/ui/SearchFragment.kt): `application/television/src/main/java/org/videolan/television/ui/SearchFragment.kt`

### Playback

- [Playlist manager](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt): `application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt`
- [Playback service](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/PlaybackService.kt): `application/vlc-android/src/org/videolan/vlc/PlaybackService.kt`
- [Video player](https://github.com/videolan/vlc-android/blob/master/application/vlc-android/src/org/videolan/vlc/gui/video/VideoPlayerActivity.kt): `application/vlc-android/src/org/videolan/vlc/gui/video/VideoPlayerActivity.kt`
- **LibVLC engine**
- [Engine options](https://github.com/videolan/vlc-android/blob/master/application/resources/src/main/java/org/videolan/resources/VLCOptions.kt): `application/resources/src/main/java/org/videolan/resources/VLCOptions.kt`

### Media services

- [Subtitle lookup](https://github.com/videolan/vlc-android/blob/master/application/resources/src/main/java/org/videolan/resources/opensubtitles/OpenSubtitleService.kt): `application/resources/src/main/java/org/videolan/resources/opensubtitles/OpenSubtitleService.kt`
- [Metadata scraping](https://github.com/videolan/vlc-android/blob/master/application/moviepedia/src/main/java/org/videolan/moviepedia/MediaScraper.kt): `application/moviepedia/src/main/java/org/videolan/moviepedia/MediaScraper.kt`
- [Metadata store](https://github.com/videolan/vlc-android/blob/master/application/moviepedia/src/main/java/org/videolan/moviepedia/database/MoviePediaDatabase.kt): `application/moviepedia/src/main/java/org/videolan/moviepedia/database/MoviePediaDatabase.kt`

### User interfaces

- [Phone UI](https://github.com/videolan/vlc-android/tree/master/application/vlc-android/src/org/videolan/vlc/gui): `application/vlc-android/src/org/videolan/vlc/gui`
- [TV UI](https://github.com/videolan/vlc-android/tree/master/application/television/src/main/java/org/videolan/television/ui): `application/television/src/main/java/org/videolan/television/ui`

### Remote access

- [Remote setup UI](https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/gui/remoteaccess/RemoteAccessShareActivity.kt): `application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/gui/remoteaccess/RemoteAccessShareActivity.kt`
- [Remote service](https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessService.kt): `application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessService.kt`
- [Remote server](https://github.com/videolan/vlc-android/blob/master/application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessServer.kt): `application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessServer.kt`

### Other components

- **VLC user**
- **Remote client**
- **Cast renderer**
- **Network media**

## Connections

- VLC user → Phone UI: browses
- VLC user → TV UI: browses
- Phone UI → Media browser: opens browser (evidence: `application/vlc-android/src/org/videolan/vlc/gui/browser/MLStorageBrowserFragment.kt`)
- Media browser → Storage provider: lists storage (evidence: `application/vlc-android/src/org/videolan/vlc/providers/StorageProvider.kt`)
- Media browser → Media library: browses library (evidence: `application/vlc-android/src/org/videolan/vlc/gui/browser/StorageBrowserFragment.kt`)
- TV search → Media library: searches (evidence: `application/television/src/main/java/org/videolan/television/ui/SearchFragment.kt`)
- Media library → Media items: provides media (evidence: `medialibrary/src/org/videolan/medialibrary/interfaces/Medialibrary.java`)
- VLC user → Network media: selects media
- Media browser → Playlist manager: queues media (evidence: `application/vlc-android/src/org/videolan/vlc/media/PlaylistManager.kt`)
- Playlist manager → Playback service: controls playback (evidence: `application/vlc-android/src/org/videolan/vlc/PlaybackService.kt`)
- Playback service → LibVLC engine: plays media
- Playback service → Media library: reads media (evidence: `application/vlc-android/src/org/videolan/vlc/PlaybackService.kt`)
- Engine options → LibVLC engine: configures
- Playback service → Video player: opens video (evidence: `application/vlc-android/src/org/videolan/vlc/PlaybackService.kt`)
- Playback service → Subtitle lookup: looks up subtitles
- VLC user → Metadata scraping: requests metadata
- Metadata scraping → Metadata store: stores metadata
- VLC user → Remote setup UI: enables access
- Remote setup UI → Remote service: configures service
- Remote service → Remote server: starts server (evidence: `application/remote-access-server/src/main/java/org/videolan/vlc/remoteaccessserver/RemoteAccessService.kt`)
- Remote client → Remote server: connects remotely
- Playback service → Cast renderer: casts media
- Network media → Media browser: provides streams
