Constructeur

new OpenTok(apiKey, apiSecret)

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

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 OpenTok pour Node.js sur votre serveur web.

Paramètres :
Nom Type Description
apiKey Chaîne Votre clé API OpenTok. (Consultez votre Page de compte de l'API Video de Vonage.)
apiSecret Chaîne Votre clé secrète API OpenTok. (Consultez votre Page de compte de l'API Video de Vonage.)

Méthodes

Nom Description
addArchiveStream(archiveId, streamId, archiveOptions, callback) Ajoute un flux à une archive dont le paramètre `streamMode` est défini sur « manual ».
addBroadcastStream(broadcastId, streamId, broadcastOptions, callback) Ajoute un flux à une diffusion dont le paramètre `streamMode` est défini sur « manuel ».
createSession(options, callback) Crée une nouvelle session OpenTok.
deleteArchive(archiveId, callback) Supprime une archive OpenTok.
dial(sessionId, token, sipUri, options) Se connecte à une passerelle SIP pour intégrer un flux audio uniquement à votre session OpenTok.
disableForceMute(sessionId, callback) Désactive l'état de sourdine actif de la session.
forceDisconnect(sessionId, connectionId, callback) Déconnecte un participant d'une session OpenTok.
forceMuteAll(sessionId, opts, callback) Force tous les flux (à l'exception d'un tableau facultatif de flux) d'une session à couper le son de l'audio publié.
forceMuteStream(sessionId, streamId, callback) Forcer la mise en sourdine du son d'un flux spécifique au cours d'une session.
generateToken(sessionId, options, generateT1Token) Crée un jeton permettant de se connecter à une session OpenTok.
getArchive(archiveId, callback) Récupère un Archives objet correspondant à l'ID d'archive indiqué.
getBroadcast(broadcastId, callback) Renvoie des informations concernant une diffusion en direct.
getRender(renderId, callback) Récupère un Rendu objet correspondant à l'ID de rendu indiqué.
getStream(sessionId, options, callback) Récupère des informations sur un flux.
listArchives(options, callback) Récupère une liste de Archives objets, correspondant à des archives à la fois terminées et en cours, pour votre clé API.
listBroadcasts(options, callback) Récupère une liste de Radiodiffusion objets, correspondant aux diffusions terminées et en cours, pour votre clé API.
listRenders(options, callback) Récupère une liste de Rendu objets, représentant tous les rendus se trouvant dans l'état « débuté », « en cours », « arrêté » ou « échoué », pour votre clé API.
listStreams(sessionId, callback) Récupère une liste de Flux objets représentant les flux actuels d'une session.
playDTMF(sessionId, connectionId, digits, callback) Envoyer des chiffres DTMF à tous les participants d'une session OpenTok en cours ou à un client spécifique connecté à cette session.
removeArchiveStream(archiveId, streamId, callback) Supprime un flux d'une archive composée dont le paramètre `streamMode` est défini sur « manual ».
removeBroadcastStream(broadcastId, streamId, callback) Supprime un flux d'une diffusion dont le paramètre `streamMode` est défini sur « manual ».
setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback) Définit le type de mise en page d'une archive composée.
setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback) Définit (ou met à jour) la mise en page de la diffusion.
setStreamClassLists(sessionId, classListArray, callback) Définit la liste des classes de mise en page pour les flux d'une session.
signal(sessionId, connectionId, payload, callback) Envoie un signal à toutes les connexions d'une session ou à une connexion spécifique.
startArchive(sessionId, options, callback) Lance l'archivage d'une session OpenTok.
startBroadcast(sessionId, options, callback) Lance une diffusion en direct.
startCaptions(sessionId, token, options, callback) Active le sous-titrage en direct pour une session OpenTok.
startCaptions(captionId, callback)
startRender(options, callback) Lance l'Experience Composer pour une session OpenTok.
stopArchive(archiveId, callback) Arrête l'archivage OpenTok en cours d'enregistrement.
stopBroadcast(broadcastId, callback) Arrête une diffusion en direct.
stopRender(renderId, callback) Arrête un Experience Composer en cours de rendu.
websocketConnect(sessionId, token, websocketUri, options, callback) Envoie le flux audio d'une session de la Video API Vonage vers un WebSocket.

addArchiveStream(archiveId, streamId, archiveOptions, callback)

Ajoute un flux à une archive dont le paramètre `streamMode` est défini sur « manual ». Vous pouvez appeler cette méthode plusieurs fois avec le même identifiant de flux pour basculer entre l'audio et la vidéo du flux dans l'archive.

Paramètres :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive.
streamId Chaîne L'identifiant du flux à ajouter aux archives.
archiveOptions Objet Un objet présentant les propriétés suivantes : - 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 générée doit inclure la vidéo du flux (true, valeur par défaut) ou non (false).
callback fonction La fonction à appeler une fois l'opération terminée. Un argument est transmis à la fonction - error — Un objet d'erreur (si l'appel de la méthode échoue).

addBroadcastStream(broadcastId, streamId, broadcastOptions, callback)

Ajoute un flux à une diffusion dont le paramètre `streamMode` est défini sur « manual ». 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 :
Nom Type Description
broadcastId Chaîne L'identifiant de diffusion.
streamId Chaîne L'identifiant du flux à ajouter à la diffusion.
broadcastOptions Objet Un objet présentant les propriétés suivantes : - 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).
callback fonction Une méthode de rappel qui prend deux paramètres : error, qui est renseigné avec un objet « Error » en cas d'erreur, et broadcast, dont la valeur est définie sur un Radiodiffusion objet en cas de réussite.

createSession(options, callback)

Crée une nouvelle session OpenTok. La session est transmise sous la forme Session objet dans la fonction de rappel. La fonction sessionId La propriété correspond à l'identifiant de session, qui identifie de manière unique la session. En cas d'erreur, un objet Error est transmis à la fonction de rappel.

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 méthode `generateToken(String, TokenOptions)`). Notez également que les sessions ne peuvent pas être explicitement supprimées.

Une chaîne d'identification de session peut comporter jusqu'à 255 caractères. Vous pouvez également créer une session à l'aide de la commande API REST d'OpenTok ou en vous connectant à votre Compte Video API de Vonage.

Paramètres :
Nom Type Description
options Objet Cet objet définit les options de la session, notamment les propriétés suivantes (qui sont toutes deux facultatives) : - location (Chaîne) — Une adresse IP que les serveurs OpenTok utiliseront pour localiser la session au sein du réseau mondial OpenTok. Si vous ne définissez pas d'indication de localisation, les serveurs OpenTok se baseront sur le premier client se connectant à la session. - e2ee (Booléen) — Détermine s'il faut activer [end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption/) for the OpenTok session. Set to « vrai »or« false ». - mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router (« mis en déroute ») or not (« relayé »). By default, the setting is « relayé ». With the mediaModeparameter set to« relayé », the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams. The [OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits: - archiveMode (String) — Whether the session is automatically archived (« toujours ») or not (« manuel »). By default, the setting is « manuel », and you must call the StartArchive()method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set themediaModeparameter to « mis en déroute ». - nom_de_l'archive(String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, \_. -résolution d'archivage(Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080". - The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When themediaModeparameter is set to« relayé », chaque client doit envoyer un flux audio-vidéo distinct à chaque client qui s’y abonne.) - Le routeur multimédia OpenTok peut améliorer la qualité de l’expérience utilisateur grâce à solution de secours pour l'audio et récupération de la vidéo. Grâce à ces fonctionnalités, si la connexion d'un client se détériore au point de ne plus permettre la diffusion 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 plus que le son. Si la connexion du client s'améliore, la vidéo est rétablie. - Le routeur multimédia OpenTok prend en charge le archivage fonctionnalité qui vous permet d'enregistrer, de sauvegarder et de récupérer des sessions OpenTok.
callback fonction Fonction appelée une fois l'opération terminée. Cette fonction reçoit deux arguments : - error — En cas d'échec, ce paramètre prend la valeur d'un objet Error. Consultez le message d'erreur pour plus de détails. En cas de réussite, il prend la valeur null. - session — En cas de réussite, ce paramètre est défini sur un Session objet. La propriété sessionId de cet objet correspond à l'identifiant de la session. En cas d'erreur, ce paramètre n'est pas défini.

deleteArchive(archiveId, callback)

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 :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive que vous souhaitez supprimer.
callback fonction Fonction à appeler une fois l'opération terminée. Si la suppression de l'archive aboutit, la fonction est appelée sans argument. En cas d'échec, un objet d'erreur est transmis à la fonction.

dial(sessionId, token, sipUri, options)

Appelle une passerelle SIP pour intégrer un flux audio uniquement à votre session OpenTok. Fait partie de la fonctionnalité SIP.

Paramètres :
Nom Type Description
sessionId L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter.
token Le jeton correspondant à l'identifiant de session que l'utilisateur SIP utilisera pour se connecter.
sipUri L'URI SIP que la fonctionnalité d'interconnexion SIP va composer.
options Objet Un objet « options » facultatif comportant les propriétés suivantes (toutes facultatives) : - headers (Objet) — En-têtes personnalisés à ajouter à la requête SIP INVITE envoyée par OpenTok vers la plateforme SIP tierce. - auth (Objet) — Les identifiants à utiliser pour l'authentification HTTP Digest si celle-ci est requise par la plateforme SIP tierce. - « username » -- Le nom d'utilisateur à utiliser dans la requête SIP INVITE. - « password » -- Le mot de passe à utiliser dans la requête SIP INVITE. - secure (Booléen) — Indique si les flux multimédias SIP doivent être transmis de manière chiffrée ou non. - from (Chaîne) — Le nombre ou la chaîne qui sera envoyé(e) au numéro SIP final en tant qu'appelant. Il doit s'agir d'une chaîne au format from@example.comoù from peut être une chaîne de caractères ou un nombre. Si from est défini sur un nombre (par exemple, "14155550101@example.com"), il s'affichera comme numéro d'appelant sur les téléphones du réseau PSTN. Si from n'est pas défini ou est défini sur une chaîne de caractères (par exemple, "joe@example.com"), +00000000 s'affichera comme numéro de l'appelant sur les téléphones du réseau PSTN. - video (Booléen) — Un indicateur booléen qui précise si l'appel SIP inclura de la vidéo (true) ou non (false, par défaut). Lorsque la vidéo est incluse, la vidéo du client SIP est intégrée au flux OpenTok envoyé à la session OpenTok. Le client SIP recevra un flux vidéo composite dynamique constitué des flux publiés dans la session OpenTok. Il s'agit d'une fonctionnalité en version bêta. - observeForceMute (facultatif) Indique si le terminal SIP respecte les actions de mise en sourdine forcée effectuées par d'autres clients, tels que les modérateurs (true) ou pas (false, valeur par défaut). Voir Couper le son des flux audio d'une session. - streams (facultatif) Les identifiants des flux des participants auxquels le participant SIP s'abonnera. Si cette information n'est pas fournie, tous les flux de la session seront sélectionnés.
Retours :

A SipInterconnect objet présentant les propriétés suivantes :

  • id -- L'identifiant unique de la conférence pour l'appel SIP
  • connectionId -- L'identifiant de connexion du flux audio uniquement correspondant à l'appel SIP
  • streamId -- L'identifiant du flux audio seul représentant l'appel SIP

disableForceMute(sessionId, callback)

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 :
Nom Type Description
sessionId L'identifiant de session.
callback fonction La fonction à appeler une fois l'opération terminée. Un argument est transmis à cette fonction. error — une erreur indiquant que l'appel a échoué. Cette valeur est définie sur null si l'appel aboutit.

forceDisconnect(sessionId, connectionId, callback)

Déconnecte un participant d'une session OpenTok. Il s'agit de l'équivalent côté serveur de la commande Méthode `forceDisconnect()` dans OpenTok.js

Paramètres :
Nom Type Description
sessionId L'identifiant de la session OpenTok à laquelle est connecté le client que vous souhaitez déconnecter.
connectionId L'identifiant de connexion du client que vous souhaitez déconnecter.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel de la méthode échoue).

forceMuteAll(sessionId, opts, callback)

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.

Paramètres :
Nom Type Description
sessionId L'identifiant de session.
opts Un objet qui contient les propriétés suivantes : - excudedStreamIds (Tableau de chaînes de caractères) — Tableau contenant les identifiants des flux à exclure de la mise en sourdine. Ce paramètre est facultatif. Si vous ne définissez pas cette propriété, tous les flux de la session seront mis en sourdine.
callback fonction La fonction à appeler une fois l'opération terminée. Un argument est transmis à cette fonction. error — une erreur indiquant que l'appel a échoué. Cette valeur est définie sur null si l'appel aboutit.

forceMuteStream(sessionId, streamId, callback)

Forcer la mise en sourdine du son d'un flux spécifique au cours d'une session.

Paramètres :
Nom Type Description
sessionId Chaîne L'identifiant de session.
streamId Chaîne L'identifiant du flux.
callback fonction La fonction à appeler une fois l'opération terminée. Un argument est transmis à cette fonction. error — une erreur indiquant que l'appel a échoué. Cette valeur est définie sur null si l'appel aboutit.

generateToken(sessionId, options, generateT1Token)

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.

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

Paramètres :
Nom Type Description
sessionId L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter.
options Objet définissant les options du jeton (chacune d'entre elles étant facultative) : - role (Chaîne) — Le rôle associé au jeton. Chaque rôle définit un ensemble d'autorisations accordées au jeton : - 'subscriber' — Un abonné ne peut s'abonner qu'à des flux. - 'publisher' — 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 précisez pas de rôle.) - 'publisheronly' — Un éditeur peut uniquement publier des flux, mais ne peut pas s'abonner à des flux. - 'moderator' — 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 (Nombre) — Durée d'expiration du jeton, en secondes depuis l'époque UNIX. La durée d'expiration maximale est de 30 jours à compter de la date de création. Si un nombre décimal est spécifié, il est arrondi à l'entier inférieur le plus proche. La durée d'expiration par défaut est de 24 heures à compter de la date de création du jeton. - data (Chaîne) — Chaîne contenant les métadonnées de connexion décrivant l'utilisateur final. Par exemple, vous pouvez transmettre l'identifiant de l'utilisateur, son nom ou d'autres données le concernant. La longueur de la chaîne est limitée à 1 000 caractères. Ces données ne peuvent pas être modifiées une fois définies. - initialLayoutClassList (Tableau) — Tableau de noms de classes (chaînes de caractères) à utiliser comme classes de mise en page initiales pour les flux publiés par le client. Les classes de mise en page servent à personnaliser la mise en page des vidéos dans diffusions en direct et archives classées par thème.
generateT1Token Les jetons de connexion sont désormais des JWT signés avec l'algorithme SHA-256. Définissez cette valeur sur true pour créer un jeton au format T1 classique.
Retours :

La chaîne de caractères du jeton.

getArchive(archiveId, callback)

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

Paramètres :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - archive - Le Archives objet.

getBroadcast(broadcastId, callback)

Renvoie des informations concernant une diffusion en direct.

Paramètres :
Nom Type Description
broadcastId Chaîne L'identifiant de la diffusion.
callback fonction Une méthode de rappel qui prend deux paramètres : error, qui est renseigné avec un objet « Error » en cas d'erreur, et broadcast, dont la valeur est définie sur un Radiodiffusion objet en cas de réussite.

getRender(renderId, callback)

Récupère un Rendu objet correspondant à l'ID de rendu indiqué.

Paramètres :
Nom Type Description
renderId Chaîne L'identifiant du rendu.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - render - Le Rendu objet.

getStream(sessionId, options, callback)

Récupère des informations sur un flux. Le flux doit être actif dans une session OpenTok.

Paramètres :
Nom Type Description
sessionId Chaîne L'identifiant de la session OpenTok contenant le flux.
options Chaîne L'identifiant du flux.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). Il est défini sur null s'il n'y a pas d'erreur. L'appel de cette méthode génère une erreur si vous lui transmettez un identifiant de flux ou un identifiant de session non valide. - stream - Le Flux objet. Cet objet comprend des propriétés définissant le flux. Sa valeur est indéfinie en cas d'erreur.

listArchives(options, callback)

Récupère une liste de Archives objets, correspondant à des archives à la fois terminées et en cours, pour votre clé API.

Paramètres :
Nom Type Description
options Objet Un paramètre d'options comportant trois propriétés : - count — Nombre maximal d'archives à renvoyer. Par défaut, le nombre d'archives renvoyées est de 50 (ou moins, s'il y en a moins de 50). La méthode renvoie au maximum 1 000 archives. - offset — L'offset de la première archive à afficher (en commençant par la première archive enregistrée avec l'offset 0). 1 correspond à l'offset de l'archive qui a débuté avant l'archive la plus récente. Cette propriété est facultative ; la valeur par défaut est 0. - sessionId — Indiquez l'identifiant d'une session afin de récupérer les archives spécifiques à cette session. Cette propriété est facultative. Si aucun identifiant de session n'est spécifié, la méthode renverra les archives de toutes les sessions créées avec votre clé API. Si vous ne transmettez pas d' options argument, la méthode renvoie jusqu'à 1 000 archives, en commençant par la première archive enregistrée.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - archives - Un tableau de Archives objets.

listBroadcasts(options, callback)

Récupère une liste de Radiodiffusion objets, représentant les diffusions à la fois terminées et en cours, pour votre clé API.

Paramètres :
Nom Type Description
options Objet Un paramètre d'options comportant trois propriétés : - count — Nombre maximal de diffusions à renvoyer. Par défaut, le nombre de diffusions renvoyées est de 50 (ou moins, s'il y en a moins de 50). La méthode renvoie au maximum 1 000 diffusions. - offset — L'offset de la première diffusion de la liste (en partant de la première diffusion enregistrée, dont l'offset est 0). 1 correspond à l'offset de la diffusion qui a commencé avant la diffusion la plus récente. Cette propriété est facultative ; la valeur par défaut est 0. - sessionId — Indiquez l'identifiant d'une session afin de récupérer les diffusions spécifiques à cette session. Cette propriété est facultative. Si aucun identifiant de session n'est spécifié, la méthode renverra les diffusions de toutes les sessions créées avec votre clé API. Si vous ne transmettez pas d' options argument, la méthode renvoie jusqu'à 1 000 diffusions, en commençant par la première diffusion enregistrée.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - broadcasts - Un tableau de Radiodiffusion objets.

listRenders(options, callback)

Récupère une liste de Rendu objets, représentant tous les rendus se trouvant dans l'état « début », « en cours », « arrêté » ou « échec », pour votre clé API.

Paramètres :
Nom Type Description
options Objet Un paramètre d'options comportant trois propriétés : - count — Nombre maximal de rendus à renvoyer. Par défaut, le nombre de rendus renvoyés est de 50 (ou moins, s'il y en a moins de 50). La méthode renvoie au maximum 1 000 rendus. - offset — Le décalage du premier rendu de la liste (en partant du premier rendu enregistré, dont le décalage est 0). La valeur 1 correspond au décalage du rendu qui a commencé avant le rendu le plus récent. Cette propriété est facultative ; la valeur par défaut est 0. - sessionId — Indiquez l'identifiant d'une session afin de récupérer les rendus spécifiques à cette session. Cette propriété est facultative. Si aucun identifiant de session n'est spécifié, la méthode renverra les rendus de toutes les sessions créées avec votre clé API. Si vous ne transmettez pas d' options argument, la méthode renvoie jusqu'à 1 000 rendus, en commençant par le premier rendu enregistré.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - renders - Un tableau de Rendu objets.

listStreams(sessionId, callback)

Récupère une liste de Flux objets représentant les flux actuels d'une session.

Paramètres :
Nom Type Description
sessionId Chaîne L'identifiant de la session OpenTok contenant les flux.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel de la méthode échoue). Il est défini sur null s'il n'y a pas d'erreur. L'appel de cette méthode génère une erreur si vous lui transmettez un identifiant de session non valide. - streams - Un tableau de Flux objets. Chaque objet Stream comporte des propriétés définissant le flux. Cette valeur est indéfinie en cas d'erreur.

playDTMF(sessionId, connectionId, digits, callback)

Envoyer des chiffres DTMF à tous les participants d'une session OpenTok en cours ou à un client spécifique connecté à cette session.

Paramètres :
Nom Type Description
sessionId L'identifiant de session correspondant à 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 séquence de chiffres DTMF à envoyer. Elle peut comprendre les chiffres de 0 à 9, ainsi que les caractères « * », « # » et « p ». Le caractère « p » correspond à une pause de 500 ms (si vous devez ajouter un délai avant l'envoi des chiffres).
callback fonction Fonction à appeler une fois l'opération terminée. Un argument est transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). Il est défini sur null s'il n'y a pas d'erreur.

removeArchiveStream(archiveId, streamId, callback)

Supprime un flux d'une archive composée dont le paramètre `streamMode` est défini sur « manual ».

Paramètres :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive.
streamId Chaîne L'identifiant du flux à supprimer de l'archive.
callback fonction Fonction à appeler une fois l'opération terminée. Une erreur est transmise à cette fonction si l'appel échoue.

removeBroadcastStream(broadcastId, streamId, callback)

Supprime un flux d'une diffusion dont le paramètre `streamMode` est défini sur « manual ».

Paramètres :
Nom Type Description
broadcastId Chaîne L'identifiant de diffusion.
streamId Chaîne L'identifiant du flux à supprimer de la diffusion.
callback fonction Fonction à appeler une fois l'opération terminée. Une erreur est transmise à cette fonction si l'appel échoue.

setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback)

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 :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive.
type Chaîne Le type de mise en page. Définissez cette option sur « bestFit », « pip », « verticalPresentation », « horizontalPresentation », « focus » ou « custom ». Pour une description de ces types de mise en page, consultez Personnalisation de la présentation vidéo pour les archives composées.
stylesheet Chaîne (Facultatif) La feuille de style correspondant à une mise en page personnalisée. Définissez ce paramètre si vous configurez type à "custom". Sinon, ne le définissez pas ou attribuez-lui la valeur null.
screenshareType Chaîne (Facultatif) Type de mise en page à utiliser lorsqu'un flux de partage d'écran est présent dans la session. Notez que pour utiliser ce paramètre, vous devez définir le type paramètre sur « bestFit » et définissez le stylesheet au paramètre null.
callback fonction La fonction à appeler une fois l'opération terminée. En cas d'erreur, une error L'objet est transmis à la fonction. En cas de réussite, la fonction est appelée sans qu'aucun objet d'erreur ne lui soit transmis.

setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback)

Définit (ou met à jour) la mise en page de la diffusion. Voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok.

Paramètres :
Nom Type Description
broadcastId Chaîne L'identifiant de la diffusion.
type Chaîne Le type de mise en page. Définissez cette option sur « bestFit », « pip », « verticalPresentation », « horizontalPresentation », « focus » ou « custom ». Pour une description de ces types de mise en page, consultez Configuration de la mise en page pour les diffusions en direct OpenTok.
stylesheet Chaîne (Facultatif) La feuille de style correspondant à une mise en page personnalisée. Définissez ce paramètre si vous configurez type sur « custom ». Sinon, ne le définissez pas ou définissez-le sur null.
screenshareType Chaîne (Facultatif) Type de mise en page à utiliser lorsqu'un flux de partage d'écran est présent dans la session. Notez que pour utiliser ce paramètre, vous devez définir le type paramètre sur « bestFit » et définissez le stylesheet au paramètre null.
callback fonction Fonction à appeler une fois l'opération terminée. En cas d'erreur, un objet Error est transmis à la fonction. En cas de réussite, la fonction est appelée sans qu'aucun objet Error ne lui soit transmis.

setStreamClassLists(sessionId, classListArray, callback)

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 OpenTok.generateToken() méthode.

Paramètres :
Nom Type Description
sessionId Chaîne L'identifiant de la session à laquelle appartiennent les flux.
classListArray Tableau (Facultatif) Un tableau définissant les listes de classes à appliquer aux flux. Chaque élément du tableau est un objet comportant deux propriétés : id et layoutClassList. Les id La propriété correspond à l'identifiant du flux (une chaîne de caractères), et la layoutClassList est un tableau de noms de classes (chaînes de caractères) à appliquer au flux. Définir layoutClassList vers un tableau vide pour effacer la liste des classes de mise en page d'un flux. Par exemple, ceci streamClassArray array définit la liste des classes de mise en page pour trois flux : const classListArray = [ { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] }, { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] }, { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] } ];
callback fonction La fonction à appeler une fois l'opération terminée. En cas d'erreur, une error L'objet est transmis à la fonction. En cas de réussite, la fonction est appelée sans qu'aucun objet d'erreur ne lui soit transmis.

signal(sessionId, connectionId, payload, callback)

Envoie un signal à toutes les connexions d'une session ou à une connexion spécifique.

Les clients doivent être activement connectés à la session OpenTok pour que vous puissiez leur envoyer un signal.

Pour plus d'informations, voir le Signalisation OpenTok guide des programmes.

Paramètres :
Nom Type Description
sessionId L'identifiant de la session OpenTok vers laquelle vous souhaitez envoyer le signal.
connectionId L'identifiant de connexion d'un client connecté à la session. Laissez ce champ vide si vous souhaitez envoyer un signal à toutes les connexions de la session.
payload Un objet avec des paramètres facultatifs data et type propriétés : - data — Les données à envoyer. La longueur maximale de la chaîne de données est de 8 ko. Ne définissez pas la chaîne de données sur « null » ou « undefined ». - type — Le type du signal. Les clients peuvent utiliser ce type pour filtrer les signaux. La longueur maximale de la chaîne de caractères correspondant au type est de 128 caractères.
callback fonction Fonction de rappel appelée lorsque l'appel à la méthode aboutit ou échoue. Si l'appel échoue, un objet d'erreur est transmis à la fonction de rappel.

startArchive(sessionId, options, callback)

Lance l'archivage d'une session OpenTok.

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 utilisant OpenTok Media Router (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 ».

Paramètres :
Nom Type Description
sessionId L'identifiant de la session OpenTok à archiver.
options Objet Un objet « options » facultatif comportant les propriétés suivantes (chacune d'entre elles étant facultative) : - name (Chaîne) — nom de l'archive, que vous pouvez utiliser pour l'identifier. Ce nom est défini en tant que propriété de l'objet Archive et constitue une propriété des événements liés à l'archive dans les bibliothèques client OpenTok. - hasAudio (Booléen) — Indique si l'archive comprendra une piste audio (true) ou non (false). La valeur par défaut est true (une piste audio est incluse). Si vous configurez les deux hasAudio et hasVideo à false, l'appel vers le startArchive() Cette méthode génère une erreur. - hasVideo (Booléen) — Indique si l'archive comprendra une piste vidéo (true) ou (pas false). La valeur par défaut est true (une piste vidéo est incluse). Si vous configurez les deux hasAudio et hasVideo à false, l'appel vers le startArchive() Cette méthode génère une erreur. - outputMode (Chaîne) — Indique si tous les flux de l'archive sont enregistrés dans un seul fichier (« composé », valeur par défaut) ou dans des fichiers distincts (« individuels »). - layout (Objet) — Objet définissant les options de mise en page initiales d'une archive composée. Cet objet possède trois propriétés : type, stylesheetet screenshareType, qui sont toutes des chaînes de caractères. Définir type sur « bestFit », « pip », « verticalPresentation », « horizontalPresentation » ou « custom ». Définissez le stylesheet propriété si type est défini sur « custom », et configurez-le pour qu'il pointe vers la feuille de style définissant la mise en page personnalisée. Par exemple, définissez le layout à l'objet { type: "pip" } pour définir la disposition initiale de l'archive en mode « image dans l'image ». Définissez le screenshareType propriété permettant de définir le type de mise en page à utiliser lorsqu'un flux de partage d'écran est présent dans la session (Cette propriété est facultative.) Remarque : si vous définissez la screenshareType propriété, vous devez définir la type propriété à « bestFit » et laisser le stylesheet Propriété non définie. Pour plus de détails, voir Personnalisation de la mise en page vidéo pour les archives composées. - resolution (Chaîne de caractères) — Pour une archive composée, définissez cette valeur sur la résolution de l'archive. Les valeurs valides sont « 1920x1080 », « 1280x720 » ou « 640x480 » (valeur par défaut). - streamMode (facultatif) — Mode de diffusion pour l'archive. Il peut être défini sur l'une des valeurs suivantes : - « auto » — Les flux inclus dans l'archive sont sélectionnés automatiquement (valeur par défaut). - « manual » — Spécifiez les flux à inclure en fonction des appels à la méthode OpenTok.addArchiveStream() et OpenTok.removeArchiveStream() méthodes. - multiArchiveTag (Chaîne) — Définissez cette option pour permettre l'enregistrement simultané de plusieurs archives pour une même session. Attribuez une chaîne unique à chaque archive simultanée d'une session en cours. Vous devez également activer cette option lorsque vous lancez manuellement une archive qui est normalement archivée automatiquement. Notez que le multiArchiveTag Cette valeur n'est pas incluse dans la réponse des méthodes permettant de répertorier les archives et d'obtenir des informations sur celles-ci. Si vous ne spécifiez pas de valeur unique multiArchiveTag Vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. - maxBitrate (Numbers) — Débit binaire vidéo maximal de l'archive, en bits par seconde. Cette option n'est valable que pour les archives composées. Définissez le débit binaire vidéo maximal pour contrôler la taille de l'archive composée. Ce débit binaire maximal s'applique uniquement au débit binaire vidéo. Si l'archive de sortie contient de l'audio, ces bits seront exclus de la limite. Pour plus d'informations sur l'archivage et les formats de fichiers d'archive, consultez la Archivage OpenTok guide de programmation.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - archive - Le Archives objet. Cet objet comprend des propriétés définissant l'archive, notamment son identifiant.

startBroadcast(sessionId, options, callback)

Lance une diffusion en direct. Voir la diffusion en direct guide du développeur.

Paramètres :
Nom Type Description
sessionId Chaîne L'identifiant de la session à diffuser.
options Objet Un objet présentant la forme suivante : { outputs: { hls: { dvr: false, lowLatency: false, }, rtmp: [{ id: "foo", serverUrl: "rtmp://myfooserver/myfooapp", streamName: "myfoostream" }, { id: "bar", serverUrl: "rtmp://mybarserver/mybarapp", streamName: "mybarstream" }] }, maxDuration: 5400, resolution: "640x480", layout: { type: "custom", stylesheet: "the layout stylesheet (only used with type == custom)", screenshareType: "the layout type to use when there is a screen-sharing stream (optional)" }, streamMode: "manual" } Le options L'objet comprend les propriétés suivantes : - outputs (obligatoire) — Cet objet définit les types de flux de diffusion que vous souhaitez lancer. Vous pouvez inclure des flux HLS, RTMP ou les deux comme flux de diffusion. Si vous incluez la diffusion RTMP, vous pouvez spécifier jusqu’à cinq flux RTMP cibles (ou un seul). Pour le HLS, incluez un seul hls propriété de l'objet « outputs ». Cet objet comprend les propriétés facultatives suivantes : - dvr (Booléen) — Indique s'il faut activer Fonctionnalité DVR — le retour en arrière, la mise en pause et la reprise — sur les lecteurs qui prennent en charge ces fonctions (true), ou pas (false, valeur par défaut). Lorsque la fonction DVR est activée, l'URL HLS inclura un ?DVR chaîne de requête ajoutée à la fin. - lowLatency (Booléen) — Indique s'il faut activer 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. L'URL HLS est renvoyée dans le broadcastUrls en tant que hls bien immobilier situé dans le Radiodiffusion objet transmis aux méthodes de rappel de la OpenTok#getBroadcast et les méthodes OpenTok#listBroadcast. Pour chaque flux RTMP, précisez serverUrl (l'URL du serveur RTMP), streamName (le nom du flux, par exemple le nom du flux YouTube Live ou la clé du flux Facebook), et (facultatif) id (un identifiant unique pour le flux). Si vous indiquez un identifiant, celui-ci sera inclus en tant que id propriété de la Radiodiffusion objet transmis aux méthodes de rappel de la startBroadcast() méthode et la OpenTok.getBroadcast() méthode. OpenTok diffuse la session vers chaque URL RTMP que vous spécifiez. Notez que la diffusion en direct d'OpenTok prend en charge les protocoles RTMP et RTMPS. - maxDuration (facultatif) — 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 4 heures (14 400 secondes). - resolution (facultatif) — La résolution de la diffusion : soit "640x480" (SD, valeur par défaut), "1280x720" (HD) ou "1920x1080" (FHD). layout (facultatif) — Indiquez cette option pour définir le type de mise en page initiale de la diffusion. Cet objet comporte trois propriétés : type, stylesheetet screenshareType, qui sont toutes des chaînes de caractères. Les valeurs valides pour le type les propriétés sont les suivantes : "bestFit" (meilleur ajustement), "custom" (sur mesure), "horizontalPresentation" (présentation horizontale), "pip" (image dans l'image) et "verticalPresentation" (présentation verticale)). Si vous spécifiez un "custom" définir le type de mise en page stylesheet de la propriété layout ajouter la feuille de style. (Pour les autres types de mise en page, ne définissez pas de stylesheet propriété.) Si vous ne spécifiez pas de type de mise en page initiale, le flux de diffusion utilise le type de mise en page « Best Fit ». Définissez le screenshareType propriété du type de mise en page à utiliser lorsqu'un flux de partage d'écran est présent dans la session. (Cette propriété est facultative.) Remarque : si vous définissez la screenshareType propriété, vous devez définir la type à "bestFit" et laisser la propriété stylesheet n'est pas définie. Pour plus d'informations, voir Configuration de la disposition vidéo pour les diffusions en direct OpenTok).- streamMode (facultatif) — Mode de diffusion pour la diffusion. Il peut être défini sur l'une des valeurs suivantes : - « auto » — Les flux inclus dans la diffusion sont sélectionnés automatiquement (valeur par défaut). - « manual » — Spécifiez les flux à inclure en fonction des appels à la fonction OpenTok.addBroadcastStream() et OpenTok.removeBroadcastStream() méthodes. - multiBroadcastTag (facultatif) — Définissez ce paramètre pour prendre en charge plusieurs diffusions simultanées d'une même session. Attribuez une chaîne de caractères unique à chaque diffusion simultanée d'une session en cours. Notez que le multiBroadcastTag Cette valeur n'est pas incluse dans la réponse pour les méthodes permettant de répertorier les diffusions en direct et d'obtenir des informations sur une diffusion en direct.
callback fonction Une méthode de rappel qui prend deux paramètres : error, qui est renseigné avec un objet « Error » en cas d'erreur, et broadcast, dont la valeur est définie sur un Radiodiffusion objet en cas de réussite.

startCaptions(sessionId, token, options, callback)

Active le sous-titrage en direct pour une session OpenTok.

La durée maximale autorisée est de 4 heures, après quoi le sous-titrage audio s'arrêtera sans aucune incidence sur la session OpenTok en cours. Un événement sera envoyé à votre URL de rappel si celle-ci a été fournie au moment du lancement du sous-titrage.

Chaque session OpenTok ne prend en charge qu'une seule session de sous-titrage audio.

Paramètres :
Nom Type Description
sessionId L'identifiant de la session OpenTok à archiver.
token Un jeton OpenTok valide dont le rôle est défini sur « Modérateur ».
options Objet Un objet « options » facultatif comportant les propriétés suivantes (chacune d'entre elles étant facultative) : - languageCode (Chaîne) — Code BCP-47 de la langue parlée utilisée lors de cet appel. La valeur par défaut est « en-US ». Les codes de langue suivants sont pris en charge : « en-AU » (anglais, Australie), « en-GB » (anglais, Royaume-Uni), « en-us » (anglais, États-Unis), « es-US » (espagnol, États-Unis), « zh-CN » (chinois simplifié), « fr-FR » (français), « fr-CA » (français canadien), « de-DE » (allemand), « hi-IN » (hindi indien), « it-IT » (italien), « ja-JP » (japonais), « ko-KR » (coréen), « pt-BR » (portugais, Brésil), « th-TH » (thaï). - maxDuration (Entier) — Durée maximale du sous-titrage audio, en secondes. La valeur par défaut est 14 400 secondes (4 heures), ce qui correspond à la durée maximale autorisée. La valeur minimale pour maxDuration est 300 (300 secondes, soit 5 minutes). - partialCaptions (Booléen) — Indique s'il faut activer cette option pour accélérer la génération des sous-titres, au prix d'un certain degré d'imprécision. La valeur par défaut est « true ». Pour plus d'informations sur les sous-titres, consultez la Sous-titres OpenTok guide de programmation.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - captionID — L'identifiant des légendes

startCaptions(captionId, callback)

Désactive le sous-titrage en direct pour une session OpenTok

Paramètres :
Nom Type Description
captionId L'identifiant de la session OpenTok à archiver. Pour plus d'informations sur les sous-titres, consultez la Sous-titres OpenTok guide de programmation.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - success — C'est toujours vrai

startRender(options, callback)

Lance un Experience Composer pour une session OpenTok. L'instance d'Experience Composer est représentée sous la forme d'un objet Render. Pour plus d'informations, consultez la Guide du développeur Experience Composer.

Les clients doivent être activement connectés à la session OpenTok pour que vous puissiez lancer correctement le rendu d'une session.

Paramètres :
Nom Type Description
options Objet Un objet « options » facultatif comportant les propriétés suivantes (chacune d'entre elles étant facultative) : - sessionId (Chaîne) — L'identifiant d'une session (généré avec le même APIKEY(comme indiqué dans l'URL) dans laquelle vous souhaitez commencer le rendu — token (Chaîne) — Un jeton OpenTok valide doté du rôle « Publisher » et (facultatif) des données de connexion à associer au flux de sortie. - url (Chaîne de caractères) — Une URL accessible au public, gérée par le client et capable de générer le contenu à afficher sans intervention de l'utilisateur. - properties (Objet) — Configuration initiale des propriétés de l'éditeur pour le flux de sortie composé. - maxDuration (Numbers) — Durée maximale autorisée pour le rendu, en secondes. Passé ce délai, le rendu sera automatiquement interrompu s'il est toujours en cours. - resolution (Chaîne) — Résolution de la zone d'affichage de la composition.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - render - Le Rendu objet. Cet objet comprend des propriétés définissant le rendu, notamment l'identifiant du rendu.

stopArchive(archiveId, callback)

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.

Vous ne pouvez pas arrêter une archive qui n'est pas en cours d'enregistrement.

Paramètres :
Nom Type Description
archiveId Chaîne L'identifiant de l'archive dont vous souhaitez interrompre l'enregistrement.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - archive - Le Archives objet.
Retours :

Les Archives objet correspondant à l'archive en cours d'ARRÊT.

stopBroadcast(broadcastId, callback)

Arrête une diffusion en direct.

Paramètres :
Nom Type Description
broadcastId Chaîne L'identifiant de la diffusion.
callback fonction Une méthode de rappel qui prend deux paramètres : error, qui est renseigné avec un objet « Error » en cas d'erreur, et broadcast, dont la valeur est définie sur un Radiodiffusion objet en cas de réussite.

stopRender(renderId, callback)

Arrête un Experience Composer en cours de rendu.

Paramètres :
Nom Type Description
renderId Chaîne L'identifiant du rendu que vous souhaitez interrompre.
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - render - Le Rendu objet.
Retours :

Les Archives objet correspondant à l'archive en cours d'ARRÊT.

websocketConnect(sessionId, token, websocketUri, options, callback)

Envoie le flux audio d'une session de la Video API Vonage vers un WebSocket. Consultez la Connecteur audio guide du développeur.

Paramètres :
Nom Type Description
sessionId Chaîne (obligatoire) L'identifiant de session OpenTok qui regroupe les flux OpenTok que vous souhaitez inclure dans le flux WebSocket
token Chaîne (obligatoire) Le jeton OpenTok à utiliser pour la connexion de l'Audio Streamer à la session OpenTok. Vous pouvez ajouter des données de jeton permettant d'identifier que la connexion provient du point de terminaison Audio Streamer ou d'autres données d'identification.
websocketUri Chaîne (obligatoire) Une URI WebSocket accessible au public, qui servira de destination au flux audio (par exemple « wss://service.com/ws-endpoint »).
options Objet Un objet « options » facultatif comportant les propriétés suivantes (toutes facultatives) : - streams (Tableau) — Tableau contenant les identifiants des flux OpenTok que vous souhaitez inclure dans le flux WebSocket. Si vous omettez cette propriété, tous les flux de la session seront inclus. - headers (Objet) — Objet contenant des paires clé-valeur d'en-têtes à envoyer à votre serveur WebSocket avec chaque message, d'une longueur maximale de 512 octets.
callback fonction La fonction à appeler une fois l'opération terminée. En cas d'erreur, une error L'objet est transmis en tant que premier paramètre de la fonction. En cas de réussite, la fonction est appelée sans qu'aucun objet d'erreur ne lui soit transmis (en tant que premier paramètre) et le deuxième paramètre est un objet présentant les propriétés suivantes : - id -- Un identifiant unique permettant d'identifier la connexion WebSocket de l'Audio Streamer. - connectionId -- L'identifiant de connexion OpenTok correspondant à la connexion WebSocket de l'Audio Streamer dans la session OpenTok.