Skip to content

Commit 30d4784

Browse files
committed
Document the Android phone and TV clients in the README
1 parent b40ee73 commit 30d4784

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,46 @@ services:
100100
- When you want, you can download the files again to a location on your local computer, selecting the files or folders and clicking the `Download to Local` button.
101101

102102

103+
## Android apps
104+
105+
Both apps are native Kotlin + Jetpack Compose clients built on the server's REST API v1
106+
(`/api/v1`), documented in [`docs/api`](docs/api). Point them at your server address and
107+
API key and they work over the same Telegram session as the web.
108+
109+
### Phone and tablet — [tfm-android-app](https://github.com/mateof/tfm-android-app)
110+
111+
Full file manager on the go:
112+
113+
- Telegram login from the app, by **QR** or phone number (with 2FA).
114+
- **Channels**: saved / all / favourites, search, statistics, create a channel, join by
115+
invitation, leave, and build or refresh a channel index choosing which media types to
116+
scan.
117+
- **File browser** with breadcrumbs, filters, recursive search, multi-select, folder
118+
creation, rename, copy/move, delete, **upload from the device** and download to the
119+
server or to the device.
120+
- **Server local storage**: browse, upload, send to a Telegram channel without
121+
re-uploading the bytes, and clear the streaming cache.
122+
- **Live transfers** over the `/hubs/transfers` SignalR hub: speed, progress and queues,
123+
with global and per-item pause, resume, cancel and retry.
124+
- **Background audio player** (Media3 + MediaSession) with a mini player and server-side
125+
playlists, plus **video streaming** for channel and local files.
126+
- Server settings: simultaneous downloads, parallel chunks, connections per download.
127+
128+
### Android TV and Fire TV — [tfm-android-tv-app](https://github.com/mateof/tfm-android-tv-app)
129+
130+
A D-pad first client focused on watching the videos you keep in your channels:
131+
132+
- Channels split into mine, shared, favourites, Telegram chat folders and all, with a
133+
name search.
134+
- Folder navigation inside a channel, an **all videos** view and a **messages** view,
135+
each sortable by name, date or size.
136+
- Playback with the built-in player (ExoPlayer plus FFmpeg software decoders, so MKV or
137+
AVI with AC3/DTS play fine), VLC, any other installed player or the system default.
138+
- Updates itself from GitHub Releases, and runs on Android 6.0, which covers Fire TV
139+
sticks from 2015 onwards.
140+
141+
Both repositories publish a signed APK as a GitHub Release on every push to `main`.
142+
103143
## Music player
104144

105145
<img width="598" height="889" alt="Music player" src="https://github.com/user-attachments/assets/c4842c34-ea8f-4664-b22c-93b43a9aaf02" />

0 commit comments

Comments
 (0)