Contient des méthodes permettant de créer des sessions avec la Video API Vonage, de générer des jetons et d'utiliser les archives. En savoir plus...
| Fonctions publiques accessibles aux membres | |
| async Task< [AudioConnector] > | StartAudioConnectorAsync (AudioConnectorStartRequest demande) |
| Envoie le flux audio d'une session de la Video API Vonage vers un WebSocket. Pour plus d'informations, consultez la Guide du développeur Audio Connector. En savoir plus... | |
| async Task | StopAudioConnectorAsync (chaîne connectionId) |
| Interrompt la transmission audio pour une session de la Video API Vonage. En savoir plus... | |
| void | SetCustomUserAgent (valeur de chaîne) |
| Définit une valeur personnalisée pour l'agent utilisateur. HttpClient ajoutera cette valeur, si elle existe, à la valeur initiale de l'agent utilisateur. En savoir plus... | |
| OpenTok (int apiKey, string apiSecret) | |
| Crée un OpenTok objet. En savoir plus... | |
| OpenTok (int apiKey, string apiSecret, string apiUrl) | |
| À usage interne chez TokBox. En savoir plus... | |
| Session | Créer une session (chaîne location="", MediaMode mediaMode=MediaMode.RELAYED, Mode archive archiveMode=ArchiveMode.MANUAL, bool encryption=false, string archiveName="", [RenderResolution] archiveResolution=RenderResolution.StandardDefinitionLandscape) |
| Crée une nouvelle session de la Video API Vonage. En savoir plus... | |
| async Task< Session > | CreateSessionAsync (chaîne location="", MediaMode mediaMode=MediaMode.RELAYED, Mode archive archiveMode=ArchiveMode.MANUAL, bool encryption=false, string archiveName="", [RenderResolution] archiveResolution=RenderResolution.StandardDefinitionLandscape) |
| Crée une nouvelle session de la Video API Vonage. En savoir plus... | |
| chaîne de caractères | GenerateToken (chaîne sessionId, 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. Afin d'authentifier un utilisateur se connectant à une session de la Video API, le client transmet un jeton lors de la connexion à la session. En savoir plus... | |
| Archives | StartArchive (chaîne sessionId, chaîne name="", booléen hasVideo=true, booléen hasAudio=true, Mode de sortie outputMode=OutputMode.COMPOSED, chaîne « resolution=null », Mise en page des archives layout=null, StreamMode? streamMode=null, chaîne multiArchiveTag=null) |
| Lance l'archivage d'une session de la Video API Vonage. En savoir plus... | |
| async Task< Archives > | StartArchiveAsync (chaîne sessionId, chaîne name="", booléen hasVideo=true, booléen hasAudio=true, Mode de sortie outputMode=OutputMode.COMPOSED, chaîne « resolution=null », Mise en page des archives layout=null, StreamMode? streamMode=null, chaîne multiArchiveTag=null) |
| Lance l'archivage d'une session de la Video API Vonage. En savoir plus... | |
| Archives | StopArchive (chaîne archiveId) |
| Arrête un OpenTok l'archive en cours d'enregistrement. En savoir plus... | |
| async Task< Archives > | StopArchiveAsync (chaîne archiveId) |
| Arrête un OpenTok l'archive en cours d'enregistrement. En savoir plus... | |
| Liste des archives | Archives de la liste (int offset = 0, int count = 0, string sessionId = "") |
| Renvoie une liste de Archives des objets, représentant des archives à la fois terminées et en cours, pour votre clé API. En savoir plus... | |
| async Task< Liste des archives > | ListArchivesAsync (int offset = 0, int count = 0, string sessionId = "") |
| Renvoie une liste de Archives des objets, représentant des archives à la fois terminées et en cours, pour votre clé API. En savoir plus... | |
| Archives | GetArchive (chaîne archiveId) |
| Récupère un Archives objet correspondant à l'ID d'archive indiqué. En savoir plus... | |
| async Task< Archives > | GetArchiveAsync (chaîne archiveId) |
| Récupère un Archives objet correspondant à l'ID d'archive indiqué. En savoir plus... | |
| void | Supprimer l'archive (chaîne archiveId) |
| Supprime un OpenTok archives. En savoir plus... | |
| Tâche | DeleteArchiveAsync (chaîne archiveId) |
| Supprime un OpenTok archives. En savoir plus... | |
| void | Ajouter un flux à l'archive (string archiveId, string streamId, bool hasAudio=true, bool hasVideo=true) |
Ajoute un flux à une archive composée en cours d'exécution qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans les archives. En savoir plus... |
|
| Tâche | AddStreamToArchiveAsync (string archiveId, string streamId, bool hasAudio=true, bool hasVideo=true) |
Ajoute un flux à une archive composée en cours d'exécution qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans les archives. En savoir plus... |
|
| void | Supprimer un flux de l'archive (chaîne archiveId, chaîne streamId) |
Supprime un flux d'une archive composée qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. En savoir plus... |
|
| Tâche | RemoveStreamFromArchiveAsync (chaîne archiveId, chaîne streamId) |
Supprime un flux d'une archive composée qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. En savoir plus... |
|
| Flux | GetStream (chaîne sessionId, chaîne streamId) |
| Récupère un Flux objet correspondant à l'ID de flux indiqué. En savoir plus... | |
| async Task< Flux > | GetStreamAsync (chaîne sessionId, chaîne streamId) |
| Récupère un Flux objet correspondant à l'ID de flux indiqué. En savoir plus... | |
| Liste des flux | ListStreams (chaîne sessionId) |
| Renvoie une liste de Flux objets représentant des flux en cours pour l'identifiant de session. En savoir plus... | |
| async Task< Liste des flux > | ListStreamsAsync (chaîne sessionId) |
| Renvoie une liste de Flux objets représentant des flux en cours pour l'identifiant de session. En savoir plus... | |
| void | ForceDisconnect (chaîne sessionId, chaîne connectionId) |
| Forcer un client spécifique à se déconnecter d'une session de la Video API de Vonage. En savoir plus... | |
| async Task | ForceDisconnectAsync (chaîne sessionId, chaîne connectionId) |
| Forcer un client spécifique à se déconnecter d'une session de la Video API de Vonage. En savoir plus... | |
| Radiodiffusion | Lancer la diffusion (chaîne sessionId, booléen hls = true, Liste< RTMP > rtmpList=null, chaîne de caractères resolution=null, entier maxDuration=7200, BroadcastLayout layout=null, StreamMode? streamMode=null, bool dvr=false, bool? lowLatency=null, string multiBroadcastTag=null, bool hasAudio=true, bool hasVideo=true) |
| Utilisez cette méthode pour lancer une diffusion en direct pour une session de la Video API. Cela permet de diffuser la session via un flux HLS (HTTP Live Streaming) ou RTMP. En savoir plus... | |
| async Task< Radiodiffusion > | StartBroadcastAsync (chaîne sessionId, booléen hls = true, Liste< RTMP > rtmpList=null, chaîne de caractères resolution=null, entier maxDuration=7200, BroadcastLayout layout=null, StreamMode? streamMode=null, bool dvr=false, bool? lowLatency=null, string multiBroadcastTag=null, bool hasAudio=true, bool hasVideo=true) |
| Utilisez cette méthode pour lancer une diffusion en direct pour une session de la Video API. Cela permet de diffuser la session via un flux HLS (HTTP Live Streaming) ou RTMP. En savoir plus... | |
| Radiodiffusion | StopBroadcast (chaîne broadcastId) |
| Utilisez cette méthode pour interrompre la diffusion en direct d'une session de la Video API Vonage. Notez que les diffusions s'arrêtent automatiquement 120 minutes après leur début. En savoir plus... | |
| async Task< Radiodiffusion > | StopBroadcastAsync (chaîne broadcastId) |
| Utilisez cette méthode pour interrompre la diffusion en direct d'une session de la Video API Vonage. Notez que les diffusions s'arrêtent automatiquement 120 minutes après leur début. En savoir plus... | |
| Radiodiffusion | GetBroadcast (chaîne broadcastId) |
| Utilisez cette méthode pour obtenir un objet de diffusion en direct correspondant à une session de la Video API de Vonage. En savoir plus... | |
| async Task< Radiodiffusion > | GetBroadcastAsync (chaîne broadcastId) |
| Utilisez cette méthode pour obtenir un objet de diffusion en direct correspondant à une session de la Video API de Vonage. En savoir plus... | |
| void | SetBroadcastLayout (chaîne broadcastId, BroadcastLayout mise en page) |
| Définit le type de mise en page de la diffusion. Pour plus d'informations sur les types de mise en page, voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok. En savoir plus... | |
| async Task | SetBroadcastLayoutAsync (chaîne broadcastId, BroadcastLayout mise en page) |
| Définit le type de mise en page de la diffusion. Pour plus d'informations sur les types de mise en page, voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok. En savoir plus... | |
| bool | Définir la structure d'archivage (chaîne archiveId, Mise en page des archives mise en page) |
| Vous permet de modifier dynamiquement la mise en page d'une archive composée pendant son enregistrement. Voir Personnalisation de la présentation vidéo pour les archives composées pour plus d'informations sur la personnalisation d'une mise en page. En savoir plus... | |
| void | Ajouter un flux à la diffusion (string broadcastId, string streamId, bool hasAudio=true, bool hasVideo=true) |
Ajoute un flux à une diffusion en cours qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver le son ou la vidéo du flux dans la diffusion. En savoir plus... |
|
| Tâche | AddStreamToBroadcastAsync (string broadcastId, string streamId, bool hasAudio=true, bool hasVideo=true) |
Ajoute un flux à une diffusion en cours qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver le son ou la vidéo du flux dans la diffusion. En savoir plus... |
|
| void | Supprimer un flux de la diffusion (string broadcastId, string streamId) |
Supprime un flux d'une diffusion lancée à l'aide de la commande streamMode fixé à StreamMode.Manuel. En savoir plus... |
|
| Tâche | RemoveStreamFromBroadcastAsync (string broadcastId, string streamId) |
Supprime un flux d'une diffusion lancée à l'aide de la commande streamMode fixé à StreamMode.Manuel. En savoir plus... |
|
| async Task< bool > | SetArchiveLayoutAsync (chaîne archiveId, Mise en page des archives mise en page) |
| Vous permet de modifier dynamiquement la mise en page d'une archive composée pendant son enregistrement. Voir Personnalisation de la présentation vidéo pour les archives composées pour plus d'informations sur la personnalisation d'une mise en page. En savoir plus... | |
| void | Définir les listes de classes de flux (chaîne sessionId, Liste< Propriétés du flux > flux) |
| Définit la liste des classes de mise en page pour les flux d'une session. Les classes de mise en page sont utilisées dans la mise en page des archives composées et des diffusions en direct. Pour plus d'informations, consultez Personnalisation de la présentation vidéo pour les archives composées et Configuration de la disposition vidéo pour les diffusions en direct OpenTok. En savoir plus... | |
| async Task | SetStreamClassListsAsync (chaîne sessionId, Liste< Propriétés du flux > flux) |
| Définit la liste des classes de mise en page pour les flux d'une session. Les classes de mise en page sont utilisées dans la mise en page des archives composées et des diffusions en direct. Pour plus d'informations, consultez Personnalisation de la présentation vidéo pour les archives composées et Configuration de la disposition vidéo pour les diffusions en direct OpenTok. En savoir plus... | |
| void | Signal (chaîne sessionId, Propriétés du signal signalProperties, chaîne de caractères connectionId=null) |
| Envoie un signal aux clients (ou à un client spécifique) connectés à une session de la Video API de Vonage. En savoir plus... | |
| async Task | SignalAsync (chaîne sessionId, Propriétés du signal signalProperties, chaîne de caractères connectionId=null) |
| Envoie un signal aux clients (ou à un client spécifique) connectés à une session de la Video API de Vonage. En savoir plus... | |
| void | Définir le délai d'attente par défaut pour les requêtes (int timeout) |
| Définit le délai d'expiration par défaut (en millisecondes) pour toutes les requêtes WebRequest envoyées par le SDK En savoir plus... | |
| void | Lire le DTMF (chaîne sessionId, chaîne digits, chaîne connectionId = null) |
| Envoyer des chiffres DTMF à tous les participants d'une session active de la Video API de Vonage ou à un client spécifique connecté à cette session. En savoir plus... | |
| Tâche | Lire DTMF de manière asynchrone (chaîne sessionId, chaîne digits, chaîne connectionId = null) |
| Envoyer des chiffres DTMF à tous les participants d'une session active de la Video API de Vonage ou à un client spécifique connecté à cette session. En savoir plus... | |
| Buvre une gorgée | Cadran (chaîne sessionId, chaîne token, chaîne sipUri, Options de numérotation options=null) |
| Permet de connecter une plateforme SIP à une session de la Video API de Vonage. En savoir plus... | |
| async Task< Buvre une gorgée > | DialAsync (chaîne sessionId, chaîne token, chaîne sipUri, Options de numérotation options=null) |
| Permet de connecter une plateforme SIP à une session de la Video API de Vonage. En savoir plus... | |
| void | ForceMuteStream (chaîne sessionId, chaîne streamId) |
| Forcer l'éditeur d'un flux spécifique à couper le son de son contenu audio publié. En savoir plus... | |
| async Task | ForceMuteStreamAsync (chaîne sessionId, chaîne streamId) |
| Forcer l'éditeur d'un flux spécifique à couper le son de son contenu audio publié. En savoir plus... | |
| void | ForceMuteAll (chaîne sessionId, tableau de chaînes excludedStreamIds) |
| Force tous les flux (à l'exception d'une liste facultative de flux) d'une session à couper le son de l'audio publié. En savoir plus... | |
| async Task | ForceMuteAllAsync (chaîne sessionId, tableau de chaînes excludedStreamIds) |
| Force tous les flux (à l'exception d'une liste facultative de flux) d'une session à couper le son de l'audio publié. En savoir plus... | |
| void | DisableForceMute (chaîne sessionId) |
| 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. En savoir plus... | |
| async Task | DisableForceMuteAsync (chaîne sessionId) |
| 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. En savoir plus... | |
| async Task< [RenderItem] > | StartRenderAsync (Lancer une demande de rendu demande) |
| Lance un nouveau moteur de rendu Experience Composer pour une session de la Video API Vonage. En savoir plus... | |
| async Task | StopRenderAsync (chaîne renderId) |
| Arrête un moteur de rendu Experience Composer. En savoir plus... | |
| async Task< [ListRendersResponse] > | ListRendersAsync (ListRendersRequest demande) |
| Récupère tous les moteurs de rendu Experience Composer correspondant à la requête fournie. En savoir plus... | |
| async Task< [RenderItem] > | GetRenderAsync (chaîne renderId) |
| Récupère un moteur de rendu Experience Composer. En savoir plus... |
| Propriétés | |
| int | ApiKey [get] |
| La clé Video API Vonage transmise à la OpenTok() constructeur. En savoir plus... | |
| chaîne de caractères | ApiSecret [get] |
| La clé secrète de la Video API Vonage transmise à l' OpenTok() constructeur. En savoir plus... | |
| HttpClient | Client [get, set] |
| À usage interne En savoir plus... | |
| bool | Débogage [get, set] |
| Permet d'afficher les détails des requêtes et des réponses sur la console. À ne pas utiliser dans un environnement de production. En savoir plus... |
Description détaillée
Contient des méthodes permettant de créer des sessions avec la Video API Vonage, de générer des jetons et d'utiliser les archives.
Pour créer un nouveau OpenTok objet, appeler la OpenTok() constructor avec votre clé Video API Vonage et le secret API correspondant à votre Projet OpenTok. Ne divulguez pas votre clé secrète API. Vous l'utiliserez avec le OpenTok constructor (uniquement sur votre serveur web) pour créer des sessions de la Video API Vonage.
Documentation sur les constructeurs et les destructeurs
OpenTok() [1/2]
| OpenTokSDK.OpenTok.OpenTok | ( | int | apiKey, |
| chaîne de caractères | apiSecret | ||
| ) |
Crée un OpenTok objet.
Paramètres : | | | | --- | --- | | apiKey | Votre clé Video API Vonage. (Voir la Page d'account TokBox | | apiSecret | Votre clé secrète de la Video API Vonage. (Voir la Page d'account TokBox |
OpenTok() [2/2]
| OpenTokSDK.OpenTok.OpenTok | ( | int | apiKey, |
| chaîne de caractères | apiSecret, | ||
| chaîne de caractères | apiUrl | ||
| ) |
À usage interne chez TokBox.
Paramètres : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |
Documentation sur les fonctions de membre
AddStreamToArchive()
| void OpenTokSDK.OpenTok.AddStreamToArchive | ( | chaîne de caractères | archiveId, |
| chaîne de caractères | streamId, | ||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Ajoute un flux à une archive composée en cours d'exécution qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans les archives.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. | | streamId | L'identifiant du flux. | | hasAudio | Indique si l'archive générée doit inclure l'audio du flux (true, valeur par défaut) ou non (false). | | hasVideo | Indique si l'archive composée doit inclure la vidéo du flux (true, valeur par défaut) ou non (false). |
AddStreamToArchiveAsync()
| Tâche OpenTokSDK.OpenTok.AddStreamToArchiveAsync | ( | chaîne de caractères | archiveId, |
| chaîne de caractères | streamId, | ||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Ajoute un flux à une archive composée en cours d'exécution qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans les archives.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. | | streamId | L'identifiant du flux. | | hasAudio | Indique si l'archive générée doit inclure l'audio du flux (true, valeur par défaut) ou non (false). | | hasVideo | Indique si l'archive composée doit inclure la vidéo du flux (true, valeur par défaut) ou non (false). |
AddStreamToBroadcast()
| void OpenTokSDK.OpenTok.AddStreamToBroadcast | ( | chaîne de caractères | broadcastId, |
| chaîne de caractères | streamId, | ||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Ajoute un flux à une diffusion en cours qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver le son ou la vidéo du flux dans la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de la diffusion. | | streamId | L'identifiant du flux. | | hasAudio | Indique si la diffusion doit inclure l'audio du flux (true, valeur par défaut) ou non (false). | | hasVideo | Indique si la diffusion doit inclure la vidéo du flux (true, valeur par défaut) ou non (false). |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
AddStreamToBroadcastAsync()
| Tâche OpenTokSDK.OpenTok.AddStreamToBroadcastAsync | ( | chaîne de caractères | broadcastId, |
| chaîne de caractères | streamId, | ||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Ajoute un flux à une diffusion en cours qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver le son ou la vidéo du flux dans la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de la diffusion. | | streamId | L'identifiant du flux. | | hasAudio | Indique si la diffusion doit inclure l'audio du flux (true, valeur par défaut) ou non (false). | | hasVideo | Indique si la diffusion doit inclure la vidéo du flux (true, valeur par défaut) ou non (false). |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
CreateSession()
| Session OpenTokSDK.OpenTok.CreateSession | ( | chaîne de caractères | emplacement = "", |
| MediaMode | mediaMode = MediaMode.RELAYED, |
||
| Mode archive | archiveMode = ArchiveMode.MANUAL, |
||
| bool | chiffrement = false, |
||
| chaîne de caractères | nom_de_l'archive = "", |
||
| [Résolution de rendu] | résolution d'archivage = RenderResolution.StandardDefinitionLandscape |
||
| ) |
Crée une nouvelle session de la Video API Vonage.
Les sessions de la Video API Vonage n'expirent pas. En revanche, les jetons d'authentification ont une durée de validité limitée (voir la méthode generateToken()). Notez également qu'il n'est pas possible de fermer explicitement une session.
Une chaîne d'identification de session peut comporter jusqu'à 255 caractères.
L'appel de cette méthode génère une exception OpenTokException en cas d'erreur. Consultez le message d'erreur pour plus de détails.
Vous pouvez également créer une session à l'aide de la API REST d'OpenTok ou en vous connectant à votre Account TokBox.
Paramètres : | | | | --- | --- | | location | Une adresse IP que les serveurs de la Video API utiliseront pour localiser la session au sein de leur réseau mondial. Si vous ne définissez pas d’indication de localisation, les serveurs de la Video API se baseront sur le premier client se connectant à la session. | | mediaMode | Indique si la session transmettra des flux à l’aide du routeur multimédia de la Video API (MediaMode.ROUTED) ou non (MediaMode.RELAYED). Par défaut, le paramètre est MediaMode.RELAYED. Lorsque le paramètre est réglé sur MediaMode.RELAYED, la session tentera de transmettre les flux directement entre les clients. Si les clients ne parviennent pas à se connecter en raison de restrictions imposées par un pare-feu, la session utilise le OpenTok Configurer le serveur TURN pour relayer les flux. Le Routeur multimédia OpenTok offre les avantages suivants : - Le routeur multimédia de la Video API Vonage permet de réduire la consommation de bande passante lors des sessions multipartites. (Lorsque le mediaMode est fixé à MediaMode.ROUTED, chaque client doit envoyer un flux audio-vidéo distinct à chaque client qui s'y abonne.) - Le routeur multimédia de la Video API Vonage peut améliorer la qualité de l'expérience utilisateur grâce à repli audio et récupération vidéo Grâce à ces fonctionnalités, si la connexion d'un client se détériore au point de ne plus permettre la lecture de la vidéo d'un flux auquel il est abonné, la vidéo est interrompue pour ce client (sans affecter les autres clients), et celui-ci ne reçoit alors que le son. Si la connexion du client s'améliore, la vidéo reprend. - Le routeur multimédia de la Video API Vonage prend en charge le archivage fonctionnalité qui vous permet d'enregistrer, de sauvegarder et de récupérer des sessions de la Video API Vonage. | | archiveMode | Indique si la session est automatiquement archivée (ArchiveMode.ALWAYS) ou non (ArchiveMode.MANUAL). Par défaut, le paramètre est ArchiveMode.MANUAL et vous devez appeler le StartArchive de la méthode OpenTok objet à partir duquel démarrer l'archivage. Pour archiver la session (de manière automatique ou non), vous devez définir le paramètre mediaMode sur MediaMode.ROUTED | | chiffrement | Active chiffrement de bout en bout des données multimédias dans les sessions acheminées. | | archiveName | Nom des archives dans les sessions archivées automatiquement. Une session qui démarre avec le mode d'archivage « always » utilisera ce nom d'archive pour toutes les archives de cette session. Le fait de passer « archiveName » avec le mode d'archivage « manual » entraînera une réponse d'erreur. | | archiveResolution | Résolution des archives dans les sessions archivées automatiquement. Une session qui démarre avec le mode d'archivage « always » utilisera cette résolution pour toutes les archives de cette session. Le fait de passer « archiveResolution » avec le mode d'archivage « manual » entraînera une réponse d'erreur. |
Retours : A Session objet représentant la nouvelle session. Le Session.Id de la propriété Session Il s'agit de l'identifiant de session, qui identifie de manière unique la session. Vous utiliserez cet identifiant de session dans les SDK client pour identifier la session. Par exemple, lorsque vous utilisez la bibliothèque OpenTok.js, utilisez l'identifiant de session lors de l'appel de la méthode OT.initSession() méthode (pour initialiser une session de la Video API Vonage).
CreateSessionAsync()
| async Task<Session> OpenTokSDK.OpenTok.CreateSessionAsync | ( | chaîne de caractères | emplacement = "", |
| MediaMode | mediaMode = MediaMode.RELAYED, |
||
| Mode archive | archiveMode = ArchiveMode.MANUAL, |
||
| bool | chiffrement = false, |
||
| chaîne de caractères | nom_de_l'archive = "", |
||
| [Résolution de rendu] | résolution d'archivage = RenderResolution.StandardDefinitionLandscape |
||
| ) |
Crée une nouvelle session de la Video API Vonage.
Les sessions de la Video API Vonage n'expirent pas. En revanche, les jetons d'authentification ont une durée de validité limitée (voir la méthode generateToken()). Notez également qu'il n'est pas possible de fermer explicitement une session.
Une chaîne d'identification de session peut comporter jusqu'à 255 caractères.
L'appel de cette méthode génère une exception OpenTokException en cas d'erreur. Consultez le message d'erreur pour plus de détails.
Vous pouvez également créer une session à l'aide de la API REST d'OpenTok ou en vous connectant à votre Account TokBox.
Paramètres : | | | | --- | --- | | location | Une adresse IP que les serveurs de la Video API utiliseront pour localiser la session au sein de leur réseau mondial. Si vous ne définissez pas d’indication de localisation, les serveurs de la Video API se baseront sur le premier client se connectant à la session. | | mediaMode | Indique si la session transmettra des flux à l’aide du routeur multimédia de la Video API (MediaMode.ROUTED) ou non (MediaMode.RELAYED). Par défaut, le paramètre est MediaMode.RELAYED. Lorsque le paramètre est réglé sur MediaMode.RELAYED, la session tentera de transmettre les flux directement entre les clients. Si les clients ne parviennent pas à se connecter en raison de restrictions imposées par un pare-feu, la session utilise le OpenTok Configurer le serveur TURN pour relayer les flux. Le Routeur multimédia OpenTok offre les avantages suivants : - Le routeur multimédia de la Video API Vonage permet de réduire la consommation de bande passante lors des sessions multipartites. (Lorsque le mediaMode est fixé à MediaMode.ROUTED, chaque client doit envoyer un flux audio-vidéo distinct à chaque client qui s'y abonne.) - Le routeur multimédia de la Video API Vonage peut améliorer la qualité de l'expérience utilisateur grâce à repli audio et récupération vidéo Grâce à ces fonctionnalités, si la connexion d'un client se détériore au point de ne plus permettre la lecture de la vidéo d'un flux auquel il est abonné, la vidéo est interrompue pour ce client (sans affecter les autres clients), et celui-ci ne reçoit alors que le son. Si la connexion du client s'améliore, la vidéo reprend. - Le routeur multimédia de la Video API Vonage prend en charge le archivage fonctionnalité qui vous permet d'enregistrer, de sauvegarder et de récupérer des sessions de la Video API Vonage. | | archiveMode | Indique si la session est automatiquement archivée (ArchiveMode.ALWAYS) ou non (ArchiveMode.MANUAL). Par défaut, le paramètre est ArchiveMode.MANUAL et vous devez appeler le StartArchive de la méthode OpenTok objet à partir duquel démarrer l'archivage. Pour archiver la session (de manière automatique ou non), vous devez définir le paramètre mediaMode sur MediaMode.ROUTED | | chiffrement | Active chiffrement de bout en bout des données multimédias dans les sessions acheminées. | | archiveName | Nom des archives dans les sessions archivées automatiquement. Une session qui démarre avec le mode d'archivage « always » utilisera ce nom d'archive pour toutes les archives de cette session. Le fait de passer « archiveName » avec le mode d'archivage « manual » entraînera une réponse d'erreur. | | archiveResolution | Résolution des archives dans les sessions archivées automatiquement. Une session qui démarre avec le mode d'archivage « always » utilisera cette résolution pour toutes les archives de cette session. Le fait de passer « archiveResolution » avec le mode d'archivage « manual » entraînera une réponse d'erreur. |
Retours : A Session objet représentant la nouvelle session. Le Session.Id de la propriété Session Il s'agit de l'identifiant de session, qui identifie de manière unique la session. Vous utiliserez cet identifiant de session dans les SDK client pour identifier la session. Par exemple, lorsque vous utilisez la bibliothèque OpenTok.js, utilisez l'identifiant de session lors de l'appel de la méthode OT.initSession() méthode (pour initialiser une session de la Video API Vonage).
DeleteArchive()
| void OpenTokSDK.OpenTok.SupprimerArchive | ( | chaîne de caractères | archiveId | ) |
Supprime un OpenTok archives.
Vous ne pouvez supprimer qu'une archive dont le statut est « disponible » ou « téléchargée ». La suppression d'une archive entraîne la suppression de son entrée de la liste des archives. Dans le cas d'une archive « disponible », cela entraîne également la suppression du fichier d'archive, qui ne sera alors plus disponible au téléchargement.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive que vous souhaitez supprimer. |
DeleteArchiveAsync()
| Tâche OpenTokSDK.OpenTok.DeleteArchiveAsync | ( | chaîne de caractères | archiveId | ) |
Supprime un OpenTok archives.
Vous ne pouvez supprimer qu'une archive dont le statut est « disponible » ou « téléchargée ». La suppression d'une archive entraîne la suppression de son entrée de la liste des archives. Dans le cas d'une archive « disponible », cela entraîne également la suppression du fichier d'archive, qui ne sera alors plus disponible au téléchargement.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive que vous souhaitez supprimer. |
Dial()
| Buvre une gorgée OpenTokSDK.OpenTok.Dial | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | jeton, | ||
| chaîne de caractères | sipUri, | ||
| Options de numérotation | options = null |
||
| ) |
Permet de connecter une plateforme SIP à une session de la Video API de Vonage.
Pour plus d'informations, notamment sur les aspects techniques et les considérations de sécurité, consultez le Guide du développeur sur l'interconnexion SIP OpenTok.
Paramètres
: | | |
| --- | --- |
| sessionId | L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter. |
| token | Le jeton associé à l'identifiant de session que l'utilisateur SIP utilisera pour se connecter. |
| sipUri | L'URI SIP à utiliser comme destination de l'appel SIP lancé depuis OpenTok vers votre plateforme SIP. Si l'URI SIP contient un en-tête transport=tls, la négociation entre OpenTok et la connexion SIP s'effectuera de manière sécurisée. Notez que cela ne s'applique qu'à la négociation elle-même, et non à la transmission audio. Si vous souhaitez également que la transmission audio soit chiffrée, configurez le Secure propriété de la de la Options de numérotation objet transmis au paramètre « options » de true. Voici un exemple de configuration sipUri pour une négociation d'appel sécurisée : "sip:user@sip.partner.com;transport=tls". Voici un exemple de négociation d'appel non sécurisée : "sip:user@sip.partner.com". |
| options | Paramètres facultatifs pour la numérotation SIP. |
DialAsync()
| async Task<Buvre une gorgée> OpenTokSDK.OpenTok.DialAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | jeton, | ||
| chaîne de caractères | sipUri, | ||
| Options de numérotation | options = null |
||
| ) |
Permet de connecter une plateforme SIP à une session de la Video API de Vonage.
Pour plus d'informations, notamment sur les aspects techniques et les considérations de sécurité, consultez le Guide du développeur sur l'interconnexion SIP OpenTok.
Voir aussi OpenTok.Dial.
Paramètres
: | | |
| --- | --- |
| sessionId | L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter. |
| token | Le jeton associé à l'identifiant de session que l'utilisateur SIP utilisera pour se connecter. |
| sipUri | L'URI SIP à utiliser comme destination de l'appel SIP lancé depuis OpenTok vers votre plateforme SIP. Si l'URI SIP contient un en-tête transport=tls, la négociation entre OpenTok et la connexion SIP s'effectuera de manière sécurisée. Notez que cela ne s'applique qu'à la négociation elle-même, et non à la transmission audio. Si vous souhaitez également que la transmission audio soit chiffrée, configurez le Secure propriété de la de la Options de numérotation objet transmis au paramètre « options » de true. Voici un exemple de configuration sipUri pour une négociation d'appel sécurisée : "sip:user@sip.partner.com;transport=tls". Voici un exemple de négociation d'appel non sécurisée : "sip:user@sip.partner.com". |
| options | Paramètres facultatifs pour la numérotation SIP. |
DisableForceMute()
| void OpenTokSDK.OpenTok.DisableForceMute | ( | chaîne de caractères | sessionId | ) |
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, tous les flux publiés après l'appel le sont avec le son désactivé. 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.
Voir également le DisableForceMuteAsync méthode.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'identifiant de session n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
DisableForceMuteAsync()
| async Task OpenTokSDK.OpenTok.DisableForceMuteAsync | ( | chaîne de caractères | sessionId | ) |
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 ForceMuteAllAsync méthode, tous les flux publiés après l'appel le sont avec le son désactivé. Appelez la DisableForceMuteAsync() 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.
Voir également le DisableForceMute méthode.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'identifiant de session n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
ForceDisconnect()
| void OpenTokSDK.OpenTok.ForceDisconnect | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | connectionId | ||
| ) |
Forcer un client spécifique à se déconnecter d'une session de la Video API de Vonage.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. | | connectionId | L'identifiant de connexion de la connexion au sein d'une session. |
ForceDisconnectAsync()
| async Task OpenTokSDK.OpenTok.ForceDisconnectAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | connectionId | ||
| ) |
Forcer un client spécifique à se déconnecter d'une session de la Video API de Vonage.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. | | connectionId | L'identifiant de connexion de la connexion au sein d'une session. |
ForceMuteAll()
| void OpenTokSDK.OpenTok.ForceMuteAll | ( | chaîne de caractères | sessionId, |
| chaîne [] | excludedStreamIds | ||
| ) |
Force tous les flux (à l'exception d'une liste facultative de flux) d'une session à couper le son de l'audio publié.
Outre les flux existants, tous les flux publiés après l'appel de cette méthode sont publiés avec le son désactivé. Vous pouvez désactiver la mise en sourdine d'une session en appelant la méthode DisableForceMute méthode.
Voir également le ForceMuteAllAsync et ForceMuteStream des méthodes.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session. | | excludedStreamIds | Les identifiants des flux qui ne seront pas mis en sourdine. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'identifiant de session n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
ForceMuteAllAsync()
| async Task OpenTokSDK.OpenTok.ForceMuteAllAsync | ( | chaîne de caractères | sessionId, |
| chaîne [] | excludedStreamIds | ||
| ) |
Force tous les flux (à l'exception d'une liste facultative de flux) d'une session à couper le son de l'audio publié.
Outre les flux existants, tous les flux publiés après l'appel de cette méthode sont publiés avec le son désactivé. Vous pouvez désactiver la mise en sourdine d'une session en appelant la méthode DisableForceMuteAsync méthode.
Voir également le ForceMuteAll et ForceMuteStreamAsync des méthodes.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session. | | excludedStreamIds | Les identifiants des flux qui ne seront pas mis en sourdine. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'identifiant de session n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
ForceMuteStream()
| void OpenTokSDK.OpenTok.ForceMuteStream | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | streamId | ||
| ) |
Forcer l'éditeur d'un flux spécifique à couper le son de son contenu audio publié.
Voir également le ForceMuteAll et ForceMuteStreamAsync des méthodes.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session contenant le flux. | | streamId | L'identifiant du flux. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'ID de session ou de flux n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
ForceMuteStreamAsync()
| async Task OpenTokSDK.OpenTok.ForceMuteStreamAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | streamId | ||
| ) |
Forcer l'éditeur d'un flux spécifique à couper le son de son contenu audio publié.
Voir également le ForceMuteAll et ForceMuteStream des méthodes.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session contenant le flux. | | streamId | L'identifiant du flux. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | Lancée lorsque l'ID de session ou de flux n'est pas valide. | | OpenTokWebException | Lancée lorsqu'une erreur HTTP s'est produite. |
GenerateToken()
| chaîne OpenTokSDK.OpenTok.GenerateToken | ( | chaîne de caractères | sessionId, |
| 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. Afin d'authentifier un utilisateur se connectant à une session de la Video API, le client transmet un jeton lors de la connexion à la session.
À des fins de test, vous pouvez également générer des jetons de test en vous connectant à votre Account TokBox.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter. | | role | 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, un modérateur peut exercer des fonctions de modération, telles que forcer les clients à se déconnecter, à interrompre la diffusion de flux ou à couper le son dans les flux diffusés. Voir la Guide du développeur sur la modération. | | 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 | 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 | Une liste de chaînes de caractères contenant la structure initiale du flux. |
Retours
GetArchive()
| Archives OpenTokSDK.OpenTok.GetArchive | ( | chaîne de caractères | archiveId | ) |
Récupère un Archives objet correspondant à l'ID d'archive indiqué.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. |
Retours : Le Archives objet.
GetArchiveAsync()
| async Task<Archives> OpenTokSDK.OpenTok.GetArchiveAsync | ( | chaîne de caractères | archiveId | ) |
Récupère un Archives objet correspondant à l'ID d'archive indiqué.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. |
Retours : Le Archives objet.
GetBroadcast()
| Radiodiffusion OpenTokSDK.OpenTok.GetBroadcast | ( | chaîne de caractères | broadcastId | ) |
Utilisez cette méthode pour obtenir un objet de diffusion en direct correspondant à une session de la Video API de Vonage.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant la diffusion, notamment l'identifiant de la diffusion.
GetBroadcastAsync()
| async Task<Radiodiffusion> OpenTokSDK.OpenTok.GetBroadcastAsync | ( | chaîne de caractères | broadcastId | ) |
Utilisez cette méthode pour obtenir un objet de diffusion en direct correspondant à une session de la Video API de Vonage.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant la diffusion, notamment l'identifiant de la diffusion.
GetRenderAsync()
| async Task<[RenderItem]> OpenTokSDK.OpenTok.GetRenderAsync | ( | chaîne de caractères | renderId | ) |
Récupère un moteur de rendu Experience Composer.
Paramètres : | | | | --- | --- | | renderId | L'identifiant du rendu. |
GetStream()
| Flux OpenTokSDK.OpenTok.GetStream | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | streamId | ||
| ) |
Récupère un Flux objet correspondant à l'ID de flux indiqué.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session de la Video API Vonage. | | streamId | L'identifiant du flux. |
Retours : Le Flux objet.
GetStreamAsync()
| async Task<Flux> OpenTokSDK.OpenTok.GetStreamAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | streamId | ||
| ) |
Récupère un Flux objet correspondant à l'ID de flux indiqué.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session de la Video API Vonage. | | streamId | L'identifiant du flux. |
Retours : Le Flux objet.
ListArchives()
| Liste des archives OpenTokSDK.OpenTok.ListArchives | ( | int | décalage = 0, |
| int | nombre = 0, |
||
| chaîne de caractères | sessionId = "" |
||
| ) |
Renvoie une liste de Archives des objets, représentant des archives à la fois terminées et en cours, pour votre clé API.
Paramètres : | | | | --- | --- | | offset | L'offset d'index de la première archive. 0 correspond à l'offset de l'archive lancée le plus récemment. 1 correspond à l'offset de l'archive lancée avant celle-ci. | | count | Le nombre d'archives à renvoyer. Le nombre maximal d'archives renvoyées est de 1 000. | | sessionId | L'identifiant de session. |
Retours : Une liste de Archives objets.
ListArchivesAsync()
| async Task<Liste des archives> OpenTokSDK.OpenTok.ListArchivesAsync | ( | int | décalage = 0, |
| int | nombre = 0, |
||
| chaîne de caractères | sessionId = "" |
||
| ) |
Renvoie une liste de Archives des objets, représentant des archives à la fois terminées et en cours, pour votre clé API.
Paramètres : | | | | --- | --- | | offset | L'offset d'index de la première archive. 0 correspond à l'offset de l'archive lancée le plus récemment. 1 correspond à l'offset de l'archive lancée avant celle-ci. | | count | Le nombre d'archives à renvoyer. Le nombre maximal d'archives renvoyées est de 1 000. | | sessionId | L'identifiant de session. |
Retours : Une liste de Archives objets.
ListRendersAsync()
| async Task<[ListRendersResponse]> OpenTokSDK.OpenTok.ListRendersAsync | ( | ListRendersRequest | demande | ) |
Récupère tous les moteurs de rendu Experience Composer correspondant à la requête fournie.
Paramètres : | | | | --- | --- | | requête | La requête contenant les options de filtrage. |
Retourne : La liste des rendus.
ListStreams()
| Liste des flux OpenTokSDK.OpenTok.ListStreams | ( | chaîne de caractères | sessionId | ) |
Renvoie une liste de Flux objets représentant des flux en cours pour l'identifiant de session.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. |
Retours : Une liste de Flux objets.
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
ListStreamsAsync()
| async Task<Liste des flux> OpenTokSDK.OpenTok.ListStreamsAsync | ( | chaîne de caractères | sessionId | ) |
Renvoie une liste de Flux objets représentant des flux en cours pour l'identifiant de session.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. |
Retours : Une liste de Flux objets.
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
PlayDTMF()
| void OpenTokSDK.OpenTok.PlayDTMF | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | chiffres, | ||
| chaîne de caractères | connectionId = null |
||
| ) |
Envoyer des chiffres DTMF à tous les participants d'une session active de la Video API de Vonage ou à un client spécifique connecté à cette session.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session qui recevra la chaîne DTMF. | | connectionId | L'identifiant de connexion du client auquel vous envoyez le signal DTMF. Laissez ce champ vide pour envoyer un signal DTMF à tous les clients connectés à la session. | | digits | Il s'agit de la chaîne de chiffres DTMF à envoyer. Elle peut inclure les chiffres 0 à 9, ainsi que les caractères « * », « # » et « p ». Un « p » indique une pause de 500 ms (si vous devez ajouter un délai dans l'envoi des chiffres). |
PlayDTMFAsync()
| Tâche OpenTokSDK.OpenTok.PlayDTMFAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | chiffres, | ||
| chaîne de caractères | connectionId = null |
||
| ) |
Envoyer des chiffres DTMF à tous les participants d'une session active de la Video API de Vonage ou à un client spécifique connecté à cette session.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session qui recevra la chaîne DTMF. | | connectionId | L'identifiant de connexion du client auquel vous envoyez le signal DTMF. Laissez ce champ vide pour envoyer un signal DTMF à tous les clients connectés à la session. | | digits | Il s'agit de la chaîne de chiffres DTMF à envoyer. Elle peut inclure les chiffres 0 à 9, ainsi que les caractères « * », « # » et « p ». Un « p » indique une pause de 500 ms (si vous devez ajouter un délai dans l'envoi des chiffres). |
RemoveStreamFromArchive()
| void OpenTokSDK.OpenTok.SupprimerUnFluxDeL'Archive | ( | chaîne de caractères | archiveId, |
| chaîne de caractères | streamId | ||
| ) |
Supprime un flux d'une archive composée qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. | | streamId | L'identifiant du flux. |
RemoveStreamFromArchiveAsync()
| Tâche OpenTokSDK.OpenTok.RemoveStreamFromArchiveAsync | ( | chaîne de caractères | archiveId, |
| chaîne de caractères | streamId | ||
| ) |
Supprime un flux d'une archive composée qui a été lancée avec la commande streamMode fixé à StreamMode.Manuel.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive. | | streamId | L'identifiant du flux. |
RemoveStreamFromBroadcast()
| void OpenTokSDK.OpenTok.SupprimerUnFluxDeLaDiffusion | ( | chaîne de caractères | broadcastId, |
| chaîne de caractères | streamId | ||
| ) |
Supprime un flux d'une diffusion lancée à l'aide de la commande streamMode fixé à StreamMode.Manuel.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de la diffusion. | | streamId | L'identifiant du flux. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
RemoveStreamFromBroadcastAsync()
| Tâche OpenTokSDK.OpenTok.RemoveStreamFromBroadcastAsync | ( | chaîne de caractères | broadcastId, |
| chaîne de caractères | streamId | ||
| ) |
Supprime un flux d'une diffusion lancée à l'aide de la commande streamMode fixé à StreamMode.Manuel.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de la diffusion. | | streamId | L'identifiant du flux. |
Exceptions : | | | | --- | --- | | OpenTokArgumentException | |
SetArchiveLayout()
| bool OpenTokSDK.OpenTok.SetArchiveLayout | ( | chaîne de caractères | archiveId, |
| Mise en page des archives | mise en page | ||
| ) |
Vous permet de modifier dynamiquement la mise en page d'une archive composée pendant son enregistrement. Voir Personnalisation de la présentation vidéo pour les archives composées pour plus d'informations sur la personnalisation d'une mise en page.
Paramètres : | | | | --- | --- | | archiveId | | | layout | |
Retours
SetArchiveLayoutAsync()
| async Task<bool> OpenTokSDK.OpenTok.SetArchiveLayoutAsync | ( | chaîne de caractères | archiveId, |
| Mise en page des archives | mise en page | ||
| ) |
Vous permet de modifier dynamiquement la mise en page d'une archive composée pendant son enregistrement. Voir Personnalisation de la présentation vidéo pour les archives composées pour plus d'informations sur la personnalisation d'une mise en page.
Paramètres : | | | | --- | --- | | archiveId | | | layout | |
Retours
SetBroadcastLayout()
| void OpenTokSDK.OpenTok.SetBroadcastLayout | ( | chaîne de caractères | broadcastId, |
| BroadcastLayout | mise en page | ||
| ) |
Définit le type de mise en page de la diffusion. Pour plus d'informations sur les types de mise en page, voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion. | | layout | La BroadcastLayout qui définit les options de mise en page pour la diffusion. |
SetBroadcastLayoutAsync()
| async Task OpenTokSDK.OpenTok.SetBroadcastLayoutAsync | ( | chaîne de caractères | broadcastId, |
| BroadcastLayout | mise en page | ||
| ) |
Définit le type de mise en page de la diffusion. Pour plus d'informations sur les types de mise en page, voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion. | | layout | La BroadcastLayout qui définit les options de mise en page pour la diffusion. |
SetCustomUserAgent()
| void OpenTokSDK.OpenTok.SetCustomUserAgent | ( | chaîne de caractères | valeur | ) |
Définit une valeur personnalisée pour l'agent utilisateur. HttpClient ajoutera cette valeur, si elle existe, à la valeur initiale de l'agent utilisateur.
Paramètres : | | | | --- | --- | | valeur | La valeur personnalisée de l'agent utilisateur. |
SetDefaultRequestTimeout()
| void OpenTokSDK.OpenTok.SetDefaultRequestTimeout | ( | int | délai d'attente | ) |
Définit le délai d'expiration par défaut (en millisecondes) pour toutes les requêtes WebRequest envoyées par le SDK
Paramètres : | | | | --- | --- | | délai d'attente | |
SetStreamClassLists()
| void OpenTokSDK.OpenTok.SetStreamClassLists | ( | chaîne de caractères | sessionId, |
| Liste< Propriétés du flux > | cours d'eau | ||
| ) |
Définit la liste des classes de mise en page pour les flux d'une session. Les classes de mise en page sont utilisées dans la mise en page des archives composées et des diffusions en direct. Pour plus d'informations, consultez Personnalisation de la présentation vidéo pour les archives composées et Configuration de la disposition vidéo pour les diffusions en direct OpenTok.
Vous pouvez définir la liste initiale des classes de mise en page pour les flux publiés par un client lors de la génération des éléments utilisés par ce dernier. Consultez la section GenerateToken méthode.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session | | streams | Une liste de StreamsProperties définissant les listes de classes pour un ou plusieurs flux de la session. |
SetStreamClassListsAsync()
| async Task OpenTokSDK.OpenTok.SetStreamClassListsAsync | ( | chaîne de caractères | sessionId, |
| Liste< Propriétés du flux > | cours d'eau | ||
| ) |
Définit la liste des classes de mise en page pour les flux d'une session. Les classes de mise en page sont utilisées dans la mise en page des archives composées et des diffusions en direct. Pour plus d'informations, consultez Personnalisation de la présentation vidéo pour les archives composées et Configuration de la disposition vidéo pour les diffusions en direct OpenTok.
Vous pouvez définir la liste initiale des classes de mise en page pour les flux publiés par un client lors de la génération des éléments utilisés par ce dernier. Consultez la section GenerateToken méthode.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session | | streams | Une liste de StreamsProperties définissant les listes de classes pour un ou plusieurs flux de la session. |
Signal()
| void OpenTokSDK.OpenTok.Signal | ( | chaîne de caractères | sessionId, |
| Propriétés du signal | propriétés du signal, | ||
| chaîne de caractères | connectionId = null |
||
| ) |
Envoie un signal aux clients (ou à un client spécifique) connectés à une session de la Video API de Vonage.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session (sessionId) de la Video API Vonage vers lequel le signal sera envoyé. | | signalProperties | Ce paramètre signalProperties définit la charge utile du signal. | | connectionId | Paramètre facultatif utilisé pour envoyer le signal vers une connexion spécifique au sein d'une session. |
SignalAsync()
| async Task OpenTokSDK.OpenTok.SignalAsync | ( | chaîne de caractères | sessionId, |
| Propriétés du signal | propriétés du signal, | ||
| chaîne de caractères | connectionId = null |
||
| ) |
Envoie un signal aux clients (ou à un client spécifique) connectés à une session de la Video API de Vonage.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session (sessionId) de la Video API Vonage vers lequel le signal sera envoyé. | | signalProperties | Ce paramètre signalProperties définit la charge utile du signal. | | connectionId | Paramètre facultatif utilisé pour envoyer le signal vers une connexion spécifique au sein d'une session. |
StartArchive()
| Archives OpenTokSDK.OpenTok.StartArchive | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | nom = "", |
||
| bool | hasVideo = true, |
||
| bool | hasAudio = true, |
||
| Mode de sortie | mode de sortie = OutputMode.COMPOSED, |
||
| chaîne de caractères | résolution = null, |
||
| Mise en page des archives | mise en page = null, |
||
| StreamMode? | streamMode = null, |
||
| chaîne de caractères | multiArchiveTag = null |
||
| ) |
Lance l'archivage d'une session de la Video API Vonage.
Les clients doivent être activement connectés à la session de la Video API pour que vous puissiez lancer correctement l'enregistrement d'une archive.
Vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Vous ne pouvez enregistrer que les archives des sessions qui utilisent le routeur multimédia de la Video API (sessions dont le mode multimédia est défini sur « routed ») ; vous ne pouvez pas archiver les sessions dont le mode multimédia est défini sur « relayed ».
Notez que vous pouvez configurer l'archivage automatique de la session en définissant le paramètre archiveMode de la Créer une session à la méthode ArchiveMode.ALWAYS.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session de la Video API Vonage à archiver. | | name | Le nom de l'archive. Vous pouvez utiliser ce nom pour identifier l'archive. Il s'agit d'une propriété de la Archives objet, et il s'agit d'une propriété des événements liés aux archives dans le OpenTok bibliothèques clientes. | | hasVideo | Indique si l'archive enregistrera de la vidéo (true) ou non (false). La valeur par défaut est true (la vidéo est enregistrée). Si vous définissez à la fois hasAudio et hasVideo à « false », l'appel à la fonction StartArchive Cette méthode génère une erreur. | | hasAudio | Indique si l'archive enregistrera du son (true) ou non (false). La valeur par défaut est true (le son est enregistré). Si vous définissez à la fois hasAudio et hasVideo à « false », l'appel à la fonction StartArchive La méthode génère une erreur. | | outputMode | Indique si tous les flux de l'archive sont enregistrés dans un seul fichier (OutputMode.COMPOSED, par défaut) ou à des fichiers spécifiques (OutputMode.INDIVIDUAL). | | résolution | La résolution de l'archive. La valeur par défaut pour OutputMode.COMPOSED est « 640x480 ». Vous ne pouvez pas définir la résolution pour OutputMode.INDIVIDUAL. | | mise en page | La mise en page que vous souhaitez utiliser pour vos archives. Si le paramètre « type » est défini sur LayoutType.custom Vous devez fournir à Vonage une chaîne de caractères « StyleSheet » indiquant comment organiser votre archive. | | streamMode | Indique si les flux inclus dans l'archive sont sélectionnés automatiquement (StreamMode.Auto, valeur par défaut) ou manuellement (StreamMode.Manuel). Avec StreamMode.Manuel, vous devrez indiquer les flux à inclure dans l'archive à l'aide de la commande OpenTok.AddStreamToArchive et OpenTok.RemoveStreamFromArchive méthodes (ou le OpenTok.AddStreamToArchiveAsync et OpenTok.RemoveStreamFromArchiveAsync méthodes). | | multiArchiveTag | Définissez ce paramètre pour permettre l'enregistrement simultané de plusieurs archives pour une même session. Attribuez-lui une chaîne de caractères unique pour chaque archive simultanée d'une session en cours. Vous devez également définir cette option lorsque vous lancez manuellement une archive dans une session qui est archivée automatiquement. Si vous ne spécifiez pas de multiArchiveTag unique, vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Voir Archives simultanées. |
Retours : Le Archives objet. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.
StartArchiveAsync()
| async Task<Archives> OpenTokSDK.OpenTok.StartArchiveAsync | ( | chaîne de caractères | sessionId, |
| chaîne de caractères | nom = "", |
||
| bool | hasVideo = true, |
||
| bool | hasAudio = true, |
||
| Mode de sortie | mode de sortie = OutputMode.COMPOSED, |
||
| chaîne de caractères | résolution = null, |
||
| Mise en page des archives | mise en page = null, |
||
| StreamMode? | streamMode = null, |
||
| chaîne de caractères | multiArchiveTag = null |
||
| ) |
Lance l'archivage d'une session de la Video API Vonage.
Les clients doivent être activement connectés à la session de la Video API pour que vous puissiez lancer correctement l'enregistrement d'une archive.
Vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Vous ne pouvez enregistrer que les archives des sessions qui utilisent le routeur multimédia de la Video API (sessions dont le mode multimédia est défini sur « routed ») ; vous ne pouvez pas archiver les sessions dont le mode multimédia est défini sur « relayed ».
Notez que vous pouvez configurer l'archivage automatique de la session en définissant le paramètre archiveMode de la Créer une session à la méthode ArchiveMode.ALWAYS.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de la session de la Video API Vonage à archiver. | | name | Le nom de l'archive. Vous pouvez utiliser ce nom pour identifier l'archive. Il s'agit d'une propriété de la Archives objet, et il s'agit d'une propriété des événements liés aux archives dans le OpenTok bibliothèques clientes. | | hasVideo | Indique si l'archive enregistrera de la vidéo (true) ou non (false). La valeur par défaut est true (la vidéo est enregistrée). Si vous définissez à la fois hasAudio et hasVideo à « false », l'appel à la fonction StartArchive Cette méthode génère une erreur. | | hasAudio | Indique si l'archive enregistrera du son (true) ou non (false). La valeur par défaut est true (le son est enregistré). Si vous définissez à la fois hasAudio et hasVideo à « false », l'appel à la fonction StartArchive La méthode génère une erreur. | | outputMode | Indique si tous les flux de l'archive sont enregistrés dans un seul fichier (OutputMode.COMPOSED, par défaut) ou à des fichiers spécifiques (OutputMode.INDIVIDUAL). | | résolution | La résolution de l'archive. La valeur par défaut pour OutputMode.COMPOSED est « 640x480 ». Vous ne pouvez pas définir la résolution pour OutputMode.INDIVIDUAL. | | mise en page | La mise en page que vous souhaitez utiliser pour vos archives. Si le paramètre « type » est défini sur LayoutType.custom Vous devez fournir à Vonage une chaîne de caractères « StyleSheet » indiquant comment organiser votre archive. | | streamMode | Indique si les flux inclus dans l'archive sont sélectionnés automatiquement (StreamMode.Auto, valeur par défaut) ou manuellement (StreamMode.Manuel). Avec StreamMode.Manuel, vous devrez indiquer les flux à inclure dans l'archive à l'aide de la commande OpenTok.AddStreamToArchive et OpenTok.RemoveStreamFromArchive méthodes (ou le OpenTok.AddStreamToArchiveAsync et OpenTok.RemoveStreamFromArchiveAsync méthodes). | | multiArchiveTag | Définissez ce paramètre pour permettre l'enregistrement simultané de plusieurs archives pour une même session. Attribuez-lui une chaîne de caractères unique pour chaque archive simultanée d'une session en cours. Vous devez également définir cette option lorsque vous lancez manuellement une archive dans une session qui est archivée automatiquement. Si vous ne spécifiez pas de multiArchiveTag unique, vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Voir Archives simultanées. |
Retours : Le Archives objet. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.
StartAudioConnectorAsync()
| async Task<[AudioConnector]> OpenTokSDK.OpenTok.StartAudioConnectorAsync | ( | AudioConnectorStartRequest | demande | ) |
Envoie le flux audio d'une session de la Video API Vonage vers un WebSocket. Pour plus d'informations, consultez la Guide du développeur Audio Connector.
Paramètres : | | | | --- | --- | | request | La requête permettant de lancer le connecteur audio. |
Résultats : L'objet de réponse renvoyé par le serveur.
StartBroadcast()
| Radiodiffusion OpenTokSDK.OpenTok.StartBroadcast | ( | chaîne de caractères | sessionId, |
| bool | hls = true, |
||
| Liste< RTMP > | rtmpList = null, |
||
| chaîne de caractères | résolution = null, |
||
| int | maxDuration = 7200, |
||
| BroadcastLayout | mise en page = null, |
||
| StreamMode? | streamMode = null, |
||
| bool | enregistreur numérique = false, |
||
| bool ? | faible latence = null, |
||
| chaîne de caractères | multiBroadcastTag = null, |
||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Utilisez cette méthode pour lancer une diffusion en direct pour une session de la Video API. Cela permet de diffuser la session via un flux HLS (HTTP Live Streaming) ou RTMP.
Pour lancer avec succès la diffusion d'une session, au moins un client doit être connecté à la session.
Vous ne pouvez avoir qu'une seule diffusion en direct active à la fois pour une session (cependant, en avoir plusieurs ne serait pas utile). La diffusion en direct peut cibler un point de terminaison HLS et jusqu'à cinq serveurs RTMP simultanément pour une session. Vous ne pouvez lancer la diffusion en direct que pour les sessions utilisant le routeur multimédia de la Video API (avec le mode multimédia défini sur « routed ») ; vous ne pouvez pas utiliser la diffusion en direct avec des sessions dont le mode multimédia est défini sur « relayed » via le routeur multimédia de la Video API. Voir Le routeur multimédia OpenTok et les modes multimédia.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. | | hls | Indique s'il faut inclure une diffusion HLS. | | rtmpList | Une liste de RTMP objets, définissant les flux RTMP à diffuser (jusqu'à cinq). | | résolution | La résolution de la vidéo diffusée. Les résolutions valides sont « 640x480 », « 1280x720 », « 1920x1080 », « 480x640 », « 720x1280 » et « 1080x1920 ». | | maxDuration | La durée maximale de la diffusion, en secondes. La diffusion s'arrêtera automatiquement lorsque la durée maximale sera atteinte. Vous pouvez définir la durée maximale sur une valeur comprise entre 60 (60 secondes) et 36 000 (10 heures). La durée maximale par défaut est de 2 heures (7 200 secondes). | | layout | Spécifiez ceci BroadcastLayout objet permettant de définir le type de mise en page initiale de la diffusion. | | streamMode | Indique si les flux inclus dans la diffusion sont sélectionnés automatiquement (StreamMode.Auto, valeur par défaut) ou manuellement (StreamMode.Manuel). Avec StreamMode.Manuel, vous devrez indiquer les flux à inclure dans la diffusion à l'aide de la balise OpenTok.AddStreamToBroadcast et OpenTok.RemoveStreamFromBroadcast méthodes (ou le OpenTok.AddStreamToBroadcastAsync et OpenTok.RemoveStreamFromBroadcastAsync méthodes). | | dvr | Indique s'il faut activer la fonctionnalité DVR (retour en arrière, mise en pause et reprise) dans les lecteurs qui la prennent en charge (true), ou non (false, valeur par défaut). Lorsque la fonctionnalité DVR est activée, l'URL HLS inclura une chaîne de requête « ?DVR » ajoutée à la fin. Voir Fonctionnalité DVR | | lowLatency | Indique s'il faut activer le mode à faible latence pour le flux HLS. Certains lecteurs HLS ne prennent pas en charge le mode à faible latence. Cette fonctionnalité est incompatible avec les diffusions HLS en mode DVR. Voir Diffusions HLS à faible latence | | multiBroadcastTag | Définissez ce paramètre pour prendre en charge plusieurs diffusions simultanées d'une même session. Attribuez-lui une chaîne de caractères unique pour chaque diffusion simultanée d'une session en cours. Voir Diffusions simultanées. | | hasAudio | Indique si la diffusion comporte un flux audio (valeur par défaut : true). | | hasVideo | Indique si la diffusion comporte un flux vidéo (valeur par défaut : true). |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.
StartBroadcastAsync()
| async Task<Radiodiffusion> OpenTokSDK.OpenTok.StartBroadcastAsync | ( | chaîne de caractères | sessionId, |
| bool | hls = true, |
||
| Liste< RTMP > | rtmpList = null, |
||
| chaîne de caractères | résolution = null, |
||
| int | maxDuration = 7200, |
||
| BroadcastLayout | mise en page = null, |
||
| StreamMode? | streamMode = null, |
||
| bool | enregistreur numérique = false, |
||
| bool ? | faible latence = null, |
||
| chaîne de caractères | multiBroadcastTag = null, |
||
| bool | hasAudio = true, |
||
| bool | hasVideo = true |
||
| ) |
Utilisez cette méthode pour lancer une diffusion en direct pour une session de la Video API. Cela permet de diffuser la session via un flux HLS (HTTP Live Streaming) ou RTMP.
Pour lancer avec succès la diffusion d'une session, au moins un client doit être connecté à la session.
Vous ne pouvez avoir qu'une seule diffusion en direct active à la fois pour une session (cependant, en avoir plusieurs ne serait pas utile). La diffusion en direct peut cibler un point de terminaison HLS et jusqu'à cinq serveurs RTMP simultanément pour une session. Vous ne pouvez lancer la diffusion en direct que pour les sessions utilisant le routeur multimédia de la Video API (avec le mode multimédia défini sur « routed ») ; vous ne pouvez pas utiliser la diffusion en direct avec des sessions dont le mode multimédia est défini sur « relayed » via le routeur multimédia de la Video API. Voir Le routeur multimédia OpenTok et les modes multimédia.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | sessionId | L'identifiant de session correspondant à la session. | | hls | Indique s'il faut inclure une diffusion HLS. | | rtmpList | Une liste de RTMP objets, définissant les flux RTMP à diffuser (jusqu'à cinq). | | résolution | La résolution de la vidéo diffusée. Les résolutions valides sont « 640x480 », « 1280x720 », « 1920x1080 », « 480x640 », « 720x1280 » et « 1080x1920 ». | | maxDuration | La durée maximale de la diffusion, en secondes. La diffusion s'arrêtera automatiquement lorsque la durée maximale sera atteinte. Vous pouvez définir la durée maximale sur une valeur comprise entre 60 (60 secondes) et 36 000 (10 heures). La durée maximale par défaut est de 2 heures (7 200 secondes). | | layout | Spécifiez ceci BroadcastLayout objet permettant de définir le type de mise en page initiale de la diffusion. | | streamMode | Indique si les flux inclus dans la diffusion sont sélectionnés automatiquement (StreamMode.Auto, valeur par défaut) ou manuellement (StreamMode.Manuel). Avec StreamMode.Manuel, vous devrez indiquer les flux à inclure dans la diffusion à l'aide de la balise OpenTok.AddStreamToBroadcast et OpenTok.RemoveStreamFromBroadcast méthodes (ou le OpenTok.AddStreamToBroadcastAsync et OpenTok.RemoveStreamFromBroadcastAsync méthodes). | | dvr | Indique s'il faut activer la fonctionnalité DVR (retour en arrière, mise en pause et reprise) dans les lecteurs qui la prennent en charge (true), ou non (false, valeur par défaut). Lorsque la fonctionnalité DVR est activée, l'URL HLS inclura une chaîne de requête « ?DVR » ajoutée à la fin. Voir Fonctionnalité DVR | | lowLatency | Indique s'il faut activer le mode à faible latence pour le flux HLS. Certains lecteurs HLS ne prennent pas en charge le mode à faible latence. Cette fonctionnalité est incompatible avec les diffusions HLS en mode DVR. Voir Diffusions HLS à faible latence | | multiBroadcastTag | Définissez ce paramètre pour prendre en charge plusieurs diffusions simultanées d'une même session. Attribuez-lui une chaîne de caractères unique pour chaque diffusion simultanée d'une session en cours. Voir Diffusions simultanées. | | hasAudio | Indique si la diffusion comporte un flux audio (valeur par défaut : true). | | hasVideo | Indique si la diffusion comporte un flux vidéo (valeur par défaut : true). |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.
StartRenderAsync()
| async Task<[RenderItem]> OpenTokSDK.OpenTok.StartRenderAsync | ( | Lancer une demande de rendu | demande | ) |
Lance un nouveau moteur de rendu Experience Composer pour une session de la Video API Vonage.
Pour plus d'informations, consultez le . Guide du développeur Experience Composer.
Paramètres : | | | | --- | --- | | request | La requête de rendu. |
Renvoie : Le rendu généré.
StopArchive()
| Archives OpenTokSDK.OpenTok.StopArchive | ( | chaîne de caractères | archiveId | ) |
Arrête un OpenTok l'archive en cours d'enregistrement.
Les archives cessent automatiquement l'enregistrement au bout de 120 minutes ou lorsque tous les clients se sont déconnectés de la session en cours d'archivage.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive dont vous souhaitez interrompre l'enregistrement. |
Retours : Le Archives objet correspondant à l'archive en cours d'arrêt.
StopArchiveAsync()
| async Task<Archives> OpenTokSDK.OpenTok.StopArchiveAsync | ( | chaîne de caractères | archiveId | ) |
Arrête un OpenTok l'archive en cours d'enregistrement.
Les archives cessent automatiquement l'enregistrement au bout de 120 minutes ou lorsque tous les clients se sont déconnectés de la session en cours d'archivage.
Paramètres : | | | | --- | --- | | archiveId | L'identifiant de l'archive dont vous souhaitez interrompre l'enregistrement. |
Retours : Le Archives objet correspondant à l'archive en cours d'arrêt.
StopAudioConnectorAsync()
| async Task OpenTokSDK.OpenTok.StopAudioConnectorAsync | ( | chaîne de caractères | connectionId | ) |
Interrompt la transmission audio pour une session de la Video API Vonage.
Paramètres : | | | | --- | --- | | connectionId | L' OpenTok Identifiant de connexion pour la connexion WebSocket de l'Audio Connector dans la session de la Video API. Voir [AudioConnector.ConnectionId]. |
StopBroadcast()
| Radiodiffusion OpenTokSDK.OpenTok.StopBroadcast | ( | chaîne de caractères | broadcastId | ) |
Utilisez cette méthode pour interrompre la diffusion en direct d'une session de la Video API Vonage. Notez que les diffusions s'arrêtent automatiquement 120 minutes après leur début.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant la diffusion, notamment l'identifiant de la diffusion.
StopBroadcastAsync()
| async Task<Radiodiffusion> OpenTokSDK.OpenTok.StopBroadcastAsync | ( | chaîne de caractères | broadcastId | ) |
Utilisez cette méthode pour interrompre la diffusion en direct d'une session de la Video API Vonage. Notez que les diffusions s'arrêtent automatiquement 120 minutes après leur début.
Pour plus d'informations sur la diffusion, consultez le Guide du développeur pour la diffusion.
Paramètres : | | | | --- | --- | | broadcastId | L'identifiant de diffusion de la session de diffusion |
Retours : Le Radiodiffusion objet. Cet objet comprend des propriétés définissant la diffusion, notamment l'identifiant de la diffusion.
StopRenderAsync()
| async Task OpenTokSDK.OpenTok.StopRenderAsync | ( | chaîne de caractères | renderId | ) |
Arrête un moteur de rendu Experience Composer.
Paramètres : | | | | --- | --- | | renderId | L'identifiant du rendu. |
Documentation relative aux biens immobiliers
ApiKey
| --- | int OpenTokSDK.OpenTok.ApiKey |
La clé Video API Vonage transmise à la OpenTok() constructeur.
ApiSecret
| --- | chaîne OpenTokSDK.OpenTok.ApiSecret |
La clé secrète de la Video API Vonage transmise à l' OpenTok() constructeur.
Client
| --- | HttpClient OpenTokSDK.OpenTok.Client |
À usage interne
Débogage
| --- | bool OpenTokSDK.OpenTok.Debug |
Permet d'afficher les détails des requêtes et des réponses sur la console. À ne pas utiliser dans un environnement de production.