Übersicht

In dieser Anleitung erfahren Sie, wie Sie das Client SDK zu Ihrer Android-App hinzufügen.

Voraussetzungen

Für das Client SDK ist mindestens die Android-API-Stufe 23 erforderlich.

So fügen Sie das Client SDK zu Ihrem Projekt hinzu

Öffnen Sie Ihr Android-Projekt

Öffnen Sie die Codebasis Ihres Android-Projekts in Ihrer IDE.

Abhängigkeiten hinzufügen

Das Vonage Client SDK für Android wird als 3 separate SDKs verteilt. com.vonage.client-sdk-voice für die In-App Voice-Funktionalität, com.vonage.client-sdk-chat für die In-App Messaging-Funktionalität, und kombiniert als com.vonage.client-sdk. com.vonage.client-sdk-chat enthält nicht die WebRTC-Abhängigkeit, so dass es eine kleinere Bibliothek ist. Sie dürfen jeweils nur ein SDK in Ihrer Anwendung verwenden.

• In-App Voice und In-App Messaging - installieren com.vonage.client-sdk nur.

• In-App Voice - installieren com.vonage.client-sdk-voice nur.

• In-App Messaging - installieren com.vonage.client-sdk-chat nur.

Fügen Sie nun das Client SDK zu Ihrem Projekt hinzu. Fügen Sie die folgende Abhängigkeit in Ihrer App-Ebene hinzu build.gradle Datei (typischerweise app/build.gradle):

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

Möglicherweise müssen Sie die Speicherzuweisung für die JVM erhöhen, indem Sie die Datei org.gradle.jvmargs Eigenschaft in Ihrem gradle.properties Datei. Es wird empfohlen, diese auf mindestens 4 GB einzustellen:

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

Java 1.8 einstellen

Setzen Sie Java 1.8 in Ihrer Anwendungsebene build.gradle oder build.gradle.kts Datei (typischerweise app/build.gradle oder 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()
   }
}

Berechtigungen hinzufügen

Um die In-App Voice-Funktionen zu nutzen, fügen Sie mit dem folgenden Verfahren Audiorechte hinzu:

1. Fügen Sie die erforderlichen Berechtigungen zur Datei AndroidManifest.xml Datei:

<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>

Laufzeitberechtigungen

• Für Geräte mit Android Version 6.0 Marshmallow (API Level 23) oder höher sollten Sie die RECORD_AUDIO Erlaubnis zur Laufzeit:

// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO)
ActivityCompat.requestPermissions(this, callsPermissions, 123)

• Für Geräte mit Android-Version 12 (API-Level 31) oder höher sollten Sie auch die READ_PHONE_STATE Erlaubnis zur Laufzeit:

// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO, Manifest.permission.READ_PHONE_STATE)
ActivityCompat.requestPermissions(this, callsPermissions, 123)

Lesen Sie mehr über das Anfordern von Laufzeitberechtigungen unter Android hier.

ProGuard-Regeln

Wenn Sie ProGuard verwenden, müssen Sie das Tool optional so konfigurieren, dass das Vonage Client SDK übersprungen wird. Eine Verkleinerung und/oder Verschleierung des Vonage Client SDK wird nicht empfohlen und kann zu Konflikten mit anderen Bibliotheken führen. Die empfohlene ProGuard-Konfiguration lautet:

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

Die obige Konfiguration erzwingt, dass der Quellcode des Vonage Client SDK unverändert bleibt, während der Rest der Anwendung verkleinert werden kann. Der Compiler führt standardmäßig automatisch eine Reihe von Optimierungen durch, aber es ist möglich, zusätzliche Optimierungen zu aktivieren, die möglicherweise erfordern, dass Sie zusätzliche ProGuard-Regeln einfügen, um Laufzeitprobleme zu vermeiden. Sie können dies tun, indem Sie Folgendes in der gradle-Eigenschaftendatei des Projekts hinzufügen:

android.enableR8.fullMode=true

Weitere Informationen über die Optimierung Ihrer Android-App finden Sie in der offiziellen Android-Dokumentation.

Verwendung des Client SDK in Ihrer Anwendung

Nach der Installation des Client SDK und der Beantragung von Audiorechten können Sie es nun verwenden.

Eine Sitzung erstellen

Sitzungen sind ein Live-Kommunikationsstrom zwischen dem Client SDK und den Vonage-Servern. Erstellen einer VoiceClient Objekt, dann erstellen Sie eine Sitzung mit einem Benutzer JWT Token.

var client = VoiceClient(this.application.applicationContext)

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

Wenn die Erstellung der Sitzung erfolgreich war, erhalten Sie eine Sitzungs-ID.

Status der Sitzung

Treten nach der erfolgreichen Erstellung der Sitzung Fehler auf, werden diese in der SessionErrorListener über die VoiceClient Objekt.

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

Schlussfolgerung

Sie haben das Client SDK zu Ihrer Android-App hinzugefügt und eine Sitzung erstellt. Sie können nun die VoiceClient Client in Ihrer Anwendung und nutzen Sie die Funktionen des Client SDK.

Siehe auch

• Konfiguration des Rechenzentrums - Dies ist eine erweiterte optionale Konfiguration, die Sie nach dem Hinzufügen des SDK zu Ihrer Anwendung vornehmen können.