Ouisync library Kotlin bindings

⚠️ FIXME: this README is outdated ⚠️

This project provides kotlin bindings for the ouisync library in the form of self-contained AAR package to be used in android apps.

Usage

Include ouisync with Gradle by adding the following to your build.gradle file:

implementation 'ie.equalit.ouinet:ouisync-omni:$ouisyncVersion'

Documentation

API documentation is available at https://docs.ouisync.net/kotlin/.

Example app

There is a simple example app in the example folder. To build it run gradle example:assembleDebug, then find the apk in build/example/outputs/apk/debug/example-debug.apk, install and run it on a device or an emulator.

Build from source

Prerequisities

The Ousiync native library is built automatically but it requires a rust toolchain. The easiest way to get it is using rustup.

Build the AAR

Run gradle lib:assembleRelease (or lib:assembleDebug for the debug variant), then find the aar in build/lib/outputs/aar/lib-release.aar (or lib-debug.aar).

Run unit tests

Run gradle lib:test (To run a specific test, see test filtering).

Build the API documentation

Generate the documentation with dokka: gradle lib:dokkaHtml (or use any of the supported formats) then find it in build/lib/dokka.