Vue d'ensemble

Dans ce guide, vous apprendrez comment ajouter le Client SDK à votre application Android.

Conditions préalables

Le Client SDK requiert un niveau d'API Android minimum de 23.

Pour ajouter le Client SDK à votre projet

Ouvrez votre projet Android

Ouvrez la base de code de votre projet Android dans votre IDE.

Ajouter des dépendances

Le Vonage Client SDK sur Android est distribué sous la forme de 3 SDK distincts. com.vonage.client-sdk-voice pour la fonctionnalité vocale in-App Voice, com.vonage.client-sdk-chat pour la fonctionnalité In-App Messaging, et combinée en tant que com.vonage.client-sdk. com.vonage.client-sdk-chat n'inclut pas la dépendance WebRTC, il s'agit donc d'une bibliothèque plus petite. Vous ne devez utiliser qu'un seul SDK à la fois dans votre application.

  • In-App Voice et In-App Messaging - installation com.vonage.client-sdk seulement.

  • In-App Voice - installer com.vonage.client-sdk-voice seulement.

  • In-App Messaging - installation com.vonage.client-sdk-chat seulement.

Avis d'obsolescence du produit
À compter du 30 avril 2026, le service In-App Messaging de Vonage ne sera plus disponible. L'accès pour les nouveaux utilisateurs sera fermé et le service sera interrompu pour tous les utilisateurs existants.
Si vous avez des questions concernant l'arrêt de ce produit, veuillez contacter votre Account manager ou notre équipe d'assistance.

NOTE : Deux langages sont utilisés pour définir les scripts de construction de Gradle - Groovy (build.gradle ) et Kotlin Gradle Script (build.gradle.kts ). Un projet Kotlin-Android peut encore utiliser Groovy comme langage pour les scripts de compilation. Veuillez vérifier l'extension du fichier pour déterminer le langage des fichiers de script de construction.

Ajoutez maintenant le Client SDK à votre projet. Ajoutez la dépendance suivante au niveau de votre application build.gradle (typiquement app/build.gradle) :

dependencies {
    implementation 'com.vonage:client-sdk:1.6.0'
}

Il se peut que vous deviez augmenter l'allocation de mémoire pour la JVM en modifiant le fichier org.gradle.jvmargs dans votre gradle.properties fichier. Nous recommandons de fixer cette valeur à au moins 4 Go :

org.gradle.jvmargs=-Xmx4096m -Dfile.encoding=UTF-8

Définir Java 1.8

Définissez Java 1.8 au niveau de votre application build.gradle ou build.gradle.kts (typiquement app/build.gradle ou app/build.gradle.kts) :

android {
   
   // ...

   compileOptions {
       sourceCompatibility JavaVersion.VERSION_1_8
       targetCompatibility JavaVersion.VERSION_1_8
   }

   // Only for Kotlin projects
   kotlinOptions {
       jvmTarget = JavaVersion.VERSION_1_8.toString()
   }
}

Ajouter des autorisations

Pour utiliser les fonctionnalités In-App Voice, ajoutez des autorisations audio en suivant la procédure suivante :

  1. Ajoutez les autorisations nécessaires au AndroidManifest.xml fichier :
<manifest ...>
	<uses-permission android:name="android.permission.INTERNET" />
	<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
	<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
	<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
	<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
	<uses-permission android:name="android.permission.RECORD_AUDIO" />
	<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
</manifest>

Permissions d'exécution

  • Pour les appareils fonctionnant sous Android version 6.0 Marshmallow (API level 23) ou plus, vous devez demander l'option RECORD_AUDIO au moment de l'exécution :
// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO)
ActivityCompat.requestPermissions(this, callsPermissions, 123)
  • Pour les appareils fonctionnant sous Android version 12 (niveau API 31) ou plus, vous devez également demander l'option READ_PHONE_STATE au moment de l'exécution :
// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO, Manifest.permission.READ_PHONE_STATE)
ActivityCompat.requestPermissions(this, callsPermissions, 123)

En savoir plus sur la demande d'autorisations d'exécution sur Android ici.

Règles ProGuard

En option, si vous utilisez ProGuard, vous devrez configurer l'outil pour qu'il ignore le Vonage Client SDK. Il n'est pas recommandé de réduire et/ou d'obscurcir le Client SDK de Vonage et cela pourrait causer des conflits avec d'autres bibliothèques. La configuration recommandée de ProGuard est la suivante :

-keep class org.webrtc.**  { *; }
-keep class org.vonage.**  { *; }
-keep class com.vonage.**  { *; }

La configuration ci-dessus force le code source de Vonage Client SDK à être conservé tel quel, tout en permettant au reste de l'application d'être réduit. Le compilateur effectue automatiquement un ensemble d'optimisations par défaut, mais il est possible d'activer des optimisations supplémentaires qui peuvent vous obliger à inclure des règles ProGuard supplémentaires pour éviter les problèmes d'exécution. Vous pouvez le faire en ajoutant ce qui suit dans le fichier de propriétés gradle du projet :

android.enableR8.fullMode=true

Pour plus d'informations sur l'optomisation de votre application Android, veuillez vous référer au document officiel Documentation Android.

Utiliser le Client SDK dans votre application

Maintenant que vous avez installé le Client SDK et demandé les autorisations audio, vous pouvez commencer à l'utiliser.

Créer une session

Les sessions sont un flux de communication en direct entre le Client SDK et les serveurs de Vonage. Créer une VoiceClient puis créer une session avec un utilisateur JWT de l'argent.

var client = VoiceClient(this.application.applicationContext)

client.createSession("JWT_TOKEN") { error, sessionId ->
    ...     
}

Si la création de la session est réussie, vous recevrez un identifiant de session.

Statut de la session

Si la session comporte des erreurs après avoir été créée avec succès, vous les recevrez sur la page d'accueil de la session. SessionErrorListener sur le VoiceClient objet.

client.setSessionErrorListener { reason ->
    //Reason for error
}

Conclusion

Vous avez ajouté le Client SDK à votre application Android et créé une session. Vous pouvez maintenant utiliser la fonction VoiceClient dans votre application et utiliser les fonctionnalités du Client SDK.

Voir aussi