Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roc-streaming/roc-droid
Roc for Android!
https://github.com/roc-streaming/roc-droid
android audio hacktoberfest networking real-time streaming
Last synced: 3 months ago
JSON representation
Roc for Android!
- Host: GitHub
- URL: https://github.com/roc-streaming/roc-droid
- Owner: roc-streaming
- License: mpl-2.0
- Created: 2020-05-31T10:07:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-04T07:22:30.000Z (about 1 year ago)
- Last Synced: 2024-04-13T20:05:18.304Z (7 months ago)
- Topics: android, audio, hacktoberfest, networking, real-time, streaming
- Language: Kotlin
- Homepage: https://roc-streaming.org
- Size: 4.76 MB
- Stars: 52
- Watchers: 9
- Forks: 18
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Roc for Android!
[](https://github.com/roc-streaming/roc-droid/actions/workflows/build.yaml) [](https://github.com/roc-streaming/roc-droid/releases) [](https://app.element.io/#/room/#roc-streaming:matrix.org)
Android app implementing Roc sender and receiver. **Work in progress!**
Features:
* **receive** sound from remote Roc-compatible sender and **play** to local audio device
* **capture** sound from apps or microphone and **send** to remote Roc-compatible receiver
Download
--------
* Download APK from [latest release](https://github.com/roc-streaming/roc-droid/releases/latest)
* Download from F-Droid or IzzyOnDroid:
[
](https://f-droid.org/packages/org.rocstreaming.rocdroid/)
[
](https://apt.izzysoft.de/fdroid/index/apk/org.rocstreaming.rocdroid)
Screenshot
----------
Features
--------
Key features of [Roc Toolkit](https://github.com/roc-streaming/roc-toolkit) streaming engine, used by Roc Droid:
* real-time streaming with guaranteed latency;
* robust work on unreliable networks like Wi-Fi, due to use of Forward Erasure Correction codes;
* CD-quality audio;
* multiple profiles for different CPU and latency requirements;
* relying on open, standard protocols, like RTP and FECFRAME;
* interoperability with both Roc and third-party software.
Compatible senders and receivers include:
* [cross-platform command-line tools](https://roc-streaming.org/toolkit/docs/tools/command_line_tools.html)
* [modules for sound servers](https://roc-streaming.org/toolkit/docs/tools/sound_server_modules.html) (PulseAudio, PipeWire, macOS CoreAudio)
* [C library](https://roc-streaming.org/toolkit/docs/api.html) and [bindings for other languages](https://roc-streaming.org/toolkit/docs/api/bindings.html)
## Donations
If you would like to support the project financially, please refer to [this page](https://roc-streaming.org/toolkit/docs/about_project/sponsors.html). This project is developed by volunteers in their free time, and your donations will help to spend more time on the project and keep it growing.
Thank you!
Building
--------
The app uses [Java bindings for Roc Toolkit](https://github.com/roc-streaming/roc-java). You don't need to install them manually; gradle will automatically download AAR from maven central, which contains both libroc and Java bindings built for all Android ABIs.
The easiest way to build the app is using Android Studio.
Alternatively, you can build and deploy APK from command-line.
Build:
```
./gradlew build
```
Install to device:
```
adb install app/build/outputs/apk/debug/roc-droid-*.apk
```
Development
-----------
To check code style use:
```
./gradlew spotlessCheck
```
To apply code style use:
```
./gradlew spotlessApply
```
To check consistency of version name and code:
```
./gradlew checkVersion
```
Signing
-------
Keystore with certificates was generated using this command:
```
keytool -genkey -v -keystore roc-droid.jks -alias apk -keyalg RSA -keysize 2048 -validity 10000
```
Then it was encoded to base64:
```
base64 roc-droid.jks
```
Then the following secrets were added to the repo:
* `SIGNING_STORE_BASE64` - base64-encoded keystore (`roc-droid.jks`)
* `SIGNING_STORE_PASSWORD` - keystore password
* `SIGNING_KEY_ALIAS` - key alias (`apk`)
* `SIGNING_KEY_PASSWORD` - key password (same as keystore password)
GitHub actions decode `SIGNING_STORE_BASE64` into a temporary `.jks` file and set `SIGNING_*` environment variables with the name of the file and credentials.
Then the following command is run:
```
./gradlew assembleRelease
```
It reads credentials from the environment variables and signs release APK using them.
Release
-------
To release a new version:
* Create git tag
```
./tag.py --push
```
e.g.
```
./tag.py --push origin 1.2.3
```
Or use **tag.py** without **--push** to only create a tag locally, and then push it manually.
* Wait until "Release" CI job completes and creates GitHub release draft.
* Edit GitHub release created by CI and publish it.
Authors
-------
See [here](https://github.com/roc-streaming/roc-droid/graphs/contributors).
License
-------
[MPL-2.0](LICENSE)