Conforme à NSObject
Déclaré dans OTSession.h

Vue d'ensemble

Permet d'envoyer des messages à une instance OTSession. La classe OTSession comprend un delegate propriété. Lorsque vous envoyez le [OTSession initWithApiKey:sessionId:delegate:] message, vous spécifiez un objet OTSessionDelegate.

Connexion à une session

– sessionDidConnect: méthode obligatoire

Envoyé lorsque le client se connecte à la session.

- (void)sessionDidConnect:(nonnull OTSession *)session

Paramètres
session Les OTSession l'instance qui a envoyé ce message.

Déclaré à

OTSession.h

– sessionDidDisconnect: méthode obligatoire

Envoyé lorsque le client se déconnecte de la session.

- (void)sessionDidDisconnect:(nonnull OTSession *)session

Paramètres
session Les OTSession l'instance qui a envoyé ce message.

Déclaré à

OTSession.h

– session:didFailWithError: méthode obligatoire

Ce message est envoyé si la tentative de connexion à la session échoue ou si la connexion à la session est interrompue en raison d'une erreur après une connexion réussie.

- (void)session:(nonnull OTSession *)session didFailWithError:(nonnull OTError *)error

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
error Un OTError objet décrivant le problème. Le OTSessionErrorCode Une énumération définit les valeurs de la code propriété de cet objet.

Discussion

Ce message est envoyé après l'appel de votre application [OTSession connectWithToken:error:].

Si ce message est envoyé parce que la connexion à la session est interrompue après une connexion réussie, le message est envoyé juste avant la [OTSessionDelegate sessionDidDisconnect:] est envoyé.

Déclaré à

OTSession.h

Suivi des flux au cours d'une session

– session:streamCreated: méthode obligatoire

Envoyé lorsqu'un nouveau flux est créé au cours de cette session.

- (void)session:(nonnull OTSession *)session streamCreated:(nonnull OTStream *)stream

Paramètres
session L'instance OTSession qui a envoyé ce message.
stream Le flux associé à cet événement.

Discussion

Notez que si votre application publie vers cette session, votre propre délégué de session ne recevra pas le message [OTSessionDelegate session:streamCreated:] pour son propre flux publié. Pour cet événement, consultez la fonction de rappel du délégué [OTPublisherKitDelegate publisher:streamCreated:].

Déclaré à

OTSession.h

– session:streamDestroyed: méthode obligatoire

Envoyé lorsqu'un flux n'est plus publié vers la session.

- (void)session:(nonnull OTSession *)session streamDestroyed:(nonnull OTStream *)stream

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
stream Le flux associé à cet événement.

Déclaré à

OTSession.h

Suivi des connexions au cours d'une session

– session:connectionCreated:

Envoyé lorsqu'un autre client se connecte à la session. Le connection objet représente la connexion du client.

- (void)session:(nonnull OTSession *)session connectionCreated:(nonnull OTConnection *)connection

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
connection Le nouveau OTConnection objet.

Discussion

Ce message n'est pas envoyé lorsque votre propre client se connecte à la session. À la place, le [OTSessionDelegate sessionDidConnect:] Ce message est envoyé lorsque votre propre client se connecte à la session.

Déclaré à

OTSession.h

– session:connectionDestroyed:

Envoyé lorsqu'un autre client se déconnecte de la session. Le connection Cet objet représente la connexion que le client avait établie avec la session.

- (void)session:(nonnull OTSession *)session connectionDestroyed:(nonnull OTConnection *)connection

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
connection Les OTConnection objet correspondant au client qui s'est déconnecté de la session.

Discussion

Ce message n'est pas envoyé lorsque votre propre client se déconnecte de la session. À la place, le [OTSessionDelegate sessionDidDisconnect:] Ce message est envoyé lorsque votre propre client se connecte à la session.

Déclaré à

OTSession.h

– session:receivedSignalType:fromConnection:withString:

Envoyé lorsqu'un message est reçu dans la session.

- (void)session:(nonnull OTSession *)session receivedSignalType:(NSString *_Nullable)type fromConnection:(OTConnection *_Nullable)connection withString:(NSString *_Nullable)string

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
type La chaîne de caractères indiquant le type du signal.
connection La connexion identifiant le client qui a envoyé le message. Cette valeur peut être nil.
string Les données du signal.

Déclaré à

OTSession.h

Suivi des événements d'archivage

– session:archiveStartedWithId:name:

Envoyé au début de l'enregistrement d'une session. Si vous vous connectez à une session dont l'enregistrement est déjà en cours, ce message est envoyé lorsque vous vous connectez.

- (void)session:(nonnull OTSession *)session archiveStartedWithId:(nonnull NSString *)archiveId name:(NSString *_Nullable)name

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
archiveId L'identifiant unique de l'archive.
name Le nom de l'archive (s'il a été indiqué lors de sa création).

Discussion

En réponse à ce message, vous pouvez ajouter une notification dans l'interface utilisateur (par exemple, une icône dans la vue Éditeur) indiquant que la session est en cours d'enregistrement.

Pour plus d'informations, consultez le site OpenTok Vue d'ensemble de l'archivage.

Déclaré à

OTSession.h

– session:archiveStoppedWithId:

Envoyé à la fin d'un enregistrement d'archive d'une session.

- (void)session:(nonnull OTSession *)session archiveStoppedWithId:(nonnull NSString *)archiveId

Paramètres
session Les OTSession l'instance qui a envoyé ce message.
archiveId L'identifiant unique de l'archive.

Discussion

En réponse à ce message, vous pouvez modifier ou supprimer une notification de l'interface utilisateur (telle qu'une icône dans la vue Éditeur) qui indique que la session est en cours d'enregistrement.

Pour plus d'informations, consultez le site OpenTok Vue d'ensemble de l'archivage.

Déclaré à

OTSession.h

Se reconnecter à une session

– sessionDidBeginReconnecting:

Envoyé 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 [OTSessionDelegate sessionDidReconnect:] le message est envoyé. Sinon, si le client ne parvient pas à se reconnecter, le [OTSessionDelegate sessionDidDisconnect:] Le message est envoyé.

- (void)sessionDidBeginReconnecting:(nonnull OTSession *)session

Paramètres
session Les OTSession l'instance qui a envoyé ce message.

Discussion

En réponse à l'envoi de ce message, 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.

Déclaré à

OTSession.h

– sessionDidReconnect:

Envoyé 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 [OTSessionDelegate sessionDidBeginReconnecting:] le message est envoyé, avant le [OTSessionDelegate sessionDidReconnect:] message. Si le client ne parvient pas à se reconnecter à la session, le [OTSessionDelegate sessionDidDisconnect:] est envoyé.

- (void)sessionDidReconnect:(nonnull OTSession *)session

Paramètres
session Les OTSession l'instance qui a envoyé ce message.

Discussion

Les éditeurs et abonnés existants sont automatiquement reconnectés lorsque le client se reconnecte et que ce message est envoyé.

Par défaut, tous les signaux déclenchés par le client local à l'aide de la fonction [OTSession signalWithType:string:connection:error:] 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 [OTSession signalWithType:string:connection:retryAfterReconnect:error:] méthode permettant d'envoyer le signal, puis définir le retryAfterReconnect paramètre à NO. (Tous les signaux envoyés par d'autres clients pendant que votre client était déconnecté sont reçus lors de la reconnexion.)

Voir [OTSessionDelegate sessionDidBeginReconnecting:].

Déclaré à

OTSession.h

Suivi des changements d'état de sourdine

– session:muteForced:

Envoyé lorsqu'un modérateur coupe le son des flux de la session ou désactive le mode « son coupé » dans la session.

- (void)session:(nonnull OTSession *)session muteForced:(nonnull OTMuteForcedInfo *)muteForcedInfo

Paramètres
session La séance.
muteForcedInfo Vérifier le active propriété de cet objet. Lorsqu'elle est définie sur YES, le modérateur a désactivé le son des flux de la session. Lorsque cette option est réglée sur NO, un modérateur a désactivé le mode « muet » dans la session.

Discussion

Voir [OTSession forceMuteAll:error:], [Fonctionnalités d'OTSession], [OTPublisherKitDelegate muteForced:]et Couper le son des flux audio d'une session.

Déclaré à

OTSession.h