Setup and Basic Usage

This is legacy documentation. We are no longer onboarding new Gruveo for Developers customers.

This page explains how you can get up and running quickly with the Gruveo SDK for Android.

Requirements

At least Android 4.2.x (API 17) is required.

The SDK manifest file contains the features and permissions below. You do not have to add them in your project.

The Manifest.permission.RECORD_AUDIO permission is mandatory for making calls, Manifest.permission.CAMERA is needed only for video calls. However, it is all handled by the SDK, so you do not have to worry about these details.

<uses-feature
    android:name="android.hardware.camera"
    android:required="false"/>
<uses-feature
    android:name="android.hardware.camera.autofocus"
    android:required="false"/>
<uses-feature
    android:glEsVersion="0x00020000"
    android:required="true"/>

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

<uses-feature

android:name="android.hardware.camera"

android:required="false"/>

<uses-feature

android:name="android.hardware.camera.autofocus"

android:required="false"/>

<uses-feature

android:glEsVersion="0x00020000"

android:required="true"/>

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

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

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

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

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

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

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

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

The SDK is minified with self-contained ProGuard rules, so you do not have to add any either.

Setup

Include JitPack by adding the following in your project's build.gradle:

allprojects {
    repositories {
        jcenter()
        maven { url "https://jitpack.io" }
    }
}

allprojects {

repositories {

jcenter()

maven { url "https://jitpack.io" }

}

Add Gruveo SDK in your module's build.gradle dependencies:

compile 'org.bitbucket.gruveo:gruveo-sdk-android:{latest version}'

1	compile 'org.bitbucket.gruveo:gruveo-sdk-android:{latest version}'

Add the following activity in your manifest file:

<activity
    android:name="com.gruveo.sdk.ui.CallActivity"
    android:configChanges="orientation|screenSize"/>

<activity

android:name="com.gruveo.sdk.ui.CallActivity"

android:configChanges="orientation|screenSize"/>

Launching a Gruveo Screen

The Kotlin snippet below launches a Gruveo screen to connect to the gruveorocks call room.

private val SIGNER_URL = "https://api-demo.gruveo.com/signer"

override fun onCreate(savedInstanceState: Bundle?) {
    ...    
    Gruveo.Builder(this)
        .callCode("gruveorocks")
        .clientId("demo")
        .eventsListener(eventsListener)
        .build()
}
    
private val eventsListener = object : Gruveo.EventsListener {
    override fun requestToSignApiAuthToken(token: String) {
        Gruveo.authorize(signToken(token))
    }
    ...
}

private fun signToken(token: String): String {
    val body = RequestBody.create(MediaType.parse("text/plain"), token)
    val request = Request.Builder()
            .url(SIGNER_URL)
            .post(body)
            .build()

    val response = OkHttpClient().newCall(request).execute()
    return response.body()?.string() ?: ""
}

private val SIGNER_URL = "https://api-demo.gruveo.com/signer"

override fun onCreate(savedInstanceState: Bundle?) {

...

Gruveo.Builder(this)

.callCode("gruveorocks")

.clientId("demo")

.eventsListener(eventsListener)

.build()

}

private val eventsListener = object : Gruveo.EventsListener {

override fun requestToSignApiAuthToken(token: String) {

Gruveo.authorize(signToken(token))

}

...

}

private fun signToken(token: String): String {

val body = RequestBody.create(MediaType.parse("text/plain"), token)

val request = Request.Builder()

.url(SIGNER_URL)

.post(body)

.build()

val response = OkHttpClient().newCall(request).execute()

return response.body()?.string() ?: ""

}

Let's break down this example.

On lines 5-9, the Gruveo screen is initialized and instructed to connect to the gruveorocks call room. We also pass the demo client ID to the SDK to identify the SDK user, as well as bind an event listener object. Check out SDK Reference for more details on the initialization.
The event listener on lines 12-17 implements a mandatory handler for the requestToSignApiAuthToken event used for SDK authentication.
The signToken() method on lines 19-28 uses a server endpoint provided by Gruveo to sign tokens for the demo client ID as part of the SDK authentication scheme. Note that when using a production client ID, you will need your own endpoint as well as a way to authenticate your app with it.