OpenTok

java.lang.Object

com.opentok.OpenTok

classe publique OpenTok hérite de Objet

Contient des méthodes permettant de créer des sessions OpenTok, de générer des jetons et de gérer les archives.

Pour créer un nouvel objet OpenTok, appelez le constructeur OpenTok en lui passant votre clé API OpenTok et le secret API correspondant à votre Compte Video API de Vonage. Ne divulguez pas votre clé secrète API. Vous l'utiliserez avec le constructeur OpenTok (uniquement sur votre serveur web) pour créer des sessions OpenTok.

Veillez à installer l'intégralité du SDK du serveur OpenTok sur votre serveur web.

Résumé des classes imbriquées

Classes imbriquées

Modificateur et type

Classe

Description

static class

OpenTok.Builder

Permet de créer un objet OpenTok avec des paramètres avancés.

Résumé du constructeur

Constructeurs

Constructeur

Description

OpenTok(int apiKey, String apiSecret)

Crée un objet OpenTok.

OpenTok(String applicationId, Path privateKeyPath)

Crée un objet OpenTok destiné à être utilisé avec le Video API de Vonage.

Résumé de la méthode

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

Modificateur et type

Méthode

Description

void

addArchiveStream(String archiveId, String streamId, boolean hasAudio, boolean hasVideo)

Ajoute un flux à une archive OpenTok.

void

addBroadcastStream(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo)

Ajoute un flux à une diffusion Opentok.

void

close()

Appelez cette méthode lorsque vous avez fini d'utiliser l'objet OpenTok, afin d'éviter toute fuite de descripteurs de fichiers.

AudioConnector

connectAudioStream(String sessionId, String token, AudioConnectorProperties properties)

Envoyer le flux audio d'une session de la Video API Vonage vers un WebSocket.

Session

createSession()

Crée une session OpenTok avec les paramètres par défaut :

Session

createSession(SessionProperties properties)

Crée une nouvelle session OpenTok.

void

deleteArchive(String archiveId)

Supprime une archive OpenTok.

Sip

dial(String sessionId, String token, SipProperties properties)

Appelle une passerelle SIP pour la connecter à une session OpenTok.

void

disableForceMute(String sessionId)

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

void

forceDisconnect(String sessionId, String connectionId)

Déconnecter un client d'une session OpenTok

void

forceMuteAll(String sessionId, MuteAllProperties properties)

Force tous les flux (à l'exception d'un tableau facultatif de flux) d'une session à couper le son de l'audio publié.

void

forceMuteStream(String sessionId, String streamId)

Forcer l'éditeur d'un flux spécifique à couper le son.

String

generateToken(String sessionId)

Crée un jeton permettant de se connecter à une session OpenTok, en utilisant les paramètres par défaut.

String

generateToken(String sessionId, TokenOptions tokenOptions)

Crée un jeton permettant de se connecter à une session OpenTok.

Archive

getArchive(String archiveId)

Récupère un Archive objet correspondant à l'ID d'archive indiqué.

Broadcast

getBroadcast(String broadcastId)

Récupère un Broadcast objet correspondant à l'identifiant de diffusion indiqué.

Render

getRender(String renderId)

Récupère un objet Render, avec des informations détaillées sur un Experience Composer.

Stream

getStream(String sessionId, String streamId)

Récupère un Stream objet correspondant à l'ID de session et à l'ID de flux indiqués.

ArchiveList

listArchives()

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

ArchiveList

listArchives(int offset, int count)

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

ArchiveList

listArchives(String sessionId)

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

ArchiveList

listArchives(String sessionId, int offset, int count)

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

List<Render>

listRenders()

Récupère une liste d'objets Render, représentant les Experience Composers associés au projet OpenTok.

List<Render>

listRenders(Integer offset, Integer count)

Récupère une liste d'objets Render, représentant une liste de compositeurs d'expérience associés au projet OpenTok.

StreamList

listStreams(String sessionId)

Récupère une liste de Stream objets correspondant à l'identifiant de session indiqué.

void

playDTMF(String sessionId, String dtmfDigits)

Envoyer des chiffres DTMF à tous les clients d'une session.

void

playDTMF(String sessionId, String connectionId, String dtmfDigits)

Envoyer des chiffres DTMF à un client spécifique au cours d'une session.

void

removeArchiveStream(String archiveId, String streamId)

Supprime un flux d'une archive Opentok.

void

removeBroadcastStream(String broadcastId, String streamId)

Supprime un flux d'une diffusion Opentok.

void

setArchiveLayout(String archiveId, ArchiveProperties properties)

Définit le type de mise en page d'une archive composée.

void

setBroadcastLayout(String broadcastId, BroadcastProperties properties)

Définit le type de mise en page de la diffusion.

void

setStreamLayouts(String sessionId, StreamListProperties properties)

Définit la liste des classes de mise en page pour les flux d'une session.

void

signal(String sessionId, SignalProperties props)

Envoie un signal à tous les clients connectés à une session.

void

signal(String sessionId, String connectionId, SignalProperties props)

Envoie un signal à un client spécifique connecté à une session.

Archive

startArchive(String sessionId)

Archive

startArchive(String sessionId, ArchiveProperties properties)

Lance l'archivage d'une session OpenTok.

Archive

startArchive(String sessionId, String name)

Broadcast

startBroadcast(String sessionId, BroadcastProperties properties)

Lance une diffusion en direct pour une session OpenTok.

Caption

startCaptions(String sessionId, String token, CaptionProperties properties)

Utilisez l'API Live Captions pour transcrire les flux audio et générer des sous-titres en temps réel pour votre application.

Render

startRender(String sessionId, String token, RenderProperties properties)

Lance un rendu d'Experience Composer pour une session OpenTok.

Archive

stopArchive(String archiveId)

Arrête l'archivage OpenTok en cours d'enregistrement.

Broadcast

stopBroadcast(String broadcastId)

Arrête la diffusion en direct d'une session OpenTok.

void

stopCaptions(String captionsId)

Utilisez cette méthode pour désactiver le sous-titrage en direct d'une session.

void

stopRender(String renderId)

Arrête un Experience Composer d'une session OpenTok.

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

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

Informations sur le constructeur

OpenTok

public OpenTok(int apiKey, Chaîne apiSecret)

Crée un objet OpenTok.

Paramètres : : apiKey - Votre clé API OpenTok. (Consultez votre Page de compte de l'API Video de Vonage.) : apiSecret - Votre clé secrète API OpenTok. (Consultez votre Page de compte de l'API Video de Vonage.)

OpenTok

public OpenTok(Chaîne applicationId, Chemin d'accès privateKeyPath)

Crée un objet OpenTok destiné à être utilisé avec le Video API de Vonage. Il s'agit d'une étape à court terme en vue d'une migration complète vers Vonage. Consultez le Guide de migration du SDK Java pour plus de détails.

Paramètres : : applicationId - L'UUID de votre application Vonage sur laquelle la fonctionnalité vidéo est activée. privateKeyPath - Chemin d'accès absolu à la clé privée de votre application.

Depuis la version : : 4.15.0

Détails de la méthode

generateToken

public Chaîne generateToken(Chaîne sessionId, TokenOptions tokenOptions) lance une exception OpenTokException

Crée un jeton permettant de se connecter à une session OpenTok. Afin d'authentifier un utilisateur se connectant à une session OpenTok, le client transmet ce jeton lors de la connexion à la session.

L'exemple suivant montre comment obtenir un jeton doté du rôle « abonné » et d'une chaîne de métadonnées de connexion :


 import com.opentok.Role;
 import com.opentok.TokenOptions;

 class Test {
     public static void main(String args[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession());

         // Replace with meaningful metadata for the connection.
         String connectionMetadata = "username=Bob,userLevel=4";

         // Use the Role value appropriate for the user.
         String role = Role.SUBSCRIBER;

         // Generate a token:
         TokenOptions options = new TokenOptions.Buider().role(role).data(connectionMetadata).build();
         String token = sdk.generateToken(sessionId, options);
         System.out.println(token);
     }
 }

À des fins de test, vous pouvez également générer des jetons en vous connectant à votre Compte Video API de Vonage.

Paramètres : : sessionId - L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter. : tokenOptions - Cet objet TokenOptions définit les options associées au jeton. Il s'agit notamment des éléments suivants :

- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user

Retourne : : La chaîne de caractères du jeton.

Lancers : : OpenTokException

generateToken

public Chaîne generateToken(Chaîne sessionId) lance une exception OpenTokException

Crée un jeton permettant de se connecter à une session OpenTok, en utilisant les paramètres par défaut. Les paramètres par défaut sont les suivants :

Le jeton se voit attribuer le rôle d'éditeur.
Le jeton expire 24 heures après sa création.
Le jeton ne contient aucune donnée de connexion.

L'exemple suivant montre comment générer un jeton avec les paramètres par défaut :


 import com.opentok.OpenTok;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession().getSessionId());

         String token = sdk.generateToken(sessionId);
         System.out.println(token);
     }
 }

Paramètres : : sessionId - L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter.

Retourne : : La chaîne de caractères du jeton.

Lancers : : OpenTokException

Voir aussi : : - generateToken(String, TokenOptions)

createSession

public Session createSession(Propriétés de session propriétés) lance une exception OpenTokException

Crée une nouvelle session OpenTok.

Par exemple, lorsque vous utilisez la bibliothèque OpenTok.js, utilisez l'identifiant de session lorsque vous appelez la fonction OT.initSession() méthode (pour initialiser une session OpenTok).

Les sessions OpenTok n'ont pas de date d'expiration. En revanche, les jetons d'authentification ont une durée de validité limitée (voir la generateToken(String, TokenOptions) (méthode). Notez également que les sessions ne peuvent pas être supprimées explicitement.

Une chaîne d'identification de session peut comporter jusqu'à 255 caractères.

L'appel de cette méthode entraîne un OpenTokException en cas d'erreur. Consultez le message d'erreur pour plus de détails.

Le code suivant crée une session qui tente d'envoyer des flux directement entre les clients (en recourant au serveur TURN d'OpenTok pour relayer les flux si les clients ne parviennent pas à se connecter) :


 import com.opentok.MediaMode;
 import com.opentok.OpenTok;
 import com.opentok.Session;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         SessionProperties sp = new SessionProperties().Builder()
           .mediaMode(MediaMode.RELAYED).build();

         Session session = sdk.createSession(sp);
         System.out.println(session.getSessionId());
     }
 }

Vous pouvez également créer une session à l'aide de la OpenTok API REST ou en vous connectant à votre Compte Video API de Vonage.

Paramètres : : properties - Cet objet `SessionProperties` définit les options de la session. Il s'agit notamment des éléments suivants :

- Whether the session's streams will be transmitted directly between peers or
  using the OpenTok Media Router.
- A location hint for the location of the OpenTok server to use for the session.

Retourne : : Un objet Session représentant la nouvelle session. Appelez la méthode getSessionId() méthode de l'objet Session permettant d'obtenir 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.

Lancers : : OpenTokException

createSession

public Session createSession() lance une exception OpenTokException

Crée une session OpenTok avec les paramètres par défaut :

Le mode multimédia est « relayé ». La session tentera de transmettre les flux directement entre les clients. Si deux clients ne parviennent pas à envoyer et à recevoir leurs flux respectifs en raison de pare-feu présents sur leurs réseaux respectifs, leurs flux seront retransmis via le serveur TURN d'OpenTok.
La session utilise le premier client qui se connecte pour déterminer l'emplacement du serveur OpenTok à utiliser.

L'exemple suivant permet de créer une session utilisant les paramètres par défaut :


 import com.opentok.OpenTok;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         String sessionId = sdk.createSession();
         System.out.println(sessionId);
     }
 }

Lancers : : OpenTokException

Voir aussi : : - createSession(SessionProperties)

signal

public void signal(Chaîne sessionId, Propriétés du signal accessoires) lance OpenTokException

Envoie un signal à tous les clients connectés à une session.

Pour plus d'informations, voir le Guide du développeur sur la signalisation.

Paramètres : : sessionId - L'identifiant de session. : props - L'objet SignalProperties qui définit les données et le type du signal.

Lancers : : OpenTokException

signal

public void signal(Chaîne sessionId, Chaîne connectionId, Propriétés du signal accessoires) lance OpenTokException

Envoie un signal à un client spécifique connecté à une session.

Pour plus d'informations, voir le Guide du développeur sur la signalisation.

Paramètres : : sessionId - L'identifiant de session. : connectionId - L'identifiant de connexion du client qui doit recevoir le signal. : props - L'objet SignalProperties qui définit les données et le type du signal.

Lancers : : OpenTokException

getArchive

public Archives getArchive(Chaîne archiveId) lance une exception OpenTokException

Récupère un Archive objet correspondant à l'ID d'archive indiqué.

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

Retours : : Le Archive objet.

Lancers : : OpenTokException

liste des archives

public Liste des archives listArchives() lance une exception OpenTokException

Renvoie une liste de Archive objets, représentant les archives à la fois achevées et en cours, pour votre clé API. Cette liste est limitée à 1 000 archives, en commençant par la première archive enregistrée. Pour obtenir une plage spécifique d'archives, appelez listArchives(int offset, int count).

Retourne : : Une liste de Archive objets.

Lancers : : OpenTokException

liste des archives

public Liste des archives listArchives(Chaîne sessionId) lance une exception OpenTokException

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

Paramètres : : sessionId - L'identifiant (sessionid) de la session qui a lancé ou activé automatiquement l'archivage. Si la session est nulle ou vide, elle sera omise.

Retourne : : Une liste de Archive objets.

Lancers : : OpenTokException

liste des archives

public Liste des archives listArchives(int offset, int count) throws OpenTokException

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

Paramètres : : offset - Le décalage d'index de la première archive. 0 correspond au décalage de l'archive lancée le plus récemment . 1 correspond au décalage 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.

Retourne : : Une liste de Archive objets.

Lancers : : OpenTokException

liste des archives

public Liste des archives listArchives(Chaîne sessionId, int offset, int count) lance une exception OpenTokException

Renvoie une liste de Archive objets, représentant des archives à la fois achevées et en cours de traitement, pour votre clé API.

Retourne : : Une liste de Archive objets.

Lancers : : OpenTokException

début de l'archive

public Archives startArchive(Chaîne sessionId, Propriétés d'archivage propriétés) lance une exception OpenTokException

Lance l'archivage d'une session OpenTok. Cette version du startArchive() Cette méthode vous permet de désactiver l'enregistrement audio ou vidéo.

Les clients doivent être activement connectés à la session OpenTok pour que vous puissiez lancer 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 OpenTok Media Router (les sessions avec le mode média (réglé sur « routed ») ; vous ne pouvez pas archiver les sessions dont le mode média est réglé sur « relayed ».

Pour plus d'informations sur l'archivage, consultez le Archivage OpenTok guide du développeur.

Paramètres : : sessionId - L'identifiant de la session OpenTok à archiver. : properties - Cet objet ArchiveProperties définit les options relatives à l'archive.

Retourne : : L'objet Archive. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.

Lancers : : OpenTokException

début de l'archive

public Archives startArchive(Chaîne sessionId) lance une exception OpenTokException

Lancers : : OpenTokException

début de l'archive

public Archives startArchive(Chaîne sessionId, Chaîne nom) lance une exception OpenTokException

Lancers : : OpenTokException

stopArchive

public Archives stopArchive(Chaîne archiveId) lance une exception OpenTokException

Arrête l'archivage OpenTok 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.

Renvoie : : L'objet Archive correspondant à l'archive en cours d'arrêt.

Lancers : : OpenTokException

supprimerArchive

public void supprimerArchive(Chaîne archiveId) lance une exception OpenTokException

Supprime une archive OpenTok.

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. Pour 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.

Lancers : : OpenTokException

addArchiveStream

public void ajouterUnFluxD'Archive(Chaîne archiveId, Chaîne streamId, boolean hasAudio, boolean hasVideo) lance une exception OpenTokException

Ajoute un flux à une archive OpenTok.

Cette méthode ne fonctionne que pour une archive qui contient un Archive.StreamMode définir sur StreamMode.MANUAL.

Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux pour activer ou désactiver le son ou la vidéo, en fonction de la hasAudio et hasVideo valeurs des paramètres.

Paramètres : : archiveId - L'identifiant de l'archive. : streamId - L'identifiant du flux. : hasAudio - Si le son doit être activé pour le flux dans l'archive. : hasVideo - Si la diffusion doit être disponible en vidéo dans les archives.

Lancers : : OpenTokException

removeArchiveStream

public void removeArchiveStream(Chaîne archiveId, Chaîne streamId) lance une exception OpenTokException

Supprime un flux d'une archive Opentok.

Cette méthode ne fonctionne que pour une archive qui contient un Archive.StreamMode définir sur StreamMode.MANUAL.

Paramètres : : archiveId - L'identifiant de l'archive. : streamId - L'identifiant du flux.

Lancers : : OpenTokException

setArchiveLayout

public void setArchiveLayout(Chaîne archiveId, Propriétés d'archivage propriétés) lance une exception OpenTokException

Définit le type de mise en page d'une archive composée. Pour plus d'informations sur les types de mise en page, voir Personnalisation de la mise en page vidéo pour les archives composées.

Paramètres : : archiveId - {String} L'identifiant de l'archive. : properties - L'objet ArchiveProperties qui définit la structure de l'archive.

Lancers : : OpenTokException

startBroadcast

public Radiodiffusion startBroadcast(Chaîne sessionId, BroadcastProperties propriétés) lance une exception OpenTokException

Lance une diffusion en direct pour une session OpenTok. Cette opération diffuse 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 OpenTok Media Router (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 OpenTok Media Router ». 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 la session OpenTok à diffuser. : properties - L'objet BroadcastProperties définit les options de la diffusion.

Retourne : : L'objet Broadcast. Cet objet comprend des propriétés définissant la diffusion, notamment l'identifiant de la diffusion.

Lancers : : OpenTokException

stopBroadcast

public Radiodiffusion stopBroadcast(Chaîne broadcastId) lance une exception OpenTokException

Arrête la diffusion en direct d'une session OpenTok. 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 la session de diffusion

Retourne : : L'objet Broadcast. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.

Lancers : : OpenTokException

getBroadcast

public Radiodiffusion getBroadcast(Chaîne broadcastId) lance une exception OpenTokException

Récupère un Broadcast objet correspondant à l'identifiant de diffusion indiqué.

Paramètres : : broadcastId - L'identifiant de diffusion.

Retours : : Le Broadcast objet.

Lancers : : OpenTokException

setBroadcastLayout

public void setBroadcastLayout(Chaîne broadcastId, BroadcastProperties propriétés) lance une exception OpenTokException

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 via OpenTok.

Paramètres : : broadcastId - {String} L'identifiant de diffusion. : properties - Cet objet `BroadcastProperties` qui définit les options de mise en page pour la diffusion.

Lancers : : OpenTokException

addBroadcastStream

public void ajouterUnFluxDeDiffusion(Chaîne broadcastId, Chaîne streamId, boolean hasAudio, boolean hasVideo) lance une exception OpenTokException

Ajoute un flux à une diffusion Opentok.

Cette méthode ne fonctionne que pour une archive qui contient un Archive.StreamMode définir sur StreamMode.MANUAL.

Paramètres : : broadcastId - L'identifiant de diffusion. : streamId - L'identifiant du flux. : hasAudio - Si le son doit être activé pour le flux lors de la diffusion. : hasVideo - Si la diffusion doit inclure de la vidéo.

Lancers : : OpenTokException

removeBroadcastStream

public void removeBroadcastStream(Chaîne broadcastId, Chaîne streamId) lance une exception OpenTokException

Supprime un flux d'une diffusion Opentok.

Cette méthode ne fonctionne que pour une archive qui contient un Archive.StreamMode définir sur StreamMode.MANUAL.

Paramètres : : broadcastId - L'identifiant de diffusion. : streamId - L'identifiant du flux.

Lancers : : OpenTokException

setStreamLayouts

public void setStreamLayouts(Chaîne sessionId, Propriétés de StreamList propriétés) lance une exception OpenTokException

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 mise en page vidéo pour les archives composées et Configuration de la disposition vidéo pour les diffusions en direct via 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 utilisée par le client. Voir la section generateToken(String, TokenOptions) méthode.

Paramètres : : sessionId - {String} L'identifiant de la session à laquelle appartiennent les flux. : properties - Cet objet `StreamListProperties` définit des listes de classes pour un ou plusieurs flux de la session.

Lancers : : OpenTokException

forceDisconnect

public void forceDisconnect(Chaîne sessionId, Chaîne connectionId) lance une exception OpenTokException

Déconnecter un client d'une session OpenTok

Utilisez cette API pour mettre fin de force à la connexion d'une session.

Paramètres : : sessionId - L'identifiant de session de la connexion : connectionId - L'identifiant de la connexion à déconnecter

Lancers : : OpenTokException

forceMuteStream

public void forceMuteStream(Chaîne sessionId, Chaîne streamId) lance une exception OpenTokException

Forcer l'éditeur d'un flux spécifique à couper le son.

Pour plus d'informations, consultez Désactiver l'audio des flux dans une session.

Paramètres : : sessionId - L'identifiant de session. : streamId - L'identifiant du flux.

Lancers : : OpenTokException

Voir aussi : : - forceMuteAll(String, MuteAllProperties)

forceMuteAll

public void forceMuteAll(Chaîne sessionId, MuteAllProperties propriétés) lance une exception OpenTokException

Force tous les flux (à l'exception d'un tableau facultatif 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 coupé. Vous pouvez désactiver la mise en sourdine d' une session en appelant la méthode OpenTok.disableForceMute() méthode.

Pour plus d'informations, consultez Désactiver l'audio des flux dans une session.

Paramètres : : sessionId - L'identifiant de session. : properties - Définit une liste d'identifiants de flux à exclure de l'action de mise en sourdine.

Lancers : : OpenTokException

Voir aussi : : - forceMuteStream(String, String) - disableForceMute(String)

disableForceMute

public void désactiverForceMute(Chaîne sessionId) lance une exception OpenTokException

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 OpenTok.forceMuteAll() méthode, tous les flux publiés après cet appel le sont avec le son désactivé. Lorsque vous appelez la OpenTok.disableForceMute() Avec cette méthode, les flux futurs publiés dans la session ne sont pas mis en sourdine (mais les flux déjà mis en sourdine le restent).

Paramètres : : sessionId - L'identifiant de session.

Lancers : : OpenTokException

Voir aussi : : - forceMuteAll(String, MuteAllProperties)

getStream

public Flux getStream(Chaîne sessionId, Chaîne streamId) lance une exception OpenTokException

Récupère un Stream objet correspondant à l'ID de session et à l'ID de flux indiqués.

Paramètres : : sessionId - L'identifiant de session. : streamId - L'identifiant du flux.

Retours : : Le Stream objet.

Lancers : : OpenTokException

listStreams

public Liste des flux listStreams(Chaîne sessionId) lance une exception OpenTokException

Récupère une liste de Stream objets correspondant à l'identifiant de session indiqué.

Paramètres : : sessionId - L'identifiant de session.

Retourne : : La liste des Stream objets.

Lancers : : OpenTokException

cadran

public Buvre une gorgée composer le(Chaîne sessionId, Chaîne jeton, SipProperties propriétés) lance une exception OpenTokException

Appelle une passerelle SIP pour la connecter à une session OpenTok.

Paramètres : : sessionId - L'identifiant de session. : token - Jeton OpenTok à utiliser pour le participant appelé. Vous pouvez ajouter des données de jeton permettant d'identifier que le participant se trouve sur un terminal SIP ou d'autres données d'identification, telles que des numéros de téléphone. (Les bibliothèques client OpenTok incluent des propriétés permettant d'examiner les données de connexion d'un client connecté à une session.) Consultez la Guide du développeur sur la création de jetons. : properties - Le SipProperties objet définissant les options de l'appel SIP.

Retours : : Le Sip objet.

Lancers : : OpenTokException

playDTMF

public void playDTMF(Chaîne sessionId, Chaîne (dtmfDigits) lance une exception OpenTokException

Envoyer des chiffres DTMF à tous les clients d'une session.

Paramètres : : sessionId - L'identifiant de session. : dtmfDigits - La chaîne de chiffres DTMF à envoyer. Elle peut contenir les chiffres 0 à 9, les caractères « * », « # » et « p ». Le caractère « p » indique une pause de 500 ms (si vous devez ajouter un délai avant l'envoi des chiffres).

Lancers : : OpenTokException

playDTMF

public void playDTMF(Chaîne sessionId, Chaîne connectionId, Chaîne (dtmfDigits) lance une exception OpenTokException

Envoyer des chiffres DTMF à un client spécifique au cours d'une session.

Paramètres : : sessionId - L'identifiant de session. : connectionId - L'identifiant de session du client chargé de recevoir les chiffres DTMF. : dtmfDigits - La chaîne de chiffres DTMF à envoyer. Elle peut contenir les chiffres 0 à 9, les caractères « * », « # » et « p ». Le caractère « p » indique une pause de 500 ms (si vous devez ajouter un délai avant l'envoi des chiffres).

Lancers : : OpenTokException

connectAudioStream

public AudioConnector connectAudioStream(Chaîne sessionId, Chaîne jeton, Propriétés de l'AudioConnector propriétés) lance une exception OpenTokException

Envoyer le flux audio d'une session de la Video API vers un WebSocket. Pour plus d'informations, consultez la Guide du développeur Audio Connector.

Paramètres : : sessionId - L'identifiant de session. : token - Le jeton OpenTok à utiliser pour la connexion de l'Audio Connector à la session OpenTok. Vous pouvez ajouter des données au jeton afin d'indiquer que la connexion correspond au point de terminaison de l'Audio Connector ou pour fournir d'autres informations d'identification. : properties - L'objet ConnectProperties définit les options utilisées dans la requête adressée au point de terminaison de l'API Audio Connector.

Retourne : : L'objet de réponse Audio Connect provenant du serveur.

Lancers : : OpenTokException

startRender

public Rendu startRender(Chaîne sessionId, Chaîne jeton, Propriétés de rendu propriétés) lance une exception OpenTokException

Lance un rendu d'Experience Composer pour une session OpenTok. Pour plus d'informations, consultez la Guide du développeur Experience Composer.

Paramètres : : sessionId - L'identifiant de session. : properties - Le RenderProperties objet définissant les propriétés de l'appel à Render.

Retours : : Le Render objet de réponse.

Lancers : : OpenTokException

getRender

public Rendu getRender(Chaîne renderId) lance une exception OpenTokException

Récupère un objet Render, avec des informations détaillées sur un Experience Composer.

Paramètres : : renderId - L'identifiant de l'Experience Composer à récupérer.

Retours : : Le Render objet de réponse associé à l'identifiant fourni.

Lancers : : OpenTokException

stopRender

public void stopRender(Chaîne renderId) lance une exception OpenTokException

Arrête un Experience Composer d'une session OpenTok. Notez que, par défaut, les Experience Composers s'arrêtent automatiquement 2 heures après leur lancement. Vous pouvez également définir une autre valeur pour « maxDuration » lors de la création de l'Experience Composer. Lorsque l'Experience Composer prend fin, un événement est envoyé à l'URL de rappel, si vous en avez configuré une pour le projet.

Paramètres : : renderId - L'identifiant de l'Experience Composer à arrêter.

Lancers : : OpenTokException

listRenders

public Liste<Rendu> listRenders() lance une exception OpenTokException

Récupère une liste d'objets Render, représentant les Experience Composers associés au projet OpenTok.

Retourne : : La liste des Render objets.

Lancers : : OpenTokException

listRenders

public Liste<Rendu> listRenders(Entier décalage, Entier nombre) lance OpenTokException

Récupère une liste d'objets Render, représentant une liste de compositeurs d'expérience associés au projet OpenTok.

Paramètres : : offset - (facultatif) Décalage de départ dans la liste des rendus existants. : count - (facultatif) Nombre de rendus à récupérer à partir de l'offset. Maximum : 1 000.

Retourne : : La liste des Render objets.

Lancers : : OpenTokException

début des sous-titres

public Légende startCaptions(Chaîne sessionId, Chaîne jeton, Propriétés de la légende propriétés) lance une exception OpenTokException

Utilisez l'API Live Captions pour transcrire des flux audio et générer des sous-titres en temps réel pour votre application. Live Captions est activé par défaut pour tous les projets ; il s'agit d'un produit facturé à l'utilisation. La fonctionnalité Live Captions n'est prise en charge que dans les sessions routées (sessions utilisant l'OpenTok Media Router). Vous pouvez envoyer jusqu'à 50 flux audio à la fois depuis une seule session Vonage vers le service de transcription pour la création de sous-titres.

Paramètres : : sessionId - L'identifiant de la session OpenTok. Le flux audio provenant des diffuseurs participant à cette session sera utilisé pour générer les sous-titres. : token - Un jeton OpenTok valide dont le rôle est défini sur « Modérateur ». : properties - Le CaptionProperties objet définissant les propriétés facultatives du sous-titrage en direct.

Retours : : A Caption réponse contenant l'identifiant des sous-titres pour cet appel.

Lancers : : OpenTokException

stopCaptions

public void stopCaptions(Chaîne captionsId) lance une exception OpenTokException

Utilisez cette méthode pour désactiver le sous-titrage en direct d'une session.

Paramètres : : captionsId - L'identifiant unique de la session de sous-titrage audio, tel qu'il a été obtenu à partir de Caption.getCaptionsId().

Lancers : : OpenTokException

fermer

public void close()

Appelez cette méthode lorsque vous avez fini d'utiliser l'objet OpenTok, afin d'éviter toute fuite de descripteurs de fichiers.