Représente une session de la Video API Vonage à laquelle le client participe. En savoir plus...

Hérite de l'interface IDisposable.

Description détaillée

Représente une session de la Video API Vonage à laquelle le client participe.

La première étape pour utiliser le SDK Windows de la Video API Vonage consiste à instancier un Session objet à l'aide de la Session.Builder classe.

Les Session La classe implémente l'interface System.IDisposable. Veillez à appeler la méthode Dispose() de la méthode Session libérer les ressources de l'objet lorsque vous n'en avez plus besoin (par exemple, lors de la fermeture de l'application ou de la fenêtre).

Voir aussi Création de la session et Création de jetons.

Documentation sur les fonctions de membre

Connect()

Se connecte à la session de la Video API Vonage fournie dans le Session constructeur, en utilisant le jeton d'authentification fourni.

Lorsque la session est établie, le Session L'objet envoie le Connecté événement.

Si la session ne parvient pas à se connecter, le Session L'objet envoie le Erreur événement.

Paramètres : | | | | --- | --- | | token | Le jeton de l'utilisateur. Voir Aperçu de la création de jetons. |

DisableForceMute()

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 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 objet dans chaque client connecté à la session pour envoyer le MuteForced avec l'événement IsActive de la propriété MuteForcedEventArgs objet à définir sur false.

Vérifier le CanForceMute de la propriété Session.Capacités objet pour vérifier si vous pouvez appeler cette fonction correctement. Cette fonctionnalité est réservée aux clients connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Présentation de la création de jetons).

Voir Désactiver l'audio des flux dans une session.

Voir aussi : Capacités, ForceMuteAll, MuteForced

Disconnect()

Se déconnecte de cette session. Tout Abonné et Éditeur les instances seront déconnectées.

Il est recommandé, avant d'appeler cette méthode, d'appeler la méthode Retirer de la publication (Éditeur) méthode pour tous les éditeurs et attendre la Publisher.StreamDestroyed événement. 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 envoie le Déconnecté événement.

ForceDisconnect()

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

Bien que vous puissiez utiliser la méthode `ForceDisconnect` pour mettre fin à votre propre connexion, il est plus simple d'appeler la méthode `Disconnect`. Une erreur sera renvoyée si le rôle de l'utilisateur ne dispose pas des autorisations nécessaires pour forcer d'autres utilisateurs à se déconnecter. Vous définissez le rôle d'un utilisateur lors de la création de son jeton.

Lorsqu'une connexion est fermée à l'aide de cette méthode, le Déconnecté, Connexion interrompue et les événements Publisher.StramDestroyed sont déclenchés de la même manière que si la connexion avait été interrompue à l'aide de la méthode Disconnect.

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

ForceMuteAll()

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() sont publiées avec le son coupé. Vous pouvez supprimer l'état de sourdine d'une session en appelant la méthode DisableForceMute() méthode. Une fois que vous avez appelé la DisableForceMute() les nouveaux flux publiés dans la session n'auront plus le son coupé.

L'appel de cette méthode provoque la Session objet dans chaque client connecté à la session pour envoyer le MuteForced avec l'événement IsActive de la propriété MuteForcedEventArgs objet à définir sur true.

Vérifier le CanForceMute de la propriété Session.Capacités objet pour vérifier si vous pouvez appeler cette fonction correctement. Cette fonctionnalité est réservée aux clients connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Présentation de la création de jetons).

Voir Désactiver l'audio des flux dans une session.

Paramètres : | | | | --- | --- | | excludedStreams | Flux à exclure de la demande de mise en sourdine. Définissez cette valeur sur null (ou ne définissez pas ce paramètre) pour mettre en sourdine tous les flux de la session (y compris ceux publiés par le client local). |

Voir aussi : Capacités, ForceMuteStream, DisableForceMute(), Session.MuteForced, Éditeur.MuteForced

ForceMuteStream()

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

Vérifier le CanForceMute de la propriété Session.Capacités objet pour vérifier si vous pouvez appeler cette fonction correctement. Cette fonctionnalité est réservée aux clients connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Présentation de la création de jetons).

Voir Désactiver l'audio des flux dans une session.

Paramètres : | | | | --- | --- | | flux | Le flux à mettre en sourdine. |

Voir aussi : Capacités, ForceMuteAll, Éditeur.MuteForced

Publier()

Lance un Éditeur diffusion en continu vers la session.

Paramètres : | | | | --- | --- | | éditeur | Le Éditeur que vous souhaitez diffuser en continu lors de la session. |

SendSignal()

Envoie un signal à tous les clients de la session.

Paramètres : | | | | --- | --- | | type | Le type du signal. Le type est défini dans le SignalEventArgs.Type argument de la Signal écouteur d'événement. | | données | Les données à envoyer. La taille maximale des données est de 8 ko. Le type est défini dans le SignalEventArgs.Data argument de la Signal écouteur d'événement. | | connexion | | | retryAfterReconnect | |

SetEncryptionSecret()

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

Voir le Cryptage de bout en bout guide du développeur.

Paramètres : | | | | --- | --- | | secret | Valeur du secret de chiffrement. |

S'abonner()

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

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

Unpublish()

Déconnecte le Éditeur de la séance.

Paramètres : | | | | --- | --- | | éditeur | Le Éditeur pour retirer la publication. |

Se désabonner()

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

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

Documentation relative à l'événement

Connexion créée

Envoyé lorsqu'un autre client se connecte à la session.

Les ConnectionEventArgs.Connection Cet objet 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 envoie le Connecté événement.

Connexion interrompue

Envoyé lorsqu'un autre client quitte la session.

Les ConnectionEventArgs.Connection L'objet représente la connexion précédente du client à la session. Notez que cette méthode est appelée lorsque autre les clients quittent la séance. Lorsque votre propre le client se déconnecte, le Session L'objet envoie le Connecté événement.

Erreur

Envoyé lorsqu'un problème survient lors de la connexion ou pendant la session.

Cet événement est déclenché si la tentative de connexion à la session échoue. Il est également déclenché si la connexion à la session est interrompue en raison d'une erreur après une connexion réussie ; dans ce cas, l'événement est déclenché juste avant la Déconnecté est envoyé.

Début de la reconnexion

Ce message est envoyé lorsque le client local a perdu sa connexion à une session de la Video API Vonage 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 L'objet envoie le Reconnexion réussie événement. Sinon, si le client ne parvient pas à se reconnecter, le Session L'objet envoie le Déconnecté événement.

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.

Voir aussi : Reconnexion réussie, Déconnecté

Reconnexion réussie

Cette méthode est appelée lorsque le client local s'est reconnecté à la session de la Video API après une perte temporaire de sa connexion réseau.

Lorsque la connexion est interrompue, le Session L'objet envoie le Session.ReconnectionStart événement, avant d'envoyer le Session.ReconnectionSuccess événement. Si le client ne parvient pas à se reconnecter à la session, le Session L'objet envoie le Session.Déconnecté événement.

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 déclenchés par le client local à l'aide de la fonction SendSignal(chaîne, chaîne, Connection, booléen) 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, définissez le retryAfterReconnect du paramètre SendSignal à la méthode false. (Tous les signaux envoyés par d'autres clients pendant que votre client était déconnecté sont reçus lors de la reconnexion.)

Voir aussi : Début de la reconnexion

StreamDropped

Envoyé le un autre le client cesse de diffuser un flux vers cette session de la Video API Vonage.

Les StreamEventArgs.Stream Cet objet représente un instantané du flux au moment de l'appel de retour. Il peut être utilisé pour identifier un Abonné (s'il y en a un).

StreamReceived

Envoyé lorsqu'un nouveau flux est publié par un autre client dans cette session de la Video API Vonage.

Les StreamEventArgs.Stream L'objet représente un instantané du flux au moment de l'appel de retour. Créez un Abonné et appeler le S'abonner (Abonné) méthode permettant de s'abonner au flux.