Représente une session de la Video API Vonage. Utilisez la OpenTok.CreateSession de la méthode OpenTok classe pour créer une session Video API Vonage. Utilisez la propriété Id de la Session objet permettant d'obtenir l'identifiant de session. En savoir plus...
| Fonctions publiques accessibles aux membres | |
| chaîne de caractères | GenerateToken (Rôle rôle=Rôle.ÉDITEUR, double expireTime = 0, string data = null, List<string> initialLayoutClassList = null) |
| Crée un jeton permettant de se connecter à une session de la Video API. Pour qu'un utilisateur puisse s'authentifier lorsqu'il se connecte à une session de la Video API, il doit fournir un jeton d'authentification en plus de la clé API. En savoir plus... |
| Propriétés | |
| chaîne de caractères | Id [get, set] |
| L'identifiant de session, qui identifie de manière unique la session. En savoir plus... | |
| int | ApiKey [get] |
| Votre clé Video API Vonage. En savoir plus... | |
| chaîne de caractères | ApiSecret [get] |
| Votre clé secrète de la Video API Vonage. En savoir plus... | |
| chaîne de caractères | Lieu [get, set] |
| L'adresse IP indiquant la localisation. En savoir plus... | |
| MediaMode | MediaMode [get] |
| Détermine si la session transmettra des flux à l'aide du routeur multimédia de la Video API Vonage (MediaMode.ROUTED) ou tenter de transmettre des flux directement entre clients (MediaMode.RELAYED). En savoir plus... | |
| Mode archive | Mode archive [get] |
| Détermine si la session est automatiquement archivée (ArchiveMode.ALWAYS) ou non (ArchiveMode.MANUAL). En savoir plus... |
Description détaillée
Représente une session de la Video API Vonage. Utilisez la OpenTok.CreateSession de la méthode OpenTok classe pour créer une session Video API Vonage. Utilisez la propriété Id de la Session objet permettant d'obtenir l'identifiant de session.
Documentation sur les fonctions de membre
GenerateToken()
| chaîne OpenTokSDK.Session.GenerateToken | ( | Rôle | rôle = Role.PUBLISHER, |
| double | expireTime = 0, |
||
| chaîne de caractères | données = null, |
||
| List< string > | liste des classes de mise en page initiale = null |
||
| ) |
Crée un jeton permettant de se connecter à une session de la Video API. Pour qu'un utilisateur puisse s'authentifier lorsqu'il se connecte à une session de la Video API, il doit fournir un jeton d'authentification en plus de la clé API.
Paramètres : | | | | --- | --- | | rôle | Le rôle associé au jeton. Les valeurs valides sont définies dans l'énumération « Role » : - Rôle.ABONNÉ Un abonné ne peut s'abonner qu'à des flux. - Rôle.ÉDITEUR Un éditeur peut publier des flux, s'abonner à des flux et envoyer des signaux. (Il s'agit de la valeur par défaut si vous ne spécifiez pas de rôle.) - Rôle : MODÉRATEUR Outre les privilèges accordés à un éditeur, dans les clients utilisant la bibliothèque OpenTok.js, un modérateur peut appeler les méthodes `forceUnpublish()` et `forceDisconnect()` de la Session objet. | | expireTime | Durée d'expiration du jeton, en secondes depuis l'époque UNIX. Indiquez 0 pour utiliser la durée d'expiration par défaut, soit 24 heures après la création du jeton. La durée d'expiration maximale est de 30 jours après la création du jeton. | | data | Une chaîne de caractères contenant les métadonnées de connexion décrivant l’utilisateur final. Par exemple, vous pouvez passer l’identifiant de l’utilisateur, son nom ou d’autres données le décrivant. La longueur de la chaîne est limitée à 1 000 caractères. Ces données ne peuvent pas être mises à jour une fois définies. | | initialLayoutClassList | |
Valeur renvoyée : La chaîne de caractères du jeton.
Documentation relative aux biens immobiliers
ApiKey
| --- | int OpenTokSDK.Session.ApiKey |
Votre clé Video API Vonage.
ApiSecret
| --- | chaîne OpenTokSDK.Session.ApiSecret |
Votre clé secrète de la Video API Vonage.
Mode archive
| --- | Mode archive OpenTokSDK.Session.ArchiveMode |
Détermine si la session est automatiquement archivée (ArchiveMode.ALWAYS) ou non (ArchiveMode.MANUAL).
Id
| --- | chaîne OpenTokSDK.Session.Id |
L'identifiant de session, qui identifie de manière unique la session.
Lieu
| --- | chaîne OpenTokSDK.Session.Location |
L'adresse IP indiquant la localisation.
MediaMode
| --- | MediaMode OpenTokSDK.Session.MediaMode |
Détermine si la session transmettra des flux à l'aide du routeur multimédia de la Video API Vonage (MediaMode.ROUTED) ou tenter de transmettre des flux directement entre clients (MediaMode.RELAYED).