Guide de référence du SDK OpenTok pour Android
Le SDK OpenTok pour Android comprend les classes suivantes :
| Classe | Description |
|---|---|
| Données audio | |
| AudioDeviceManager | Vous ne pouvez définir qu'une seule source de capture audio et une seule cible de rendu pour l'application. Il n'est pas possible de les configurer individuellement pour chaque éditeur et chaque abonné. Vous pouvez toutefois définir le débit binaire audio d'un flux publié à l'aide de la méthode PublisherKit.Builder.audioBitrate(int). |
| Périphérique audio de base | Appelez cette méthode avant de vous connecter à une session. |
| BaseAudioDevice.AudioBus | |
| BaseAudioDevice.AudioFocusManager | En ce qui concerne la gestion de la sélection audio externe, le SDK Vonage ne gère pas automatiquement l'acheminement de la sortie audio. Lorsque vous utilisez ConnectionServices, vous devez exploiter les fonctionnalités d'acheminement audio intégrées au framework Telecom. La plateforme fournit à votre application une liste unifiée des chemins audio disponibles |
| BaseAudioDevice.AudioSettings | À l'heure actuelle, le seul format d'échantillonnage disponible est le PCM à entiers signés de 16 bits. |
| BaseAudioDevice.BluetoothState | |
| BaseAudioDevice.OutputMode | |
| BaseVideoCapturer | |
| BaseVideoCapturer.ParamètresDeCapture | |
| BaseVideoCapturer.CaptureSwitch | Si vous utilisez un capteur vidéo personnalisé, implémentez l'interface CaptureSwitch dans l'objet qui étend BaseVideoCapturer. Implémentez ensuite la méthode cycleCamera() afin de définir le comportement de la méthode Publisher.cycleCamera() pour l'objet Publisher qui utilise ce capteur vidéo. |
| BaseVideoCapturer.VideoContentHint | Pour en savoir plus sur ces options, vous pouvez consulter le projet de travail du W3C. |
| BaseVideoRenderer | Vous pouvez étendre cette classe et redéfinir cette méthode afin de prendre en charge d'autres styles et comportements. |
| BaseVideoRenderer.Frame | |
| Certificats CA | |
| Connexion | Pour initialiser une session, appelez le constructeur Session(), qui renvoie l'objet Session. Appelez ensuite la méthode connect() de l'objet Session pour vous connecter à la session. Une fois la connexion à la session établie, la méthode Session.SessionListener.onConnected(Session session) est appelée. |
| MediaUtils | |
| MediaUtils.SupportedCodecs | |
| MediaUtils.VideoCodecType | |
| MuteForcedInfo | |
| Source de dégradation du réseau | |
| Source de dégradation du réseau.Source | |
| OpentokError | Consultez les valeurs renvoyées par les fonctions getErrorCode() et getMessage() pour obtenir plus de détails sur l'erreur. |
| OpentokError.Domain | |
| OpentokError.CodeErreur | |
| PermissionsUtils | |
| Éditeur | Lorsqu'une vue d'un Publisher quitte la fenêtre active, l'objet Publisher est détruit. C'est le cas lorsqu'une activité est arrêtée ou mise en pause. |
| Publisher.Builder | Utilisez la méthode Session.publish(PublisherKit publisher) pour lancer la diffusion en continu depuis l'éditeur vers une session. |
| Publisher.CameraCaptureFrameRate | Notez que dans les sessions utilisant OpenTok Media Router (sessions dont le mode multimédia est défini sur « routed »), la réduction de la fréquence d'images diminue proportionnellement la bande passante utilisée par le flux. En revanche, dans les sessions dont le mode multimédia est défini sur « relayed », la réduction de la fréquence d'images ne réduit pas la bande passante du flux. |
| Publisher.CameraCaptureResolution | |
| Publisher.CameraListener | |
| PublisherKit | Créez une sous-classe de PublisherKit si vous souhaitez fournir votre propre implémentation de capture et de rendu vidéo. Sinon, utilisez la classe Publisher, qui intègre un module de capture et de rendu vidéo prêt à l'emploi. |
| PublisherKit.AudioLevelListener | |
| PublisherKit.AudioStatsListener | |
| PublisherKit.AudioTransformer | Important : à partir de la version 2.27.2 du Client SDK Vonage Video pour Android, vous devez ajouter la bibliothèque multimédia Vonage séparément du Client SDK Android Vonage Video. Pour plus de détails, consultez la section « Intégration de la bibliothèque multimédia Vonage ». Consultez les informations supplémentaires dans le fichier README.md du package « Transformers ». |
| PublisherKit.Builder | Utilisez la méthode Session.publish(PublisherKit publisher) pour lancer la diffusion en continu depuis l'éditeur vers une session. |
| PublisherKit.CustomAudioTransformer | |
| PublisherKit.CustomVideoTransformer | |
| PublisherKit.Préférence de dégradation | |
| PublisherKit.MediaLinkStatsListener | Appelée périodiquement pour communiquer les statistiques relatives aux liens multimédias de l'éditeur. Elle fournit des indicateurs au niveau du transport. |
| PublisherKit.MuteListener | |
| PublisherKit.Codecs vidéo préférés | |
| PublisherKit.PreferredVideoCodecs.Codec | |
| PublisherKit.PublisherAudioStats | |
| PublisherKit.PublisherKitVideoType | |
| PublisherKit.PublisherListener | |
| PublisherKit.PublisherMediaLinkStats | Étant donné que la vidéo et l'audio partagent le même protocole de transport sous-jacent, cette classe regroupe les statistiques de transport locales au sein d'un seul objet. |
| PublisherKit.PublisherRtcStats | En voici un extrait : |
| PublisherKit.PublisherRtcStatsReportListener | |
| PublisherKit.PublisherVideoStats | |
| PublisherKit.VideoBitratePreset | Ces préréglages appliquent des stratégies prédéfinies pour contrôler le débit binaire vidéo dans le flux de l'éditeur. Les configurations de préréglages et les réglages manuels du débit binaire s'excluent mutuellement. |
| PublisherKit.VideoLayerStats | Dans une configuration de diffusion simultanée, chaque entrée correspond à un encodage vidéo indépendant (par exemple, des flux en basse, moyenne et haute résolution envoyés en parallèle). Pour le SVC (Scalable Video Coding), l'éditeur envoie généralement un seul encodage vidéo, avec une évolutivité (temporelle, spatiale ou les deux) int |
| PublisherKit.VideoListener | Cette méthode est principalement appelée lorsque la qualité de la connexion se détériore. |
| PublisherKit.VideoStatsListener | L'objet PublisherKit.PublisherVideoStats comprend des propriétés relatives au nombre d'octets vidéo reçus, au nombre de paquets vidéo perdus et au nombre de paquets vidéo reçus pour l'éditeur. |
| PublisherKit.VideoTransformer | Important : à partir de la version 2.27.2 du Client SDK Vonage Video pour Android, vous devez ajouter la bibliothèque multimédia Vonage séparément du Client SDK Android Vonage Video. Pour plus de détails, consultez la section « Intégration de la bibliothèque multimédia Vonage ». Consultez les informations supplémentaires dans le fichier README.md du package « Transformers ». |
| Session | Lorsque vous créez l'instance Session, vous devez fournir l'identifiant de session OpenTok, le jeton et la clé API. Vous obtenez une clé API lors de la création de votre compte OpenTok. À des fins de test, vous pouvez générer des identifiants de session et des jetons de test en vous connectant à votre compte Vonage Video API. Utilisez la bibliothèque côté serveur OpenTok |
| Session.ArchiveListener | |
| Session.Builder | La valeur par défaut est « false ». |
| Session.Builder.IceServer | |
| Session.Builder.IncludeServers | |
| Session.Builder.TransportPolicy | |
| Session.Capacités | Par exemple, si vous vous connectez à une session à l'aide d'un jeton auquel est attribué le rôle « Subscriber », la propriété « canPublish » de cet objet est définie sur « false » (et le client ne dispose pas des privilèges nécessaires pour publier dans la session). Pour plus d'informations, consultez la documentation relative aux jetons OpenTok. |
| Session.ConfigurableSessionOptions | |
| Session.ConnectionListener | |
| Session.MuteListener | |
| Session.ReconnectionListener | Lorsque cette méthode est appelée, vous pouvez afficher une notification dans l'interface utilisateur afin d'informer l'utilisateur que l'application tente de se reconnecter à la session et que les flux audio et vidéo sont temporairement interrompus. |
| Session.SessionListener | Cette méthode est appelée si la tentative de connexion à la session échoue. Elle est également appelée si la connexion à la session est interrompue à la suite d'une erreur après une connexion réussie ; dans ce cas, la méthode est appelée juste avant l'appel de la méthode onDisconnected(Session session). |
| Session.SessionOptions | |
| Session.SessionOptionsProvider | |
| Session.SignalListener | |
| Session.StreamCaptionsPropertiesListener | |
| Session.StreamPropertiesListener | |
| Flux | La méthode `Session.SessionListener.onStreamDropped(Session session, Stream stream)` signale que des flux ont été retirés de la session. |
| Stream.StreamVideoType | |
| Abonné | |
| Subscriber.Builder | Utilisez la méthode Session.subscribe(SubscriberKit subscriber) pour lancer la diffusion en continu de la vidéo pour l'abonné. |
| SubscriberKit | La propriété « stream » fait référence au flux auquel vous êtes abonné. La classe SubscriberKit comprend des méthodes qui vous permettent de désactiver et d'activer la lecture locale de l'audio et de la vidéo pour le flux auquel vous êtes abonné. |
| SubscriberKit.AudioLevelListener | |
| SubscriberKit.AudioStatsListener | |
| SubscriberKit.Builder | Utilisez la méthode Session.subscribe(SubscriberKit subscriber) pour lancer la diffusion en continu de la vidéo pour l'abonné. |
| SubscriberKit.CaptionsListener | |
| SubscriberKit.MediaLinkStatsListener | Appelée périodiquement pour communiquer les statistiques relatives aux liaisons multimédias de l'abonné. Elle fournit des indicateurs au niveau du transport tant pour l'abonné local que pour l'éditeur distant. |
| SubscriberKit.SenderStats | |
| SubscriberKit.StreamListener | Lorsque cette méthode est appelée, vous pouvez afficher une notification dans l'interface utilisateur afin d'informer l'utilisateur que le flux audio-vidéo est temporairement déconnecté et que l'application tente de se reconnecter au flux. |
| SubscriberKit.SubscriberAudioStats | |
| SubscriberKit.SubscriberListener | |
| SubscriberKit.SubscriberMediaLinkStats | |
| SubscriberKit.SubscriberRtcStatsReportListener | En voici un extrait : |
| SubscriberKit.SubscriberVideoStats | |
| SubscriberKit.VideoListener | Cette fonctionnalité n'est disponible que dans les sessions utilisant OpenTok Media Router (sessions dont le mode multimédia est défini sur « routed »), et non dans celles dont le mode multimédia est défini sur « relayed ». (Voir « OpenTok Media Router et modes multimédia »). |
| SubscriberKit.VideoStatsListener | Écouteur pour les événements vidéo liés à la qualité d'un abonné. |
| Statistiques sur les transports | |
| TransportStats.État du réseau | |
| VideoUtils | |
| VideoUtils.Size |