The LBRY SDK packaged as an Android AAR library

Find a file

zeppi b0e8785c75 add libtorrent		2022-12-05 09:37:38 -05:00
.github	filetype recipe	2022-12-02 15:05:00 -05:00
docker	update Python 3.9 Dockerfile	2021-08-21 20:37:34 +01:00
p4a	Python 3.9.6 (#11 )	2021-08-21 10:30:12 +01:00
recipes	filetype recipe	2022-12-02 15:05:00 -05:00
scripts	experiment with Python optimisations	2021-08-22 10:24:14 +01:00
src/main	update to sdk 112	2022-11-23 12:06:06 -05:00
.dockerignore	DOCKER-DEV: Local development in a docker container (#595 )	2019-07-11 02:30:41 +01:00
.gitignore	filetype recipe	2022-12-02 15:05:00 -05:00
.gitlab-ci.yml	openssl==1.1.1k, sqlite3==3.36.0	2021-08-22 07:45:58 +01:00
.gitmodules	remove submodule definition	2020-02-20 12:13:37 +01:00
build-debug.sh	Maven Central publishing - set POM properties (#10 )	2021-06-25 16:01:40 +01:00
build-release.sh	use /bin/bash for debug and release build scripts	2020-02-20 13:38:06 +01:00
BUILD.md	new build system, 111	2022-11-23 09:45:06 -05:00
buildozer.spec.arm.ci	update to sdk 112	2022-11-23 12:06:06 -05:00
buildozer.spec.arm64.ci	add libtorrent	2022-12-05 09:37:38 -05:00
buildozer.spec.sample	update to sdk 112	2022-11-23 12:06:06 -05:00
buildozer.spec.vagrant	update to sdk 112	2022-11-23 12:06:06 -05:00
DOCKER-DEV.md	DOCKER-DEV: Add arm64 glibc headers from #606	2019-07-15 17:36:31 -04:00
DOCKER.md	React Native codebase as a submodule (#604 )	2019-07-09 05:34:46 +01:00
Dockerfile	build lbry sdk as an Android aar library	2020-02-20 12:09:29 +01:00
LICENSE	Update LICENSE	2020-02-03 04:38:17 +07:00
QUICKSTART.md	Update QUICKSTART.md	2019-10-28 10:27:48 -04:00
README.md	one more readme update	2020-02-20 12:38:38 +01:00
signing.pgp	Publish to Maven Central (#9 )	2021-06-25 00:31:23 +01:00
signing2.pgp	new build system, 111	2022-11-23 09:45:06 -05:00
Vagrantfile	add / update recipes and build changes for Python 3.6.6 compatibility (#315 )	2018-10-07 15:59:03 +01:00

README.md

LBRY Android SDK

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

Open your project in Android Studio.
File > New > New Module...
Select Import .JAR / .AAR Package and click Next
Select the lbrysdk-<version>-<debug|release>.aar package from the location you built or downloaded it to where version is the sdk version and <debug|release> is either debug or release.
Click Finish
Add implementation project(':lbrysdk-<version>-<debug|release>') 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.

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.INTERNET" />

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. After cloning the repository, copy buildozer.spec.sample to buildozer.spec and modify this file as necessary for your environment. Please see 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.

Security

We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it.

Contact

The primary contact for this project is @akinwale (akinwale@lbry.com)