UXKit Voxeet Java

UXKit Initialization

The Android UXKit is the standard SDK extension which helps to integrate additional features enhancing the UX without UI burden.

Dependency

The integration of the Android UXKit into an application is as simple as the following build.gradle.

dependencies {
    ...
    api ("com.voxeet.sdk:toolkit:${rootProject.ext.voxeetSdkToolkitVersion}") {
        transitive = true
    }
}

It is recommended to use Gradle tips and recipes. The recommended properties are in the example below.

ext {
    buildToolsVersion = "28.0.3"
    minSdkVersion = 14
    compileSdkVersion = 28
    targetSdkVersion = 28
    supportLibVersion = "28.0.0"
    voxeetSdkVersion = "2.0.72.1"
    voxeetSdkToolkitVersion = "2.0.72.2"
}

Conflict management

Note: adding support libraries with versions 28.0.+ can lead to issues with outdated libraries.

The UXKit requires the following:

  • com.android.support:support-compat:28.0.0
  • com.android.support:appcompat-v7:28.0.0
  • com.android.support:recyclerview-v7:28.0.0
  • com.squareup.picasso:picasso:2.71828
  • org.apache.commons:commons-collections4:4.0
  • com.android.support:multidex:1.0.3
  • junit:junit:4.12

In a case of issues with the UI (for example the application uses the support libraries version 27), you can set three supported libraries as dependent on your application and UXKit, as in the example below.

dependencies {
    ...
    api ("com.voxeet.sdk:toolkit:${rootProject.ext.voxeetSdkToolkitVersion}") {
        transitive = true
    }
   
    //forcefully set the toolkit's mandatory dependencies
    api "com.android.support:support-compat:${rootProject.ext. supportLibVersion}"
    api "com.android.support:appcompat-v7:${rootProject.ext. supportLibVersion}"
    api "com.android.support:recyclerview-v7:${rootProject.ext. supportLibVersion}"
}

Initialization

Create the UXKit right after the VoxeetSdk.initialize call, as in the following example.

public class SomeApplication extends MultiDexApplication {
    @Override
    public void onCreate() {
        super.onCreate();


        VoxeetSdk.initialize(
                getString(R.string.api_key),
                getString(R.string.api_secret));

        VoxeetToolkit.initialize(this, VoxeetSdk.getInstance().getEventBus());

    }
}

Usage of extended capabilities

Set proper overlay settings by changing the value of the enableOverlay. Set a value to true to enable it, false to disable. Set proper screen sharing settings by changing the value of the setScreenShareEnabled. Set a value to true to enable it, false to disable. An exemplary setting is presented in the example below.

        VoxeetToolkit.initialize(this, VoxeetSdk.getInstance().getEventBus());
        VoxeetToolkit.getInstance().enableOverlay(false);
        VoxeetToolkit.getInstance().getConferenceToolkit().setScreenShareEnabled(true);