https://github.com/lbryio/lbry-android-sdk
The LBRY SDK packaged as an Android AAR library
https://github.com/lbryio/lbry-android-sdk
Last synced: 5 months ago
JSON representation
The LBRY SDK packaged as an Android AAR library
- Host: GitHub
- URL: https://github.com/lbryio/lbry-android-sdk
- Owner: lbryio
- License: mit
- Created: 2020-02-20T10:57:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T22:26:47.000Z (about 3 years ago)
- Last Synced: 2025-04-28T20:46:19.645Z (8 months ago)
- Language: C
- Size: 175 MB
- Stars: 3
- Watchers: 5
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LBRY Android SDK
[](https://ci.lbry.tech/lbry/lbry-android-sdk/commits/master)
[](https://github.com/lbryio/lbry-android/blob/master/LICENSE)
The LBRY SDK packaged as an Android AAR library which can be used in any Android Studio project.
## Installation
No installation required as this is a dev library.
## Usage
1. Open your project in Android Studio.
1. File > New > New Module...
1. Select Import .JAR / .AAR Package and click Next
1. Select the `lbrysdk--.aar` package from the location you built or downloaded it to where `version` is the sdk version and `` is either `debug` or `release`.
1. Click Finish
1. Add `implementation project(':lbrysdk--')` to the `build.gradle` configuration for the main app module.
### Using the SDK
Add the `FOREGROUND_SERVICE` and `INTERNET` permissions to `AndroidManifest.xml` if they are not yet added.
```
```
Add the `android:usesCleartextTraffic="true"` attribute to the `application` tag in `AndroidManifest.xml`.
Import the required classes to be able to start up the service.
```
import io.lbry.lbrysdk.LbrynetService;
import io.lbry.lbrysdk.ServiceHelper;
```
Add code to launch the service.
```
Context context = getApplicationContext();
ServiceHelper.start(context, "", LbrynetService.class, "lbrynetservice");
```
## Running from Source
The library can be built from source using [Buildozer](https://github.com/lbryio/buildozer). After cloning the repository, copy `buildozer.spec.sample` to `buildozer.spec` and modify this file as necessary for your environment. Please see [BUILD.md](BUILD.md) for detailed build instructions.
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
## Contact
The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.com)