Skip to main content

Android SDK

Learn how to implement the Eyeson features in a native Android app.

info

The Eyeson Android SDK acts as communication client for an existing meeting room.

Prerequisites​

warning

To get Eyeson running on Android you will need to have a valid meeting accessKey or guestToken from a running room instance.

The respective credentials can be obtained from the API with a valid API key. Thus, an additional backend webservice to host and maintain Eyeson meetings is mandatory from your side. See API documentation for more information.

Examples​

You will find an Compose example app in the git repository. A very basic View example is also included.

Add Eyeson to your project​

In order to use the SDk complete the following steps.

Dependencies​

Add JitPack to your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Add the dependency to your app-level build.gradle. Latest version

dependencies {
    implementation 'com.github.eyeson-team:android-sdk:VERSION'
}

Permissions​

The Eyeson Android SDK uses the following permissions:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

Add them to your manifest and make sure that you have requested the CAMERA and RECORD_AUDIO runtime permission before joining a meeting. See the Android documentation on how to request them.