mirror of
https://github.com/Michatec/Radio.git
synced 2026-11-18 23:03:18 +01:00
- Clarify minimum version requirement (v15.2) for Shizuku support. - Expand explanation of benefits regarding battery optimization and background playback reliability.
204 lines
9.1 KiB
Markdown
204 lines
9.1 KiB
Markdown
<p align="center">
|
||
<a href="https://github.com/michatec/Radio/releases"><img src="https://img.shields.io/github/v/release/michatec/Radio?style=flat-square&include_prereleases&label=version" /></a>
|
||
<a href="https://github.com/michatec/Radio/releases"><img src="https://img.shields.io/github/downloads/michatec/Radio/total.svg?style=flat-square" /></a>
|
||
<a href="https://github.com/michatec/Radio/issues"><img src="https://img.shields.io/github/issues-raw/michatec/Radio.svg?style=flat-square&label=issues" /></a>
|
||
<a href="https://github.com/michatec/Radio/graphs/contributors"><img src="https://img.shields.io/github/contributors/michatec/Radio?style=flat-square" /></a>
|
||
</p>
|
||
<div align="center">
|
||
|
||
### ℹ️ About Radio
|
||
**Radio is an application with a minimalist approach to listening to radio over the Internet.** <br>
|
||
**Radio only offers a basic search option, and it imports audio streaming links when you tap them in a web browser.** <br>
|
||
**Radio 15.1+ features support for Android TV and Google Cast, along with a Web Control interface and a developer API.** <br>
|
||
**Pull request are welcome at any time.**<br>
|
||
|
||
**Radio is free software. It is released under the [GPLv3 open source license](https://opensource.org/licenses/GPL-3.0).**
|
||
</div>
|
||
|
||
### Screenshot
|
||
<div style="display: flex; width: 100vw; flex-wrap: wrap; justify-content: space-around;">
|
||
<img src="metadata/en-US/phoneScreenshots/01-radio.png" style="height: 300px; margin: 10px 0px 10px 0px;" />
|
||
<img src="metadata/en-US/phoneScreenshots/02-radio.png" style="height: 300px; margin: 10px 0px 10px 0px;" />
|
||
<img src="metadata/en-US/phoneScreenshots/03-radio.png" style="height: 300px; margin: 10px 0px 10px 0px;" />
|
||
<img src="metadata/en-US/phoneScreenshots/04-radio.png" style="height: 300px; margin: 10px 0px 10px 0px;" />
|
||
</div>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>❗Warning</summary>
|
||
<br>
|
||
<p>
|
||
Google has announced that, starting in 2026/2027, all apps on certified Android devices will require the developer to submit personal identity details directly to Google.
|
||
|
||
Since the developers of this app do not agree to this requirement, this app will no longer work on certified Android devices after that time.
|
||
</p>
|
||
<a href="https://github.com/woheller69/FreeDroidWarn">ℹ️ More Information</a>
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>⚙️ Install Radio</summary>
|
||
<br>
|
||
<a href="https://github.com/michatec/Radio/releases/latest"><img src="https://user-images.githubusercontent.com/15986930/229208526-e5a63be5-0d0b-48ab-a222-9f2f2faf0ee4.png" alt="Preview" height="80px"></a>
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>💡 Frequent Questions</summary>
|
||
<br>
|
||
Q: How can I add a radio station
|
||
A: There are three ways to add a radio station to Radio: Use Search, add playlist file address (M3U, PLS), enter a raw stream address. The last way will not support the update feature.
|
||
|
||
-------------------------------------------------------------------------
|
||
|
||
Q: How does the update feature work?
|
||
A: The update feature will try to fetch the current stream address of a station as well as the updated name and station image. The feature will not work for stations added via a raw stream address, or for stations imported from Radio v3.
|
||
|
||
-------------------------------------------------------------------------
|
||
|
||
Q: Where do the radio station search results come from?
|
||
A: Radio searches the [radio-browser.info](http://www.radio-browser.info/) online database.
|
||
You can help out the radio-browser.info community by [adding the missing station](http://www.radio-browser.info/gui/#!/add) to their database.
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>⚡ Shizuku Integration</summary>
|
||
<br>
|
||
|
||
Starting with **version 15.2**, Radio supports [Shizuku](https://shizuku.rikka.app/), enabling advanced power management adjustments through elevated privileges to improve background playback reliability and reduce interruptions caused by Android's battery optimization mechanisms.
|
||
|
||
**Features:**
|
||
- **Doze whitelist** - Adds the app to the device idle whitelist so playback isn't restricted
|
||
- **AppOps permissions** - Sets `RUN_IN_BACKGROUND` and `RUN_ANY_IN_BACKGROUND` to `allow`
|
||
- **Automatic backup & restore** - Original settings are saved before changes and can be restored at any time
|
||
- **Safe rollback** - If applying optimizations fails, previous settings are automatically restored
|
||
|
||
**Requirements:**
|
||
- [Shizuku](https://shizuku.rikka.app/) must be installed and running on your device
|
||
- Shizuku permission must be granted to Radio
|
||
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>🧩 Developer API (AIDL & Remote Control)</summary>
|
||
<br>
|
||
|
||
Radio provides two APIs for external applications and integrations: a REST-based Remote Control API and an Android AIDL API.
|
||
|
||
### REST API – Remote Control
|
||
|
||
The REST API allows external clients to remotely control playback and retrieve station information over HTTP and WebSockets.
|
||
|
||
**Available features:**
|
||
- Start, pause and resume playback
|
||
- Switch to the next or previous station
|
||
- Play stations by UUID
|
||
- Retrieve playback status and station information
|
||
- Access station images and stream URLs
|
||
- Receive real-time updates via WebSockets
|
||
- Secure client pairing via QR codes
|
||
|
||
For authentication, pairing instructions, endpoint descriptions and usage examples, see [REST_API.md](docs/REST_API.md).
|
||
|
||
### AIDL API – Android IPC
|
||
|
||
Starting with version **15.2**, Radio exposes an AIDL-based API (`com.michatec.radio.api.IRadioApi`) that allows external Android applications to communicate directly with the Radio playback service via IPC.
|
||
|
||
**Service details:**
|
||
- **Package:** `com.michatec.radio`
|
||
- **Service:** `com.michatec.radio.api.RadioApiService`
|
||
- **AIDL Interface:** `com.michatec.radio.api.IRadioApi`
|
||
|
||
**Available features:**
|
||
- Play, pause, stop and check playback state
|
||
- Retrieve the current station name and track metadata
|
||
- Switch stations by UUID using `playStationByUuid()`
|
||
- Retrieve saved and favorite stations as JSON
|
||
|
||
For setup instructions, Kotlin integration examples and the complete method reference, see [AIDL_API.md](docs/AIDL_API.md).
|
||
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>🔊 Supported formats</summary>
|
||
<br>
|
||
|
||
| Supported formats | 🔊 |
|
||
| ------------------ | -- |
|
||
| AAC | ✅ |
|
||
| AAC+ | ✅ |
|
||
| FLAC | ✅ |
|
||
| HLS (M3U8) | ✅ |
|
||
| M3U | ✅ |
|
||
| MP3 | ✅ |
|
||
| OGG (Vorbis) | ✅ |
|
||
| OPUS | ✅ |
|
||
| PLS | ✅ |
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>📺 Android TV Controls</summary>
|
||
<br>
|
||
|
||
When **Edit Stations** is enabled:
|
||
- Press **← (Left)** on the remote to open the detailed station editing area
|
||
|
||
**General TV** Controls:
|
||
- Press **0** or **DEL** to remove the selected radio station
|
||
- Press **1** or **SPACE** to make the selected radio station favourite
|
||
- Press **2** or **PLUS** to reorder the selected radio station
|
||
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
<details>
|
||
<summary>📜️ Credit</summary>
|
||
|
||
- [Radio Browser](http://www.radio-browser.info/) for providing the radio station database
|
||
- [AndroidX Leanback](https://developer.android.com/jetpack/androidx/releases/leanback) for providing the Android TV UI components
|
||
|
||
- Michatec for developing the app and maintaining the project
|
||
- All the contributors who have contributed to the project by submitting pull requests, reporting issues, or providing feedback
|
||
|
||
</details>
|
||
|
||
----------------------------------------
|
||
|
||
## 🧩 Developer Documentation
|
||
|
||
For developers who want to integrate or control Radio using external applications, see the [Developer API Documentation](docs/API_DOC.md).
|
||
|
||
The documentation covers:
|
||
- REST API – Remote Control (HTTP / WebSocket)
|
||
- AIDL API – Android IPC
|
||
|
||
---------------------------------------
|
||
|
||
### ⭐ Star History
|
||
|
||
<a href="https://www.star-history.com/?repos=Michatec%2FRadio&type=date&legend=top-left">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=Michatec/Radio&type=date&theme=dark&legend=top-left&sealed_token=MSdMnFFYG2UBXwIFyGMi6m9fjegL-rbtD2f4q0-901taxfXuwy2vWj3SjtlWAhA8AituZgH6-Rdzoupi7dTI2luAWgc42tVdxuHHDVjgsf55Z_Bpact4Yb33eamF7HFse0QuZvgC4XqTCC2XQkfTgJnmv3l1BbcUyA_4UwppqhEKPX9MNyrcSAhZL4CM" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=Michatec/Radio&type=date&legend=top-left&sealed_token=MSdMnFFYG2UBXwIFyGMi6m9fjegL-rbtD2f4q0-901taxfXuwy2vWj3SjtlWAhA8AituZgH6-Rdzoupi7dTI2luAWgc42tVdxuHHDVjgsf55Z_Bpact4Yb33eamF7HFse0QuZvgC4XqTCC2XQkfTgJnmv3l1BbcUyA_4UwppqhEKPX9MNyrcSAhZL4CM" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=Michatec/Radio&type=date&legend=top-left&sealed_token=MSdMnFFYG2UBXwIFyGMi6m9fjegL-rbtD2f4q0-901taxfXuwy2vWj3SjtlWAhA8AituZgH6-Rdzoupi7dTI2luAWgc42tVdxuHHDVjgsf55Z_Bpact4Yb33eamF7HFse0QuZvgC4XqTCC2XQkfTgJnmv3l1BbcUyA_4UwppqhEKPX9MNyrcSAhZL4CM" />
|
||
</picture>
|
||
</a>
|
||
|
||
<div align="right">
|
||
<table><td>
|
||
<a href="#start-of-content">↥ Scroll to top</a>
|
||
</td></table>
|
||
</div>
|