Session

java.lang.Object

java.util.Observable

com.opentok.android.Session

classe publique Session hérite de Observable

Représente une session OpenTok à laquelle le client participe. La première étape pour utiliser le SDK Android d'OpenTok consiste à initialiser une instance de Session en appelant le constructeur 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 lorsque vous s'inscrire pour créer un 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 Video API de Vonage. Utilisez le Bibliothèques côté serveur OpenTok pour générer des identifiants de session et des jetons dans votre application d'expédition.

Voir aussi : : - Session Création - Token Création

Résumé des classes imbriquées

Classes imbriquées

Modificateur et type

Classe

Description

static interface

Session.ArchiveListener

Surveille le début et la fin de l'enregistrement d'archive de la session.

static class

Session.Builder

static class

Session.Capabilities

Définit la valeur renvoyée par la getCapabilities() méthode.

protected static class

Session.ConfigurableSessionOptions

static interface

Session.ConnectionListener

Surveille les connexions et déconnexions des autres clients à la session.

static interface

Session.MuteListener

Surveille les moments où un modérateur coupe le son des flux dans la session ou désactive l'état « son coupé » dans la session.

static interface

Session.ReconnectionListener

Surveille les tentatives de reconnexion automatique d'un client après la perte de sa connexion à une session OpenTok.

static interface

Session.SessionListener

Surveille les changements d'état dans un Session objet.

static class

Session.SessionOptions

Une classe de base permettant de définir des options de session avancées avec le Session.Builder.sessionOptions(Session.SessionOptions sessionOptions) méthode.

static interface

Session.SessionOptionsProvider

Obsolète.

static interface

Session.SignalListener

Surveille l'envoi d'un signal au cours de la session.

static interface

Session.StreamCaptionsPropertiesListener

Surveille les modifications apportées aux propriétés des sous-titres des flux de la session.

static interface

Session.StreamPropertiesListener

Surveille les modifications apportées aux propriétés des flux de la session.

Résumé du champ

Champs

Modificateur et type

Champ d'application

Description

protected String

apiKey

protected URL

apiUrl

protected Session.ArchiveListener

archiveListener

protected Session.ConnectionListener

connectionListener

protected android.content.Context

context

protected Session.MuteListener

muteListener

protected Session.ReconnectionListener

reconnectionListener

protected String

sessionId

protected Session.SessionListener

sessionListener

protected Session.SignalListener

signalListener

protected Session.StreamCaptionsPropertiesListener

streamCaptionsPropertiesListener

protected Session.StreamPropertiesListener

streamPropertiesListener

Résumé du constructeur

Constructeurs

Modificateur

Constructeur

Description

protected

Session(Session.Builder builder)

Résumé de la méthode

Toutes les méthodes · Méthodes d'instance · Méthodes concrètes

Modificateur et type

Méthode

Description

void

connect(String token)

Se connecte à la session OpenTok fournie dans le constructeur Session, à l'aide du jeton d'authentification fourni.

void

disableForceMute()

Désactive l'état de sourdine actif de la session.

void

disconnect()

Se déconnecte de cette session.

protected void

finalize()

Appelée par le ramasse-miettes lorsqu'il détecte qu'il n'y a plus de références à l'objet Session.

void

forceDisconnect(Connection connection)

Force un client à se déconnecter de la session.

void

forceMuteAll(Iterable<Stream> excludedStreams)

Oblige tous les diffuseurs de la session (à l'exception de ceux qui diffusent des flux exclus) à couper le son.

void

forceMuteStream(Stream stream)

Force l'éditeur d'un flux spécifié à couper le son.

Session.Capabilities

getCapabilities()

Indique si le client peut publier et s'abonner à des flux au cours de la session, en fonction du rôle attribué au jeton utilisé pour se connecter à la session.

Connection

getConnection()

Renvoie le Connection correspondant à la connexion de ce client à cette session.

String

getSessionId()

Renvoie l'identifiant de session transmis lors de l'instanciation.

protected void

onArchiveStarted(String id, String name)

Appelée lorsqu'une archive de la session commence à être enregistrée.

protected void

onArchiveStopped(String id)

Appelée lorsqu'un enregistrement de la session cesse d'être enregistré.

protected void

onConnected()

Appelée lorsque le client se connecte à la session OpenTok.

protected void

onConnectionCreated(Connection connection)

Appelée lorsque un autre le client se connecte à la session.

protected void

onConnectionDestroyed(Connection connection)

Appelée lorsqu'un autre client quitte la session.

protected void

onDisconnected()

Appelée lorsque le client n'est plus connecté à la session OpenTok. »

protected void

onError(OpentokError error)

Cette méthode est appelée lorsqu'un problème survient lors de la connexion ou pendant la connexion à la session.

protected void

onMuteForced(MuteForcedInfo info)

Déclenché lorsqu'un modérateur coupe le son des flux de la session ou désactive l'état « son coupé » dans la session.

void

onPause()

Appelez cette méthode lorsque l'activité de l'application est mise en pause.

protected void

onReconnected()

Appelée lorsque le client local s'est reconnecté à la session OpenTok après une perte temporaire de connexion réseau.

protected void

onReconnecting()

Appelée lorsque le client local a perdu sa connexion à une session OpenTok et tente de se reconnecter.

void

onResume()

Appelez cette méthode lorsque l'activité de l'application reprend.

protected void

onSignalReceived(String type, String data, Connection connection)

Appelée lorsqu'un signal est reçu dans la session.

protected void

onStreamDropped(Stream stream)

Appelée lorsque un autre le client cesse de diffuser un flux vers cette session OpenTok.

protected void

onStreamHasAudioChanged(Stream stream, int hasAudio)

Appelée lorsqu'un flux de la session passe d'un état avec audio à un état sans audio.

protected void

onStreamHasCaptionsChanged(Stream stream, int hasCaptions)

Appelée lorsqu'un flux de la session passe d'un état avec sous-titres à un état sans sous-titres.

protected void

onStreamHasVideoChanged(Stream stream, int hasVideo)

Appelée lorsqu'un flux de la session passe d'un état avec vidéo à un état sans vidéo.

protected void

onStreamReceived(Stream stream)

Appelé lorsqu'un nouveau flux est publié par un autre client dans cette session OpenTok.

protected void

onStreamVideoDimensionsChanged(Stream stream, int width, int height)

Appelée lorsque les dimensions vidéo d'un flux de la session changent.

protected void

onStreamVideoTypeChanged(Stream stream, int videoType)

Appelée lorsque le type de vidéo d'un flux de la session change.

void

publish(PublisherKit publisher)

Lance la diffusion en continu d'un éditeur vers la session.

String

reportIssue()

Signalez un problème rencontré avec votre application.

void

sendSignal(String type, String data)

Envoie un signal à tous les clients d'une session.

void

sendSignal(String type, String data, boolean retryAfterReconnect)

Envoie un signal à tous les clients d'une session.

void

sendSignal(String type, String data, Connection connection)

Envoie un signal à un client spécifique au cours d'une session.

void

sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)

Envoie un signal à un client spécifique au cours d'une session. Cette version de la méthode inclut un retryAfterReconnect paramètre.

void

setArchiveListener(Session.ArchiveListener listener)

Définit un Session.ArchiveListener objet permettant de surveiller le début ou la fin d'un enregistrement d'archive au cours de cette session.

void

setConnectionListener(Session.ConnectionListener listener)

Définit un Session.ConnectionListener objet permettant de surveiller quand d'autres clients se connectent et se déconnectent de cette session.

void

setEncryptionSecret(String secret)

Définit la clé de chiffrement de bout en bout utilisée par tous les éditeurs et abonnés.

void

setMuteListener(Session.MuteListener listener)

Définit un Session.MuteListener objet à surveiller lorsque la commande « mute forced » est envoyée au cours de cette session.

void

setReconnectionListener(Session.ReconnectionListener listener)

Définit un Session.ReconnectionListener objet à notifier lorsque le client tente de se reconnecter ou s'est reconnecté à une session OpenTok.

void

setSessionListener(Session.SessionListener listener)

Définit un Session.SessionListener objet permettant de surveiller les changements d'état de cet objet Session.

void

setSignalListener(Session.SignalListener listener)

Définit un Session.SignalListener objet à surveiller lorsque des signaux sont envoyés au cours de cette session.

void

setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener listener)

Définit un Session.StreamCaptionsPropertiesListener objet permettant de surveiller les propriétés de la propriété « captions » du flux.

void

setStreamPropertiesListener(Session.StreamPropertiesListener listener)

Définit un Session.StreamPropertiesListener objet permettant de surveiller les propriétés des flux au cours de cette session.

void

subscribe(SubscriberKit subscriber)

Commencer à recevoir et à restituer les données de flux audio-vidéo pour l' abonné spécifié.

void

unpublish(PublisherKit publisher)

Déconnecte l'éditeur de la session.

void

unsubscribe(SubscriberKit subscriber)

Mette fin à l'abonnement (réception d'un flux) à un abonné spécifié dans la session.

Méthodes héritées de la classe java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Méthodes héritées de la classe java.lang.Objet

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Détails du champ

sessionListener

protégé Session.SessionListener sessionListener

connectionListener

protégé Session.ConnectionListener connectionListener

streamPropertiesListener

protégé Session.StreamPropertiesListener streamPropertiesListener

streamCaptionsPropertiesListener

protégé Session.StreamCaptionsPropertiesListener streamCaptionsPropertiesListener

signalListener

protégé Session.SignalListener signalListener

archiveListener

protégé Session.ArchiveListener archiveListener

reconnectionListener

protégé Session.ReconnectionListener reconnectionListener

muteListener

protégé Session.MuteListener muteListener

contexte

protected android.content.Context context

apiKey

protégé Chaîne apiKey

sessionId

protégé Chaîne sessionId

apiUrl

protégé URL apiUrl

Informations sur le constructeur

Session

Session protégée(Session.Builder (constructeur) lance une exception Exception

Lancers : : Exception

Détails de la méthode

getConnection

public Connexion getConnection()

Renvoie le Connection correspondant à la connexion de ce client à cette session.

Lorsqu'un flux est créé, le Session.SessionListener.onStreamReceived(Session session, Stream stream) méthode est appelée. Comparez l'objet Connection renvoyé par la Stream.getConnection() méthode avec l'objet Connection renvoyé par Sesssion.getConnection() pour vérifier si le nouveau flux est publié par votre client.

Renvoie : : L'identifiant de session OpenTok correspondant à cette instance.

Voir aussi : : - Session.SessionListener.onConnected(Session session) - Session.SessionListener.onStreamReceived(Session session, Stream stream) - Stream.getConnection()

getSessionId

public Chaîne getSessionId()

Renvoie l'identifiant de session transmis lors de l'instanciation.

Renvoie : : L'identifiant de session OpenTok correspondant à cette instance.

setSessionListener

public void setSessionListener(Session.SessionListener auditeur)

Définit un Session.SessionListener objet permettant de surveiller les changements d'état de cet objet Session.

Paramètres : : listener - Le Session.SessionListener instance.

setConnectionListener

public void setConnectionListener(Session.ConnectionListener auditeur)

Définit un Session.ConnectionListener objet permettant de surveiller quand d'autres clients se connectent et se déconnectent de cette session.

Paramètres : : listener - Le Session.ConnectionListener instance.

setStreamPropertiesListener

public void setStreamPropertiesListener(Session.StreamPropertiesListener auditeur)

Définit un Session.StreamPropertiesListener objet permettant de surveiller les modifications apportées aux propriétés des flux au cours de cette session. Il s'agit notamment des propriétés indiquant si le flux contient du son, s'il contient de la vidéo et quelles sont les dimensions de la vidéo.

Paramètres : : listener - Le Session.StreamPropertiesListener instance.

setStreamCaptionsPropertiesListener

public void setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener auditeur)

Définit un Session.StreamCaptionsPropertiesListener objet permettant de surveiller les propriétés de la propriété « captions » du flux.

Paramètres : : listener - Le Session.StreamCaptionsPropertiesListener instance.

setSignalListener

public void setSignalListener(Session.SignalListener auditeur)

Définit un Session.SignalListener objet à surveiller lorsque des signaux sont envoyés au cours de cette session.

Paramètres : : listener - Le Session.SignalListener instance.

setArchiveListener

public void setArchiveListener(Session.ArchiveListener auditeur)

Définit un Session.ArchiveListener objet permettant de surveiller le début ou la fin d'un enregistrement d'archive au cours de cette session.

Paramètres : : listener - Le Session.ArchiveListener instance.

setReconnectionListener

public void setReconnectionListener(Session.ReconnectionListener auditeur)

Définit un Session.ReconnectionListener objet à notifier lorsque le client tente de se reconnecter ou s'est reconnecté à une session OpenTok.

Paramètres : : listener - Le Session.ReconnectionListener instance.

setMuteListener

public void setMuteListener(Session.MuteListener auditeur)

Définit un Session.MuteListener objet à surveiller lorsque la commande « mute forced » est envoyée au cours de cette session.

Paramètres : : listener - Le Session.MuteListener instance.

relier

public void connect(Chaîne jeton)

Se connecte à la session OpenTok fournie dans le constructeur Session, à l'aide du jeton d'authentification fourni.

Lorsque la session est établie, le Session.SessionListener.onConnected(Session session) La méthode est appelée.

Si la session ne parvient pas à se connecter, le Session.SessionListener.onError(Session session, OpentokError error) la méthode est appelée.

Paramètres : : token - Le jeton de l'utilisateur. Voir Token Présentation générale de la création.

déconnecter

public void disconnect()

Se déconnecte de cette session. Toutes les instances d'abonné et d'éditeur seront déconnectées. Il est recommandé, avant d'appeler cette méthode, d'appeler la méthode unpublish(PublisherKit) méthode pour tous les éditeurs et attendre la PublisherKit.onStreamDestroyed(Stream) rappel. Cela garantit la suppression complète des éditeurs, en particulier si des problèmes de connectivité réseau empêchent leur suppression en raison de la fonctionnalité de reconnexion, qui peut maintenir les flux des éditeurs actifs en vue d'une éventuelle reconnexion.

Lorsque la session est interrompue, le Session.SessionListener.onDisconnected(Session session) La méthode est appelée.

onPause

public void onPause()

Appelez cette méthode lorsque l'activité de l'application est mise en pause. Cela met en pause le rendu vidéo et la capture de tous les éditeurs de la session. Cela met également en pause le rendu vidéo de tous les abonnés.

Les caméras utilisées par les éditeurs OpenTok sont désormais libérées lorsque vous appelez cette méthode. Les éditeurs récupèrent les caméras lorsque vous appelez la méthode onResume() méthode.

onResume

public void onResume()

Appelez cette méthode lorsque l'activité de l'application reprend. Cela relance le rendu vidéo et la capture de tout éditeur de la session. Cela relance également les rendus vidéo de tous les abonnés.

Toutes les caméras (utilisées par les éditeurs OpenTok) qui étaient disponibles au moment où vous avez appelé le onPause() Les paramètres de cette méthode sont récupérés lorsque vous appelez Session.onResume().

publier

public void publier(PublisherKit éditeur)

Lance la diffusion en continu d'un éditeur vers la session.

Paramètres : : publisher - L'éditeur vers lequel vous souhaitez diffuser en continu la session.

dépublier

public void retirerDeLaPublication(PublisherKit éditeur)

Déconnecte l'éditeur de la session.

Paramètres : : publisher - L'éditeur doit retirer la publication.

souscrire

public void subscribe(SubscriberKit abonné)

Commencer à recevoir et à restituer les données de flux audio-vidéo pour l' abonné spécifié.

Paramètres : : subscriber - L'abonné associé au flux à recevoir.

se désinscrire

public void se-désabonner(SubscriberKit abonné)

Mette fin à l'abonnement (réception d'un flux) à un abonné spécifié dans la session.

Paramètres : : subscriber - L'abonné dont vous souhaitez résilier l'abonnement.

sendSignal

public void envoyerSignal(Chaîne type, Chaîne données)

Envoie un signal à tous les clients d'une session.

Voir aussi : : - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void envoyerSignal(Chaîne type, Chaîne données, booléen retryAfterReconnect)

Envoie un signal à tous les clients d'une session. Cette version de la méthode inclut un retryAfterReconnect paramètre.

Paramètres : : type - Le type du signal. Le type est également défini dans le Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) méthode. : data - Les données à envoyer. La taille maximale des données est de 8 ko. : retryAfterReconnect - Lors de la reconnexion à la session, il faut déterminer s’il faut envoyer les signaux qui ont été déclenchés pendant la déconnexion. Si votre client perd sa connexion à la session OpenTok, en raison d’une interruption de la connexion réseau, le client tente de se reconnecter à la session, et le Session.ReconnectionListener.onReconnecting(Session session) méthode est appelée. Par défaut, les signaux générés pendant la déconnexion sont envoyés lorsque (et si) le client se reconnecte à la session OpenTok. Vous pouvez empêcher cela en définissant le retryAfterReconnect paramètre à false. (La valeur par défaut est true.)

Voir aussi : : - sendSignal(String type, String data) - Session.ReconnectionListener.onReconnecting(Session session) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void envoyerSignal(Chaîne type, Chaîne données, Connexion connexion)

Envoie un signal à un client spécifique au cours d'une session.

Voir aussi : : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void envoyerSignal(Chaîne type, Chaîne données, Connexion connexion, booléen retryAfterReconnect)

Envoie un signal à un client spécifique au cours d'une session. Cette version de la méthode inclut un retryAfterReconnect paramètre.

Paramètres : : type - Le type du signal. Le type est également défini dans le Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) méthode. : data - Les données à envoyer. La taille maximale des données est de 8 ko. : connection - Un objet Connection. L'objet Connection représente la connexion d'un client à la session. Il s'agit du client auquel le message est envoyé. (Voir Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) et Connection. : retryAfterReconnect - Lors de la reconnexion à la session, faut-il envoyer les signaux qui ont été déclenchés pendant la déconnexion ? Si votre client perd sa connexion à la session OpenTok, en raison d'une interruption de la connexion réseau, le client tente de se reconnecter à la session, et le Session.ReconnectionListener.onReconnecting(Session session) méthode est appelée. Par défaut, les signaux générés pendant la déconnexion sont envoyés lorsque (et si) le client se reconnecte à la session OpenTok. Vous pouvez empêcher cela en définissant le retryAfterReconnect paramètre à false. (La valeur par défaut est true.)

Voir aussi : : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

getCapabilities

public Session.Capacités getCapabilities()

Indique si le client peut publier et s'abonner à des flux au cours de la session, en fonction du rôle attribué au jeton utilisé pour se connecter à la session. Cette méthode renvoie null jusqu'à ce que vous soyez connecté à une session et que le Session.SessionListener.onConnected(Session session) La méthode a été appelée.

signaler un problème

public Chaîne reportIssue()

Signalez un problème rencontré avec votre application. Vous pouvez utiliser l'identifiant du problème avec le Inspecteur ou lorsque vous abordez un problème avec l'équipe d'assistance de TokBox.

Résultats : : L'identifiant associé au problème.

forceDisconnect

public void forceDisconnect(@NonNull Connexion connexion)

Force un client à se déconnecter de la session. Bien que vous puissiez utiliser forceDisconnect(Connection) Pour mettre fin à votre connexion, il est plus simple d'appeler la méthode « disconnect ». Une erreur est renvoyée si le rôle du client ne dispose pas des autorisations nécessaires pour forcer la déconnexion d'autres utilisateurs. Vous définissez le rôle d'un client lors de la création du jeton utilisateur. Lorsqu'une connexion est interrompue à l'aide de cette méthode, Session.SessionListener.onDisconnected(Session), onConnectionDestroyed(Connection) et PublisherKit.onStreamDestroyed(Stream) Les fonctions de rappel sont déclenchées de la même manière que si la connexion s'était terminée d'elle-même à l'aide de disconnect().

Paramètres : : connection - La connexion à déconnecter.

forceMuteStream

public void forceMuteStream(@NonNull Flux flux)

Force l'éditeur d'un flux spécifié à couper le son.

Vérifier le canForceMute propriété de l'objet renvoyé par l'appel de getCapabilities() pour vérifier si vous pouvez appeler cette fonction sans problème. Cette fonctionnalité est réservée aux clients connectés à l'aide d'un jeton auquel a été attribué le rôle de modérateur (voir la Création de jetons (documentation).

Paramètres : : stream - L'objet représentant le flux concerné par la demande de mise en sourdine forcée. Cela inclut le flux qui doit être mis en sourdine.

Voir aussi : : - getCapabilities() - forceMuteAll(Iterable) - PublisherKit.onMuteForced() - Couper le son des flux vidéo dans une session

forceMuteAll

public void forceMuteAll(@Nullable Itérable<Flux> excludedStreams)

Oblige tous les diffuseurs de la session (à l'exception de ceux qui diffusent des flux exclus) à couper le son.

De même, tous les flux publiés après l'appel à la fonction forceMuteAll() méthode sont publiées avec le son désactivé. Vous pouvez désactiver la mise en sourdine d'une session en appelant la disableForceMute() méthode. Une fois que vous avez appelé la disableForceMute() Grâce à cette méthode, le son des nouveaux flux publiés dans la session ne sera plus coupé.

L'appel de cette méthode provoque la Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) méthode à appeler dans chaque client connecté à la session, avec la getActive() méthode de la info objet renvoyé true.

Paramètres : : excludedStreams - L'objet qui représente les flux à exclure de la demande de mise en sourdine forcée. Cela inclut le flux qui ne doit pas être mis en sourdine.

Voir aussi : : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - disableForceMute() - forceMuteStream(Stream stream) - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - PublisherKit.onMuteForced() - Couper le son des flux vidéo dans une session

disableForceMute

public void désactiverLaMiseEnSourdineForcée()

Désactive l'état de sourdine actif de la session. Une fois cette méthode appelée, les nouveaux flux publiés sur la session ne seront plus en sourdine.

Après avoir appelé le forceMuteAll(Iterable) méthode (ou lorsqu'un modérateur d'un autre client lance une commande pour couper le son de tous les flux), tous les flux publiés après cette commande de modération sont diffusés avec le son coupé. Appelez la disableForceMute() méthode permettant de désactiver la mise en sourdine d'une session (afin que les nouveaux flux publiés ne soient pas automatiquement mis en sourdine).

L'appel de cette méthode provoque la Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) méthode à appeler, avec le getActive() de la méthode info objet renvoyant false.

Voir aussi : : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - forceMuteAll(Iterable) - Couper le son des flux vidéo dans une session

définir le secret de chiffrement

public void setEncryptionSecret(Chaîne (secret)

Définit la clé de chiffrement de bout en bout utilisée par tous les éditeurs et abonnés.

Voir le Guide du développeur sur le chiffrement de bout en bout.

Paramètres : : secret - Valeur de la clé de chiffrement.

onArchiveStarted

protected void onArchiveStarted(Chaîne id, Chaîne nom)

Appelée lorsqu'un enregistrement de la session commence. En réponse à cette méthode, vous pourriez souhaiter ajouter une notification dans l'interface utilisateur (telle qu'une icône dans la vue Éditeur) indiquant que la session est en cours d'enregistrement.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onArchiveStarted() méthode de l'interface Session.ArchiveListener .

Paramètres : : id - L'identifiant unique de l'archive. : name - Le nom de l'archive (si celui-ci a été indiqué lors de sa création).

onArchiveStopped

protected void onArchiveStopped(Chaîne id)

Appelée lorsqu'un enregistrement de la session cesse. En réponse à cette méthode, vous pouvez supprimer une notification de l'interface utilisateur (telle qu'une icône dans la vue Éditeur) indiquant que l'enregistrement de la session s'est arrêté.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onArchiveStopped() méthode de l'interface Session.ArchiveListener .

Paramètres : : id - L'identifiant unique de l'archive.

onStreamHasAudioChanged

protected void onStreamHasAudioChanged(Flux stream, int hasAudio)

Appelée lorsqu'un flux de la session passe d'un état avec audio à un état sans audio.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamHasAudioChanged() méthode de l'interface Session.StreamPropertiesListener .

Paramètres : : stream - Le ruisseau. : hasAudio - Si le flux contient du son (true) ou non ( false).

onStreamHasCaptionsChanged

protected void onStreamHasCaptionsChanged(Flux stream, int hasCaptions)

Appelée lorsqu'un flux de la session passe d'un état avec sous-titres à un état sans sous-titres.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamHasCaptionsChanged() méthode de l'interface Session.StreamPropertiesListener .

Paramètres : : stream - Le ruisseau. : hasCaptions - Si le flux dispose de sous-titres (true) ou non ( false).

onStreamHasVideoChanged

protected void onStreamHasVideoChanged(Flux flux, int aVidéo)

Appelée lorsqu'un flux de la session passe d'un état avec vidéo à un état sans vidéo.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamHasVideoChanged() méthode de l'interface Session.StreamPropertiesListener .

Paramètres : : stream - Le ruisseau. : hasVideo - Si le flux contient de la vidéo (true) ou non ( false).

onStreamVideoDimensionsChanged

protected void onStreamVideoDimensionsChanged(Flux stream, int width, int height)

Appelée lorsque les dimensions vidéo d'un flux de la session changent.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamVideoDimensionsChanged() méthode de l'interface Session.StreamPropertiesListener .

Paramètres : : stream - Le ruisseau. : width - La nouvelle largeur du flux, en pixels. : height - La nouvelle hauteur du flux, en pixels.

onStreamVideoTypeChanged

protected void onStreamVideoTypeChanged(Flux flux, int typeVidéo)

Appelée lorsque le type de vidéo d'un flux de la session change.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamVideoTypeChanged() méthode de l'interface Session.StreamPropertiesListener .

Paramètres : : stream - Le ruisseau. : videoType - Le nouveau type de vidéo du flux.

onConnectionCreated

protected void onConnectionCreated(Connexion connexion)

Appelée lorsque un autre le client se connecte à la session. L' objet `Connection` représente la connexion du client à la session. Notez que cette méthode est appelée lorsque autre les clients se connectent à la session. Lorsque votre propre lorsqu'un client se connecte, le Session.SessionListener.onConnected(Session session) La méthode est appelée.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onConnectionCreated() méthode de l'interface `Session.ConnectionListener` .

Paramètres : : connection - La nouvelle connexion dans la session.

onConnectionDestroyed

protected void onConnectionDestroyed(Connexion connexion)

Cette méthode est appelée lorsqu'un autre client quitte la session. L'objet Connection représente la connexion précédente du client à la session. Lorsque votre propre le client se déconnecte, le Session.SessionListener.onDisconnected(Session session) la méthode est appelée.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onConnectionDestroyed() méthode de l'interface `Session.ConnectionListener` .

Paramètres : : connection - La connexion qui a quitté la session.

onSignalReceived

protected void onSignalReceived(Chaîne type, Chaîne données, Connexion connexion)

Appelée lorsqu'un signal est reçu dans la session.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onSignalReceived() méthode de l'interface `Session.SignalListener` .

Paramètres : : type - La chaîne de caractères indiquant le type du signal. : data - Les données du signal. : connection - La connexion identifiant le client qui a envoyé le message. Cette valeur peut être null.

Réétablissement de la connexion

protected void onReconnecting()

Cet événement est déclenché lorsque le client local a perdu sa connexion à une session OpenTok et tente de se reconnecter. Cela résulte d'une perte de connectivité réseau. Si le client parvient à se reconnecter à la session, le Session.ReconnectionListener.onReconnected(Session session) méthode est appelée. Sinon, si le client ne parvient pas à se reconnecter, le Session.SessionListener.onDisconnected(Session session) est appelée.

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.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onReconnecting() méthode de l'interface `Session.ReconnectionListener` .

Voir aussi : : - onReconnected()

onReconnected

protected void onReconnected()

Cette méthode est appelée lorsque le client local s'est reconnecté à la session OpenTok après une perte temporaire de connexion réseau. Lorsque la connexion est perdue, le Session.ReconnectionListener.onReconnecting(Session session) la méthode est appelée, avant la Session.ReconnectionListener.onReconnected(Session session) méthode. Si le client ne parvient pas à se reconnecter à la session, le Session.SessionListener.onDisconnected(Session session) est appelée.

Tous les éditeurs et abonnés existants sont automatiquement reconnectés lorsque le client se reconnecte et que cette méthode est appelée.

Par défaut, tous les signaux émis par le client local à l'aide de la fonction sendSignal(String type, String data) Les signaux de cette méthode sont envoyés lorsque le client se reconnecte. Pour empêcher l'envoi des signaux déclenchés pendant la déconnexion, utilisez la sendSignal(String type, String data, boolean retryAfterReconnect) méthode permettant d'envoyer le signal, puis définir le retryAfterReconnect paramètre à false. (Tous les signaux envoyés par d'autres clients pendant que votre client était déconnecté sont reçus lors de la reconnexion.)

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onReconnected() méthode de l'interface `Session.ReconnectionListener` .

Voir aussi : : - onReconnecting()

onConnected

protected void onConnected()

Appelée lorsque le client se connecte à la session OpenTok.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onConnected() méthode de l'interface `Session.SessionListener` .

onDisconnected

protected void onDisconnected()

Appelée lorsque le client n'est plus connecté à la session OpenTok. »

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onDisconnected() méthode de l'interface `Session.SessionListener` .

onStreamReceived

protected void onStreamReceived(Flux flux)

Appelé lorsqu'un nouveau flux est publié par un autre client dans cette session OpenTok.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamReceived() méthode de l'interface `Session.SessionListener` .

Paramètres : : stream - Un objet `Stream` représentant le nouveau flux, qui peut être utilisé pour créer un `Subscriber`.

onStreamDropped

protected void onStreamDropped(Flux flux)

Appelée lorsque un autre le client cesse de diffuser un flux vers cette session OpenTok.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onStreamDropped() méthode de l'interface `Session.SessionListener` .

Paramètres : : stream - Un objet `Stream` représentant le flux interrompu, qui peut être utilisé pour identifier un abonné.

onError

protected void onError(OpentokError erreur)

Appelée lorsqu'un problème survient lors de la connexion ou une fois connecté à la session. Une fois cette méthode appelée, la session doit être considérée comme inactif et indisponible. Ne tentez pas de vous reconnecter ni d'appeler d'autres méthodes de l'objet Session.

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 en raison d'une erreur après une connexion réussie ; dans ce cas, la méthode est appelée juste avant la Session.SessionListener.onDisconnected(Session session) est appelée.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onError() méthode de l'interface `Session.SessionListener` .

Paramètres : : error - Une erreur indiquant la cause de l'erreur.

onMuteForced

protected void onMuteForced(MuteForcedInfo (info)

Déclenché lorsqu'un modérateur coupe le son des flux de la session ou désactive l'état « son coupé » dans la session.

Si vous étendez la classe `Session`, vous pouvez redéfinir cette méthode à la place de la onMuteForced() méthode de l'interface Session.MuteListener.

Paramètres : : info - Appelez le getActive méthode de cet objet permettant de déterminer si le modérateur a coupé le son des flux de la session (true) ou a désactivé le mode « muet » dans la session (false).

Voir aussi : : - forceMuteAll(Iterable) - disableForceMute() - onMuteForced(MuteForcedInfo) - PublisherKit.onMuteForced() - Couper le son des flux vidéo dans une session

finaliser

protected void finalize() throws À lancer

Appelée par le ramasse-miettes lorsqu'il détecte qu'il n'y a plus de références à l'objet Session.

Remplacements : : finalize en classe Object

Lancers : : Throwable