OpenTok Android SDK-Referenz
Das OpenTok-Android-SDK enthält die folgenden Klassen:
| Klasse | Beschreibung |
|---|---|
| AudioDaten | |
| AudioDeviceManager | Sie können für die App nur eine einzige Audioaufnahmequelle und ein einziges Wiedergabeziel festlegen. Es ist nicht möglich, diese Einstellungen für jeden Publisher und jeden Subscriber individuell vorzunehmen. Sie können jedoch die Audio-Bitrate für einen veröffentlichten Stream mithilfe der Methode `PublisherKit.Builder.audioBitrate(int)` festlegen. |
| Basis-Audiogerät | Rufen Sie diese Methode auf, bevor Sie eine Verbindung zu einer Sitzung herstellen. |
| BaseAudioDevice.AudioBus | |
| BaseAudioDevice.AudioFocusManager | Bei der Verwaltung externer Audiofokusse übernimmt das Vonage SDK die Weiterleitung der Audioausgabe nicht automatisch. Bei der Verwendung von ConnectionServices sollten Sie die integrierten Funktionen des Telecom-Frameworks zur Audioweiterleitung nutzen. Die Plattform stellt Ihrer App eine einheitliche Liste der verfügbaren Audio-Routen zur Verfügung. |
| BaseAudioDevice.AudioSettings | Derzeit ist das einzige verfügbare Abtastformat „signed 16-bit integer PCM“. |
| BaseAudioDevice.BluetoothState | |
| BaseAudioDevice.OutputMode | |
| BaseVideoCapturer | |
| BaseVideoCapturer.CaptureSettings | |
| BaseVideoCapturer.CaptureSwitch | Wenn Sie einen benutzerdefinierten Video-Capturer verwenden, implementieren Sie die Schnittstelle „CaptureSwitch“ in dem Objekt, das „BaseVideoCapturer“ erweitert. Implementieren Sie anschließend die Methode „cycleCamera()“, um das Verhalten der Methode „Publisher.cycleCamera()“ für das Publisher-Objekt zu definieren, das den Video-Capturer verwendet. |
| BaseVideoCapturer.VideoContentHint | Weitere Informationen zu diesen Optionen finden Sie im W3C-Arbeitsentwurf. |
| BaseVideoRenderer | Sie können diese Klasse erweitern und diese Methode überschreiben, um weitere Stile und Verhaltensweisen zu unterstützen. |
| BaseVideoRenderer.Frame | |
| Ca-Zertifikate | |
| Verbindung | Um eine Sitzung zu initialisieren, rufen Sie den Konstruktor `Session()` auf, der das `Session`-Objekt zurückgibt. Rufen Sie anschließend die Methode `connect()` des `Session`-Objekts auf, um eine Verbindung zur Sitzung herzustellen. Sobald die Verbindung zur Sitzung hergestellt ist, wird die Methode `Session.SessionListener.onConnected(Session session)` aufgerufen. |
| MediaUtils | |
| MediaUtils.SupportedCodecs | |
| MediaUtils.VideoCodecType | |
| MuteForcedInfo | |
| Ursache für die Netzwerkbeeinträchtigung | |
| NetworkDegradationSource.Source | |
| Opentok-Fehler | Überprüfen Sie die von getErrorCode() und getMessage() zurückgegebenen Werte, um Einzelheiten zum Fehler zu erfahren. |
| OpentokError.Domain | |
| OpentokError.ErrorCode | |
| PermissionsUtils | |
| Herausgeber | Wenn die Ansicht eines Publishers das aktive Fenster verlässt, wird das Publisher-Objekt zerstört. Dies ist der Fall, wenn eine Aktivität beendet oder angehalten wird. |
| Herausgeber.Builder | Verwenden Sie die Methode `Session.publish(PublisherKit publisher)`, um das Streaming vom Publisher in eine Sitzung zu starten. |
| Publisher.CameraCaptureFrameRate | Beachten Sie, dass in Sitzungen, die den OpenTok Media Router verwenden (Sitzungen, bei denen der Medienmodus auf „routed“ eingestellt ist), eine Verringerung der Bildrate zu einer proportionalen Verringerung der vom Stream beanspruchten Bandbreite führt. In Sitzungen, bei denen der Medienmodus auf „relayed“ eingestellt ist, führt eine Verringerung der Bildrate jedoch nicht zu einer Verringerung der vom Stream beanspruchten Bandbreite. |
| Publisher.CameraCaptureResolution | |
| Publisher.CameraListener | |
| PublisherKit | Erstellen Sie eine Unterklasse von „PublisherKit“, wenn Sie eine eigene Implementierung für die Videoaufnahme und -wiedergabe bereitstellen möchten. Andernfalls verwenden Sie die Klasse „Publisher“, die bereits über einen integrierten Videoaufzeichner und -wiedergaber verfügt. |
| PublisherKit.AudioLevelListener | |
| PublisherKit.AudioStatsListener | |
| PublisherKit.AudioTransformer | Wichtig: Ab Version 2.27.2 des Vonage Video-Client SDK für Android müssen Sie die Vonage Media Library separat vom Vonage Video Android SDK hinzufügen. Weitere Informationen finden Sie unter „Integration der Vonage Media Library“. Weitere Informationen finden Sie in der Datei „README.md“ des Transformers-Pakets. |
| PublisherKit.Builder | Verwenden Sie die Methode `Session.publish(PublisherKit publisher)`, um das Streaming vom Publisher in eine Sitzung zu starten. |
| PublisherKit.CustomAudioTransformer | |
| PublisherKit.CustomVideoTransformer | |
| PublisherKit.DegradationPreference | |
| PublisherKit.MediaLinkStatsListener | Wird in regelmäßigen Abständen aufgerufen, um Statistiken zu den Medien-Links des Herausgebers zu melden. Es liefert Kennzahlen auf Transportebene. |
| PublisherKit.MuteListener | |
| PublisherKit.BevorzugteVideoCodecs | |
| PublisherKit.PreferredVideoCodecs.Codec | |
| PublisherKit.PublisherAudioStats | |
| PublisherKit.PublisherKitVideoType | |
| PublisherKit.PublisherListener | |
| PublisherKit.PublisherMediaLinkStats | Da Video und Audio denselben zugrunde liegenden Transport nutzen, fasst diese Klasse die lokalen Transportstatistiken in einem einzigen Objekt zusammen. |
| PublisherKit.PublisherRtcStats | Hier ist ein Auszug: |
| PublisherKit.PublisherRtcStatsReportListener | |
| PublisherKit.PublisherVideoStats | |
| PublisherKit.VideoBitratePreset | Diese Voreinstellungen wenden vordefinierte Strategien zur Steuerung der Videobitrate im Stream des Publishers an. Voreingestellte Konfigurationen und manuelle Bitrate-Einstellungen schließen sich gegenseitig aus. |
| PublisherKit.VideoLayerStats | In einer Simulcast-Konfiguration entspricht jeder Eintrag einer eigenständigen Videokodierung (beispielsweise parallel gesendete Streams mit niedriger, mittlerer und hoher Auflösung). Bei SVC (Scalable Video Coding) sendet der Publisher in der Regel eine einzige Videokodierung, wobei die Skalierbarkeit (zeitlich, räumlich oder beides) int |
| PublisherKit.VideoListener | Diese Methode wird vor allem dann aufgerufen, wenn sich die Verbindungsqualität verschlechtert. |
| PublisherKit.VideoStatsListener | Das Objekt „PublisherKit.PublisherVideoStats“ enthält Eigenschaften für die empfangenen Videobytes, die verlorenen Videopakete und die für den Publisher empfangenen Videopakete. |
| PublisherKit.VideoTransformer | Wichtig: Ab Version 2.27.2 des Vonage Video-Client SDK für Android müssen Sie die Vonage Media Library separat vom Vonage Video Android SDK hinzufügen. Weitere Informationen finden Sie unter „Integration der Vonage Media Library“. Weitere Informationen finden Sie in der Datei „README.md“ des Transformers-Pakets. |
| Sitzung | Wenn Sie die Session-Instanz erstellen, übergeben Sie die OpenTok-Sitzungs-ID, das Token und den API-Schlüssel. Den API-Schlüssel erhalten Sie bei der Registrierung für einen OpenTok-Account. Zu Testzwecken können Sie Test-Sitzungs-IDs und -Token generieren, indem Sie sich bei Ihrem Vonage Video API-Account anmelden. Verwenden Sie die serverseitige OpenTok-Bibliothek |
| Session.ArchiveListener | |
| Session.Builder | Der Standardwert ist „false“. |
| Session.Builder.IceServer | |
| Session.Builder.IncludeServers | |
| Session.Builder.TransportPolicy | |
| Session.Capabilities | Wenn Sie sich beispielsweise mit einem Token, dem die Rolle „Subscriber“ zugewiesen ist, bei einer Sitzung anmelden, wird die Eigenschaft „canPublish“ dieses Objekts auf „false“ gesetzt (und der Client verfügt nicht über die Berechtigung, Inhalte in der Sitzung zu veröffentlichen). Weitere Informationen finden Sie in der OpenTok-Token-Dokumentation. |
| Session.ConfigurableSessionOptions | |
| Session.ConnectionListener | |
| Session.MuteListener | |
| Session.ReconnectionListener | Als Reaktion auf den Aufruf dieser Methode sollten Sie möglicherweise eine Benachrichtigung über die Benutzeroberfläche anzeigen, um den Benutzer darüber zu informieren, dass die App versucht, die Verbindung zur Sitzung wiederherzustellen, und dass die Audio- und Videostreams vorübergehend unterbrochen sind. |
| Session.SessionListener | Diese Methode wird aufgerufen, wenn der Versuch, eine Verbindung zur Sitzung herzustellen, fehlschlägt. Sie wird außerdem aufgerufen, wenn die Verbindung zur Sitzung nach einer erfolgreichen Verbindungsherstellung aufgrund eines Fehlers unterbrochen wird; in diesem Fall wird die Methode unmittelbar vor dem Aufruf der Methode `onDisconnected(Session session)` aufgerufen. |
| Session.SessionOptions | |
| Session.SessionOptionsProvider | |
| Session.SignalListener | |
| Session.StreamCaptionsPropertiesListener | |
| Session.StreamPropertiesListener | |
| Stream | Die Methode `Session.SessionListener.onStreamDropped(Session session, Stream stream)` gibt eine Benachrichtigung aus, wenn Streams aus der Sitzung entfernt werden. |
| Stream.StreamVideoType | |
| Abonnent | |
| Subscriber.Builder | Verwenden Sie die Methode `Session.subscribe(SubscriberKit subscriber)`, um das Video-Streaming für den Abonnenten zu starten. |
| SubscriberKit | Die Eigenschaft „stream“ verweist auf den Stream, den Sie abonniert haben. Die Klasse „SubscriberKit“ enthält Methoden, mit denen Sie die lokale Audio- und Videowiedergabe für den abonnierten Stream deaktivieren und aktivieren können. |
| SubscriberKit.AudioLevelListener | |
| SubscriberKit.AudioStatsListener | |
| SubscriberKit.Builder | Verwenden Sie die Methode `Session.subscribe(SubscriberKit subscriber)`, um das Video-Streaming für den Abonnenten zu starten. |
| SubscriberKit.CaptionsListener | |
| SubscriberKit.MediaLinkStatsListener | Wird in regelmäßigen Abständen aufgerufen, um Statistiken zu den Medienverbindungen des Abonnenten zu melden. Es liefert Metriken auf Transportebene sowohl für den lokalen Abonnenten als auch für den entfernten Publisher. |
| SubscriberKit.SenderStats | |
| SubscriberKit.StreamListener | Als Reaktion auf den Aufruf dieser Methode sollten Sie möglicherweise eine Benachrichtigung über die Benutzeroberfläche anzeigen, um den Benutzer darüber zu informieren, dass die Verbindung zum Audio-Video-Stream vorübergehend unterbrochen ist und die App versucht, die Verbindung zum Stream wiederherzustellen. |
| SubscriberKit.SubscriberAudioStats | |
| SubscriberKit.SubscriberListener | |
| SubscriberKit.SubscriberMediaLinkStats | |
| SubscriberKit.SubscriberRtcStatsReportListener | Hier ist ein Auszug: |
| SubscriberKit.SubscriberVideoStats | |
| SubscriberKit.VideoListener | Diese Funktion ist nur in Sitzungen verfügbar, die den OpenTok Media Router verwenden (Sitzungen, bei denen der Medienmodus auf „routed“ eingestellt ist), nicht jedoch in Sitzungen, bei denen der Medienmodus auf „relayed“ eingestellt ist. (Siehe „Der OpenTok Media Router und die Medienmodi“.) |
| SubscriberKit.VideoStatsListener | Listener für qualitätsbezogene Videoereignisse eines Abonnenten. |
| TransportStats | |
| TransportStats.Netzwerkzustand | |
| VideoUtils | |
| VideoUtils.Size |