Rate this page:

Android

The Android SDK requires four dependencies: okhttp, gson, androidx annotations, and relinker. You can directly view the dependency levels in Maven. Please note that the latest release in Maven may appear with a slight delay.

Add Voximplant libraries to your project

Copy URL
  1. Add Voximplant to the build.gladle's dependencies section. Paste the current version from the changelog:
dependencies {
    ...
    // Paste the actual version from the changelog
    implementation 'com.voximplant:voximplant-sdk:2.38.0'
}
  1. Since the 2.5.0 version, it is required to add Java 8 support to your project in the build.gradle file:
android {
    ... //other configs
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

Initialize the SDK

Copy URL

With the latest version of the Android SDK, you no longer need to manually declare permissions in the AndroidManifest.xml file.

Our SDK automatically declares the following permissions:

  • ACCESS_NETWORK_STATE

  • BLUETOOTH

  • BLUETOOTH_CONNECT

  • CAMERA

  • CHANGE_NETWORK_STATE

  • MODIFY_AUDIO_SETTINGS

  • RECORD_AUDIO

  • INTERNET

  • WRITE_EXTERNAL_STORAGE

Bluetooth permissions

On Android 12 or higher, the BLUETOOTH_CONNECT permission is required. The permission should be granted before the call. Without granting this permission, Bluetooth audio devices are not available. There is no need to request permission on Android 11 or lower.

Audio and video permissions

The CAMERA and RECORD_AUDIO permissions need a user prompt since Android 6.0 (use the Voximplant.getMissingPermissions method to see the permissions which are not granted by the user).

Сreate a Voximplant client instance of IClient type and initialize it:

IClient

IClient

Connect and log in

Copy URL

Use the IClient.connect method to connect to the Voximplant cloud and the IClient.login method to log in your user.

To track connection and authorization errors, use the IClientSessionListener and IClientLoginListener event listeners.

Connection node notice

When initializing and connecting the SDK to the Voximplant cloud, you need to specify the node to connect to. Your node is bound to your Voximplant account.

To find which node your account belongs to, log in to your control panel and see the Credentials for working with API, SDK, SIP section on the main dashboard.

Refer to this code example to understand how it works:

Connect and log in

Connect and log in

Start implementing functionality

Copy URL

Now that you have successfully connected your application and SDK to the Voximplant cloud, you can begin implementing the desired functionality, such as making calls, participating in conferences, sending messages, and more. To get started, head over to the Guides section of our documentation and select the features that align with your needs.

Android SDK demos

Copy URL

Implement the desired functionality by following step-by-step Guides or download and test our latest Android SDK here:

  • Audio call with ConnectionService: Demonstrates how to integrate ConnectionService with a voice call created with the Voximplant Android SDK.

  • Video call: Demonstrates the basic video call and screen sharing functionality of the Voximplant Android SDK.

  • Video call with DeepAR: Demonstrates how to integrate Voximplant Android SDK with DeepAR SDK to add face masks to a video call app.

  • Videoconf solution: Demonstrates how videoconf.voximplant.com works. Using it, you can create conferences, join existing conferences, use reactions, create chats, and do many more useful things.

  • Messaging: Demonstrates how to create your web and mobile messaging client based on the Voximplant SDKs.