L'objet Session renvoyé par la OT.initSession() Cette méthode permet d'accéder à une grande partie des fonctionnalités de la Video API de Vonage.

Propriétés

Méthodes

addEventListener(type, listener, context)

Paramètres :

Déclassé — utilisation on() ou une fois() au lieu de cela.

Cette méthode permet d'enregistrer une méthode en tant qu'écouteur d'événement pour un événement spécifique.

Si aucun gestionnaire n'est enregistré pour un événement, celui-ci est ignoré localement. Si la fonction d'écoute d'événement n'existe pas, l'événement est ignoré localement.

Lance une exception si le listener Le nom n'est pas valide.

Voir : : - on() - une fois() - Evénements

connect(token, completionHandler)

Se connecte à une session de la Video API Vonage.

Une fois la connexion établie, le gestionnaire de fin d'exécution (le deuxième paramètre de la méthode) est appelé sans qu'aucun objet d'erreur ne lui soit transmis. (En cas d'erreur lors de la connexion, le gestionnaire de fin d'exécution est appelé avec un objet d'erreur.) Assurez-vous que la connexion à la session a bien été établie avant d'appeler d'autres méthodes de l'objet Session.

L'objet Session envoie un connectionCreated événement déclenché lorsqu'un client (y compris le vôtre) se connecte à la session.

Exemple

Le code suivant initialise une session et configure un écouteur d'événement pour le moment où la session se connecte :

 var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
 var sessionID = ""; // Replace with your own session ID.
                     // See https://tokbox.com/developer/guides/create-session/.
 var token = ""; // Replace with a generated token.
                 // See https://tokbox.com/developer/guides/create-token/.

 var session = OT.initSession(apiKey, sessionID);
 session.connect(token, function(error) {
   if (error) {
     console.log(error.message);
   } else {
     // You have connected to the session. You could publish a stream now.
   }
 });

Événements déclenchés :

exception (ExceptionEvent) — Envoyé par la classe OT locale en cas d'erreur.

connectionCreated (ConnectionEvent) — Diffusé par l'objet « Session » à tous les clients connectés à la session.

sessionConnected (SessionConnectEvent) — Appelé localement par l'objet Session lorsque la connexion est établie. Cependant, vous pouvez passer une fonction de gestion de fin d'exécution en tant que deuxième paramètre de la connect() et utiliser cette fonction à la place d'un écouteur pour le sessionConnected événement.

Paramètres :

Voir : : - SessionConnectEvent

disableForceMute() → {Promise}

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.

Une fois que vous aurez appelé le Session.forceMuteAll() méthode (ou lorsqu'un modérateur d'un autre client lance une commande pour couper le son de tous les flux), tous les flux publiés après cette commande de modération sont publiés avec le son coupé. Appelez la disableForceMute() méthode permettant de désactiver la mise en sourdine d'une session (afin que les nouveaux flux publiés ne soient pas automatiquement mis en sourdine).

L'appel de cette méthode entraîne l'envoi d'un message par l'objet Session de chaque client connecté, muteForced avec l'événement active indicateur défini sur false.

Vérifier le capabilities.canForceMute propriété de l'objet Session pour vérifier si vous pouvez appeler cette fonction sans problème. Cette fonctionnalité est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Création de jetons (documentation).

Voir : : - Session.capabilities - Session.forceMuteAll() - Événement « muteForced »

Retours :

Une promesse qui renvoie une valeur nulle lorsque l'opération s'achève avec succès. La promesse est rejetée en cas d'erreur. La name La propriété de l'objet Error prend l'une des valeurs suivantes, en fonction du type d'erreur :

• 'OT_NOT_CONNECTED' — Le client n'est pas connecté à la session.
• 'OT_PERMISSION_DENIED' — Le rôle de l'utilisateur ne comprend pas les autorisations nécessaires pour forcer d'autres utilisateurs à se mettre en mode silencieux. Vous définissez le rôle d'un utilisateur lorsque vous créez son jeton d'utilisateur (voir la Présentation de la création de jetons). Vous transmettez la chaîne de caractères du jeton en tant que paramètre de la fonction connect() méthode de l'objet Session.
• 'OT_UNEXPECTED_SERVER_RESPONSE' — En cas d'erreur interne du serveur.

disconnect() → {Promise.<void>}

Se déconnecte de la session de la Video API Vonage.

Appeler le disconnect() Cette méthode met fin à votre connexion à la session. Lors de la clôture de votre connexion, elle interrompt également la diffusion de tout flux que vous étiez en train de diffuser.

Distribution des objets de session sur les clients distants streamDestroyed événements pour tout flux que vous publiez. L'objet Session déclenche un sessionDisconnected événement au niveau local. Les objets Session sur les clients distants déclenchent connectionDestroyed événements, afin d'informer les autres participants que vous avez quitté la session. Le SessionDisconnectEvent et Événement de flux objets qui définissent le sessionDisconnect et connectionDestroyed Chaque événement dispose d'un reason propriété. Le reason Cette propriété permet au développeur de déterminer si la connexion est interrompue volontairement et si des flux sont détruits à la suite de la destruction volontaire de la connexion sous-jacente.

Si la session n'est pas actuellement connectée, l'appel de cette méthode entraîne l'enregistrement d'un avertissement dans le journal. Voir OT.setLogLevel().

Remarque : Si vous comptez réutiliser un objet Publisher pour publier successivement dans différentes sessions (ou dans la même session), ajoutez un écouteur d'événement pour le streamDestroyed événement déclenché par l'objet Publisher (lorsqu'il cesse de publier). Dans le gestionnaire d'événements, appelez la méthode preventDefault() méthode de l'objet « event » afin d'empêcher que la vidéo de l'éditeur ne soit supprimée de la page.

Événements déclenchés :

sessionDisconnected (SessionDisconnectEvent) — Envoyé localement lorsque la connexion est interrompue.

connectionDestroyed (ConnectionEvent) — Envoyé sur d'autres clients, en même temps que le streamDestroyed événement (le cas échéant).

streamDestroyed (Événement de flux) — Envoyé sur d'autres clients en cas de perte de flux suite à la déconnexion de la session.

Retours :

Une promesse qui sera résolue lorsque l'événement `sessionDisconnected` sera déclenché

forceDisconnect(connexion, gestionnaire de fin) → {Promise.<void>}

Force la connexion à distance à se déconnecter de la session.

Les forceDisconnect() Cette méthode est généralement utilisée comme outil de modération pour exclure des utilisateurs d'une session en cours.

Lorsqu'une connexion est interrompue à l'aide de la commande forceDisconnect(), sessionDisconnected, connectionDestroyed et streamDestroyed Les événements sont déclenchés de la même manière que s’ils avaient été générés si la connexion s’était interrompue d’elle-même à l’aide de la disconnect() méthode. Cependant, la reason d'un ConnectionEvent ou Événement de flux L'objet spécifie "forceDisconnected" comme cause de la rupture de la connexion et du ou des flux.

Bien que vous puissiez utiliser le forceDisconnect() méthode permettant de mettre fin à votre propre connexion, en appelant la disconnect() Cette méthode est plus simple.

L'objet OT déclenche un exception même si le rôle de l'utilisateur ne dispose pas des autorisations nécessaires pour forcer d'autres utilisateurs à se déconnecter. Vous définissez le rôle d'un utilisateur lors de la création de son jeton d'utilisateur (voir la section Présentation de la création de jetons). Voir ExceptionEvent et OT.on().

L'application génère une erreur si la session n'est pas connectée.

Événements déclenchés :

connectionDestroyed (ConnectionEvent) — Sur les clients autres que ceux dont la connexion a été interrompue.

exception (ExceptionEvent) — Le rôle de l'utilisateur ne lui permet pas de forcer d'autres utilisateurs à se déconnecter (event.code = 1530), ou bien le flux spécifié ne diffuse pas vers la session (event.code = 1535).

sessionDisconnected (SessionDisconnectEvent) — Sur le client dont la connexion a été interrompue.

streamDestroyed (Événement de flux) — Si les flux sont interrompus à la suite de la fin de la connexion.

Paramètres :

Retours :

Une promesse qui se résout au moment où la déconnexion se produit

forceMuteAll(excludedStreams) → {Promise}

Oblige tous les diffuseurs de la session (à l'exception de ceux qui diffusent des flux exclus) à couper le son.

Un flux publié par le modérateur appelant le forceMuteAll() La méthode est mise en sourdine avec les autres flux de la session, à moins que vous n'ajoutiez le ou les flux du modérateur à le tableau des flux exclus.

Si vous ne tenez pas compte de la excludedStreams paramètre, tous les flux de la session (y compris ceux du modérateur) cesseront de diffuser du son :

session.forceMuteAll();

De même, tous les flux publiés après l'appel à la fonction forceMuteAll() méthode sont publiées avec le son désactivé. Vous pouvez désactiver la mise en sourdine d'une session en appelant la disableForceMute() méthode de l'objet Session.

session.disableForceMute();

Après avoir appelé le Session.disableForceMute() Grâce à cette méthode, les nouveaux flux publiés dans la session ne seront plus mis en sourdine.

L'appel de cette méthode entraîne la diffusion par les objets Publisher des clients qui publient les flux muteForced événements. De plus, l'objet Session de chaque client connecté à la session déclenche le muteForced événement (avec le active de l'objet de l'événement à true).

Vérifier le capabilities.canForceMute propriété de l'objet Session pour vérifier si vous pouvez appeler cette fonction sans problème. Cette fonctionnalité est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Création de jetons (documentation).

Paramètres :

Voir : : - Session.capabilities - Session.forceMuteStream() - Session.disableForceMute() - Événement « muteForced » de la session - Événement « muteForced » de l'éditeur - Couper le son des flux vidéo dans une session

Retours :

Une promesse qui renvoie une valeur nulle lorsque l'opération s'achève avec succès. La promesse est rejetée en cas d'erreur. La name La propriété de l'objet Error prend l'une des valeurs suivantes, en fonction du type d'erreur :

• 'OT_NOT_CONNECTED' — Le client n'est pas connecté à la session.
• 'INVALID_PARAMETER' — si un ou plusieurs des paramètres transmis ne sont pas valides.
• 'OT_PERMISSION_DENIED' — Le rôle de l'utilisateur ne comprend pas les autorisations nécessaires pour forcer d'autres utilisateurs à se mettre en mode silencieux. Vous définissez le rôle d'un utilisateur lorsque vous créez son jeton d'utilisateur (voir la Présentation de la création de jetons). Vous transmettez la chaîne de caractères du jeton en tant que paramètre de la fonction connect() méthode de l'objet Session.
• 'OT_UNEXPECTED_SERVER_RESPONSE' — en cas d'erreur interne du serveur.

forceMuteStream(stream) → {Promise}

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

L'appel de cette méthode entraîne l'objet Publisher du client publiant le flux à déclencher un muteForced événement.

Vérifier le capabilities.canForceMute propriété de l'objet Session pour vérifier si vous pouvez appeler cette fonction sans problème. Cette fonctionnalité est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel le rôle de modérateur a été attribué (voir la Création de jetons (documentation).

Paramètres :

Voir : : - Session.capabilities - Session.forceMuteAll() - Événement « muteForced » de l'éditeur - Couper le son des flux vidéo dans une session

Retours :

Une promesse qui renvoie une valeur nulle lorsque l'opération s'achève avec succès. La promesse est rejetée en cas d'erreur. La name La propriété de l'objet Error prend l'une des valeurs suivantes, en fonction du type d'erreur :

• 'OT_NOT_CONNECTED' — Le client n'est pas connecté à la session.
• 'OT_INVALID_PARAMETER' — si un ou plusieurs des paramètres transmis ne sont pas valides.
• 'OT_PERMISSION_DENIED' — Le rôle de l'utilisateur ne comprend pas les autorisations nécessaires pour forcer d'autres utilisateurs à se mettre en mode silencieux. Vous définissez le rôle d'un utilisateur lorsque vous créez son jeton d'utilisateur (voir la Présentation de la création de jetons). Vous transmettez la chaîne de caractères du jeton en tant que paramètre de la fonction connect() méthode de l'objet Session.
• 'OT_NOT_FOUND' — Le flux n'a pas été trouvé au cours de cette session.
• 'OT_UNEXPECTED_SERVER_RESPONSE' — En cas d'erreur interne du serveur.

forceUnpublish(stream, completionHandler) → {Promise.<void>}

Force l'éditeur du flux spécifié à cesser la publication de ce flux.

L'appel de cette méthode entraîne l'envoi par l'objet Session d'un streamDestroyed événement sur tous les clients abonnés au flux (y compris le client qui publie le flux). Le reason La propriété de l'objet StreamEvent est définie sur "forceUnpublished".

L'objet OT déclenche un exception même si le rôle de l'utilisateur ne comprend pas les autorisations nécessaires pour obliger d'autres utilisateurs à retirer une publication. Vous définissez le rôle d'un utilisateur lorsque vous créez son jeton d'utilisateur (voir la section Présentation de la création de jetons). Vous transmettez la chaîne de caractères du jeton en tant que paramètre de la fonction connect() méthode de l'objet Session. Voir ExceptionEvent et OT.on().

Événements déclenchés :

exception (ExceptionEvent) — Le rôle de l'utilisateur ne lui permet pas d'obliger d'autres utilisateurs à retirer une publication.

streamDestroyed (Événement de flux) — Le flux a été désactivé. L'objet Session diffuse cette information à tous les clients abonnés au flux, ainsi qu'au client de l'éditeur.

Paramètres :

Retours :

Une promesse qui se résout lorsque la suppression de la publication a lieu

getPublisherForStream(stream) → {Éditeur}

Renvoie l'objet Publisher local associé à un flux donné.

Paramètres :

Voir : : - forceUnpublish() - Abonné - Événement de flux

Retours :

Un objet Publisher correspondant au flux spécifié. Renvoie null s'il n'existe aucun objet Publisher local pour le flux spécifié.

getSubscribersForStream(stream) → {Array}

Renvoie un tableau d'objets « Subscriber » locaux pour un flux donné.

Paramètres :

Voir : : - unsubscribe() - Abonné - Événement de flux

Retours :

Un tableau de Abonné objets pour le flux spécifié.

off(type, gestionnaire, contexte) → {Object}

Supprime un ou plusieurs gestionnaires d'événements.

Si vous transmettez un nom d'événement et une méthode de gestion, cette dernière est supprimée pour cet événement :

obj.off("eventName", eventHandler);

Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est supprimée pour ces événements :

obj.off("eventName1 eventName2", eventHandler);

Si vous transmettez un ou plusieurs noms d'événements et non méthode de gestionnaire, tous les gestionnaires sont supprimés pour ces événements :

obj.off("event1Name event2Name");

Si vous ne passez aucun argument, tous les gestionnaires d'événements sont supprimés pour tous les événements déclenchés par l'objet :

obj.off();

Cette méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet qui constitue une table de correspondance entre les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) est le contexte utilisé pour chaque gestionnaire :

obj.off(
   {
      eventName1: event1Handler,
      eventName2: event2Handler
   });

Paramètres :

Voir : : - on() - une fois() - Evénements

Retours :

L'objet qui a déclenché l'événement.

on(type, handler, context) → {EventDispatcher}

Ajoute une fonction de gestion d'événements pour un ou plusieurs événements.

Le code suivant ajoute un gestionnaire d'événement pour un événement :

obj.on("eventName", function (event) {
    // This is the event handler.
});

Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est enregistrée pour chacun de ces événements :

obj.on("eventName1 eventName2",
       function (event) {
           // This is the event handler.
       });

Vous pouvez également passer un troisième context paramètre (facultatif) permettant de définir la valeur de this dans la méthode de gestionnaire :

obj.on("eventName",
       function (event) {
           // This is the event handler.
       },
       obj);

La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet représentant une table associative contenant les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte utilisé pour chaque gestionnaire :

obj.on(
   {
      eventName1: function (event) {
              // This is the handler for eventName1.
          },
      eventName2:  function (event) {
              // This is the handler for eventName2.
          }
   },
   obj);

Si vous n'ajoutez pas de gestionnaire pour un événement, celui-ci est ignoré au niveau local.

Paramètres :

Voir : : - off() - une fois() - Evénements

Retours :

L'objet EventDispatcher.

once(type, handler, context) → {Object}

Ajoute une fonction de gestion d'événements pour un ou plusieurs événements. Une fois que la fonction de gestion est appelée, la méthode de gestion spécifiée est supprimée en tant que gestionnaire de cet événement. (Lorsque vous utilisez la on() méthode permettant d'ajouter un gestionnaire d'événements ; ce gestionnaire est pas est supprimé lorsqu’il est appelé.) Le once() Cette méthode équivaut à appeler la on() méthode et appel off() lors de la première invocation du gestionnaire.

Le code suivant ajoute un gestionnaire d'événement ponctuel pour un événement :

obj.once("eventName", function (event) {
   // This is the event handler.
});

Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est enregistrée pour chacun de ces événements :

obj.once("eventName1 eventName2"
         function (event) {
             // This is the event handler.
         });

Vous pouvez également passer un troisième context paramètre (facultatif) permettant de définir la valeur de this dans la méthode de gestionnaire :

obj.once("eventName",
         function (event) {
             // This is the event handler.
         },
         obj);

La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet qui constitue une table de correspondance entre les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte utilisé pour chaque gestionnaire :

obj.once(
   {
      eventName1: function (event) {
                 // This is the event handler for eventName1.
          },
      eventName2:  function (event) {
                 // This is the event handler for eventName1.
          }
   },
   obj);

Paramètres :

Voir : : - on() - off() - Evénements

Retours :

L'objet qui a déclenché l'événement.

publish(éditeur, gestionnaire_de_fin)

Les publish() La méthode commence à diffuser un flux audio-vidéo vers la session. Le flux audio-vidéo est capté à partir d'un microphone et d'une webcam locaux. Une fois la diffusion réussie, les objets Session de tous les clients connectés transmettent le streamCreated événement.

Vous transmettez un objet `Publisher` en tant que seul paramètre de la méthode. Vous pouvez initialiser un objet `Publisher` en appelant la méthode OT.initPublisher() méthode. Avant d'appeler Session.publish().

Cette méthode se présente sous une autre forme : publish(targetElement: String | HTMLElement, properties: Object, completionHandler: Function): Publisher — Dans ce formulaire, vous devez pas ne transmettez pas d'objet Publisher à la fonction. À la place, vous transmettez un targetElement (l'élément HTML cible ou l'identifiant de l'élément HTML cible pour l'éditeur), un paramètre facultatif properties objet qui définit les options de l'éditeur (voir OT.initPublisher()), ainsi qu'une fonction de gestion des finitions facultative. La méthode renvoie un nouvel objet `Publisher`, qui commence à envoyer un flux audio-vidéo vers la session. La suite de cette documentation décrit la forme qui prend un seul objet `Publisher` comme paramètre.

Un affichage local du flux publié est créé sur la page Web en remplaçant l'élément spécifié dans le DOM par un affichage vidéo en streaming. Le flux vidéo est automatiquement inversé horizontalement afin que les utilisateurs puissent se voir et observer les mouvements dans leur flux de manière naturelle. Si la largeur et la hauteur de l'affichage ne correspondent pas au format 4:3 du signal vidéo, le flux vidéo est recadré pour s'adapter à l' affichage.

Si l'appel de cette méthode crée un nouvel objet Publisher et que la bibliothèque Video API Vonage n'a pas accès à la caméra ou au microphone, la page Web invite l'utilisateur à autoriser l'accès à la caméra et au microphone.

L'objet OT déclenche un exception même si le rôle de l'utilisateur ne comprend pas les autorisations nécessaires à la publication. Par exemple, si le rôle de l'utilisateur est défini sur « abonné », il ne peut pas publier. Vous définissez le rôle d'un utilisateur lorsque vous créez son jeton d'utilisateur (voir Présentation de la création de jetons). Vous transmettez la chaîne de caractères du jeton en tant que paramètre de la fonction connect() méthode de l'objet Session. Voir ExceptionEvent et OT.on().

L'application génère une erreur si la session n'est pas connectée.

Événements déclenchés :

exception (ExceptionEvent) — Envoyé par l'objet OT. Cela peut se produire lorsque le rôle de l'utilisateur ne lui permet pas de publier (le code la propriété de l'objet événement est définie sur 1 500) ; cela peut également se produire si la connexion échoue (le code la propriété de l'objet événement est définie sur 1013). WebRTC est un protocole peer-to-peer, et il est possible que certaines connexions échouent. La cause la plus courante d'échec est un pare-feu que le protocole ne parvient pas à traverser.

streamCreated (Événement de flux) — Le flux a été publié. L'objet Session diffuse cette information à tous les clients abonnés au flux, ainsi qu'au client de l'éditeur.

Exemple

L'exemple suivant publie une vidéo dès que la session est établie :

var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionId = ""; // Replace with your own session ID.
                    // /developer/guides/create-session/.
var token = ""; // Replace with a generated token that has been assigned the publish role.
                // See https://tokbox.com/developer/guides/create-token/.
var session = OT.initSession(apiKey, sessionID);
session.connect(token, function(error) {
  if (error) {
    console.log(error.message);
  } else {
    var publisherOptions = {width: 400, height:300, name:"Bob's stream"};
    // This assumes that there is a DOM element with the ID 'publisher':
    publisher = OT.initPublisher('publisher', publisherOptions);
    session.publish(publisher);
  }
});

Paramètres :

Retours :

L'objet Publisher correspondant à ce flux.

removeEventListener(type, listener, context)

Paramètres :

Déclassé — utilisation off() au lieu de cela.

Supprime un écouteur d'événement pour un événement spécifique.

Lance une exception si le listener Le nom n'est pas valide.

Voir : : - off() - Evénements

setEncryptionSecret(secret) → {Promise}

Définit la clé de chiffrement pour une session dans laquelle le chiffrement de bout en bout est activé. Si cette méthode est appelée dans une session où le chiffrement n'est pas activé, la fonction s'exécutera sans générer d'erreur. Les utilisateurs peuvent modifier leur clé de chiffrement à tout moment. Voir la section sur le chiffrement de bout en bout guide du développeur.

Paramètres :

Voir : : - OT.initSession - Événements réservés aux abonnés

Retours :

Une promesse qui renvoie une valeur nulle lorsque l'opération s'achève avec succès. La promesse est rejetée en cas d'erreur. La name La propriété de l'objet Error prend l'une des valeurs suivantes, en fonction du type d'erreur :

• 'OT_INVALID_ENCRYPTION_SECRET'; Le mot de passe n'est pas valide.

Un décalage caché peut se produire lorsqu'aucune erreur n'est signalée. Voir événements destinés aux abonnés pour plus d'informations.

setIceConfig(newIceConfig)

Définit la configuration ICE pour toutes les connexions d'une session. Cela remplace toute configuration ICE précédemment définie.

Cette fonctionnalité est disponible pour les projets qui utilisent le configurable Module complémentaire TURN server.

Paramètres :

Voir : : - OT.initSession()

signal(signal, gestionnaireDeFin) → {Promise.<void>}

Envoie un signal à chaque client ou à un client spécifique de la session. Spécifiez un to de la propriété signal paramètre permettant de limiter l'envoi du signal à un client spécifique ; sinon, le signal est envoyé à chaque client connecté à la session.

L'exemple suivant envoie un signal de type « foo » contenant une charge utile spécifiée (« hello ») à tous les clients connectés à la session :

try {
  await session.signal({
    type: "foo",
    data: "hello"
  });
  console.log("signal sent");
} catch (error) {
  console.log("signal error: " + error.message);
}

L'appel de cette méthode sans spécifier de client destinataire (en définissant le to propriété de la signal (paramètre) entraîne l'envoi de plusieurs signaux (un à chaque client de la session). Pour plus d'informations sur la facturation de la signalisation, consultez la Tarifs de la Video API Vonage page.

L'exemple suivant envoie un signal de type « foo » contenant une charge utile (« hello ») à un client spécifique connecté à la session :

try {
  await session.signal({
    type: "foo",
    to: recipientConnection, // a Connection object
    data: "hello"
  });
  console.log("signal sent");
} catch (error) {
  console.log("signal error: " + error.message);
}

Ajouter un gestionnaire d'événements pour le signal événement permettant de détecter tous les signaux envoyés au cours de la session. Ajoutez un gestionnaire d'événements pour le signal:type événement permettant de détecter uniquement les signaux d'un type donné (remplacer type, dans signal:type, avec le type de signal à surveiller). L'objet Session diffuse ces événements. (Voir événements.)

Paramètres :

Voir : : - signal et signal : type événements

Retours :

Une promesse qui se résout une fois que le signal a été envoyé

subscribe(flux, élémentCible, propriétés, gestionnaireDeFin) → {Abonné}

S'abonne à un flux accessible à la session. Vous pouvez récupérer un tableau des flux disponibles à partir de la streams de la propriété sessionConnected et streamCreated événements (voir SessionConnectEvent et Événement de flux).

Le flux auquel l'utilisateur est abonné s'affiche sur la page Web locale en remplaçant l'élément spécifié dans le DOM par un affichage vidéo en streaming. Si la largeur et la hauteur de l'affichage ne correspondent pas au format 4:3 du signal vidéo, le flux vidéo est recadré pour s'adapter à l'affichage. Si le flux ne comporte pas de composante vidéo, un écran vide accompagné d’un indicateur audio s’affiche à la place du flux vidéo.

L'application génère une erreur si la session n'est pas connectée ou si le targetElement n'existe pas dans le DOM HTML.

Exemple

Le code suivant permet de s'abonner aux flux d'autres clients :

var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionID = ""; // Replace with your own session ID.
                    // See https://tokbox.com/developer/guides/create-session/.
var token = ""; // Replace with a generated token.
                // See https://tokbox.com/developer/guides/create-token/.

var session = OT.initSession(apiKey, sessionID);
session.on("streamCreated", function(event) {
  subscriber = session.subscribe(event.stream, targetElement);
});
session.connect(token);

Paramètres :

Retours :

L'objet « Subscriber » correspondant à ce flux. Les fonctions de contrôle du flux sont accessibles via l'objet « Subscriber ».

retirer de la publication (éditeur)

Cesse de diffuser le flux audio-vidéo de l'éditeur spécifié vers la session. Par défaut, la représentation locale du flux audio-vidéo est supprimée de la page Web. Une fois la fermeture effectuée avec succès, l'objet Session de chaque page Web connectée déclenche un streamDestroyed événement.

Pour éviter que l'éditeur ne soit supprimé du DOM, ajoutez un écouteur d'événement pour l'élément streamDestroyed événement déclenché par l'objet Publisher et appeler la méthode preventDefault() méthode de l'objet événement.

Remarque : Si vous comptez réutiliser un objet Publisher pour publier successivement dans différentes sessions (ou dans la même session), ajoutez un écouteur d'événement pour le streamDestroyed événement déclenché par l'objet Publisher (lorsqu'il cesse de publier). Dans le gestionnaire d'événements, appelez la méthode preventDefault() méthode de l'objet « event » afin d'empêcher que la vidéo de l'éditeur ne soit supprimée de la page.

Événements déclenchés :

streamDestroyed (Événement de flux) — Le flux associé à l'éditeur a été supprimé. Émis par l' éditeur sur son navigateur. Émis par l'objet Session sur toutes les autres connexions abonnées au flux de l'éditeur.

Exemple

L'exemple suivant publie un flux vers une session et ajoute un lien « Se déconnecter » à la page Web. Un clic sur ce lien met fin à la publication du flux.

<script>
  var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
  var sessionID = ""; // Replace with your own session ID.
                   // See https://tokbox.com/developer/guides/create-session/.
  var token = ""; // Replace with a generated token.
                  // See https://tokbox.com/developer/guides/create-token/.
  var publisher;
  var session = OT.initSession(apiKey, sessionID);
  session.connect(token, function(error) {
    if (error) {
      console.log(error.message);
    } else {
      // This assumes that there is a DOM element with the ID 'publisher':
      publisher = OT.initPublisher('publisher');
      session.publish(publisher);
    }
  });

  function unpublish() {
    session.unpublish(publisher);
  }
</script>

<body>

    <div id="publisherContainer/>
    <br/>

    [Stop Publishing](javascript:unpublish())

</body>

Paramètres :

Voir : : - publish() - Événement « streamDestroyed »

se désabonner (abonné)

Met fin à l'abonnement à un flux dans la session. L'affichage du flux audio-vidéo est supprimé de la page Web locale.

Exemple

Le code suivant permet de s'abonner aux flux d'autres clients. Pour chaque flux, le code ajoute également un lien « Se désabonner ».

var apiKey = ""; // Replace with your API key. See See https://tokbox.com/account
var sessionID = ""; // Replace with your own session ID.
                    // See https://tokbox.com/developer/guides/create-session/.
var token = ""; // Replace with a generated token.
                // See https://tokbox.com/developer/guides/create-token/.
var streams = [];

var session = OT.initSession(apiKey, sessionID);
session.on("streamCreated", function(event) {
    var stream = event.stream;
    displayStream(stream);
});
session.connect(token);

function displayStream(stream) {
    var div = document.createElement('div');
    div.setAttribute('id', 'stream' + stream.streamId);

    var subscriber = session.subscribe(stream, div);
    subscribers.push(subscriber);

    var aLink = document.createElement('a');
    aLink.setAttribute('href', 'javascript: unsubscribe("' + subscriber.id + '")');
    aLink.innerHTML = "Unsubscribe";

    var streamsContainer = document.getElementById('streamsContainer');
    streamsContainer.appendChild(div);
    streamsContainer.appendChild(aLink);

    streams = event.streams;
}

function unsubscribe(subscriberId) {
    console.log("unsubscribe called");
    for (var i = 0; i < subscribers.length; i++) {
        var subscriber = subscribers[i];
        if (subscriber.id == subscriberId) {
            session.unsubscribe(subscriber);
        }
    }
}

Paramètres :

Voir : : - s'abonner()

Evénements

archiveCréée

Envoyé dès le début de l'enregistrement d'archive de la session.

Voir : : - ArchiveÉvénement - Vue d'ensemble de l'archivage

archiveArrêté

Envoyé lorsque l'enregistrement d'archive de la session s'arrête.

Voir : : - ArchiveÉvénement - Vue d'ensemble de l'archivage

connexionCréée

Déclenché lorsqu'un nouveau client (y compris le vôtre) s'est connecté à la session, et pour chaque client de la session lors de votre première connexion. (L'objet Session déclenche également un sessionConnected événement qui se produit lorsque votre client local se connecte.)

Voir : : - ConnectionEvent - OT.initSession()

connexion interrompue

Un client, autre que le vôtre, s'est déconnecté de la session.

Voir : : - ConnectionEvent

cpuPerformanceChanged

L'état de performance du processeur a changé. Il peut prendre l'une des valeurs suivantes : « nominal », « modéré », « grave » ou « critique ».

Voir : : - CpuPerformanceChangedEvent

muteForced

Un modérateur a contraint les clients diffusant des flux vers la session à couper le son (le active La propriété de cet objet MuteForcedEvent est définie sur true), ou un modérateur a désactivé la fonction de mise en sourdine du son dans la session (le active La propriété de cet objet `MuteForcedEvent` est définie sur false).

Voir : : - MuteForcedEvent - Session.forceMuteAll() - Session.disableForceMute() - Couper le son des flux vidéo dans une session

sessionConnected

Le client s'est connecté à une session de la Video API. Cet événement est déclenché de manière asynchrone en réponse à un appel réussi vers la connect() méthode d'un objet `Session`. Avant d'appeler la connect() méthode, initialisez la session en appelant la OT.initSession() méthode. Pour un exemple de code et plus de détails, voir Session.connect().

Voir : : - SessionConnectEvent - Session.connect() - OT.initSession()

session déconnectée

Le client s'est déconnecté de la session. Cet événement peut être déclenché de manière asynchrone en réponse à un appel réussi vers la disconnect() méthode de l'objet Session. Cet événement peut également être déclenché si une connexion de session est interrompue de manière inopinée, comme dans le cas d'une perte de connexion réseau.

Par défaut, tous les objets « Subscriber » sont désabonnés et supprimés du DOM HTML. Chaque objet « Subscriber » déclenche un destroyed événement déclenché lorsque l'élément est supprimé du DOM HTML. Si vous appelez la méthode preventDefault() méthode dans l' écouteur d'événement pour le sessionDisconnect Lors de cet événement, le comportement par défaut est désactivé, et vous pouvez, si vous le souhaitez, nettoyer les objets « Subscriber » à l'aide de votre propre code.

Les reason La propriété de l'objet événement indique la raison pour laquelle le client a été déconnecté.

Voir : : - Session.disconnect() - Session.forceDisconnect() - SessionDisconnectEvent

sessionReconnected

Le client local s'est reconnecté à la session de la Video API après une perte temporaire de connexion. En cas de perte de connexion, l'objet Session déclenche un sessionReconnecting événement, avant le sessionReconnected événement. Si le client ne parvient pas à se reconnecter à la session, l'objet Session déclenche un sessionDisconnected cet événement plutôt que celui-ci.

Les éditeurs et abonnés existants sont automatiquement reconnectés lorsque le client se reconnecte et que l'objet Session déclenche cet événement.

Tous les signaux envoyés par d'autres clients pendant que votre client était déconnecté sont reçus lors de la reconnexion. Par défaut, les signaux émis par le client local alors qu'il était déconnecté (en appelant la fonction Session.signal() (méthode) sont envoyés lorsque le client se reconnecte à la session de la Video API. Vous pouvez empêcher cela en configurant le retryAfterReconnect propriété à false dans le signal que vous passez dans l'objet Session.signal() méthode.

Voir : : - Événement - Événement « sessionReconnecting » - Événement « sessionDisconnected »

Reconnexion à la session

Le client local a perdu sa connexion à une session de la Video API Vonage et tente de se reconnecter. Cela résulte d'une perte de connectivité réseau. Si le client parvient à se reconnecter à la session, l'objet Session déclenche un sessionReconnected événement. Sinon, si le client ne parvient pas à se reconnecter, l'objet Session déclenche un sessionDisconnected événement.

Face à cet événement, vous pouvez afficher une notification dans l'interface utilisateur afin d'informer l'utilisateur que l'application tente de se reconnecter à la session et que les flux audio et vidéo sont temporairement interrompus.

Voir : : - Événement - Événement « sessionReconnected » - Événement « sessionDisconnected »

signal

Un signal a été reçu depuis la session. Le SignalEvent La classe définit cet objet d'événement. Elle comprend les propriétés suivantes :

• data — (Chaîne) La chaîne de données envoyée avec le signal (le cas échéant).
• from — (Connexion) La connexion correspondant au client qui a envoyé le signal.
• type — (Chaîne) Le type attribué au signal (s'il y en a un).

Vous pouvez vous inscrire pour recevoir tous les signaux envoyés au cours de la session, en ajoutant un gestionnaire d'événements pour le signal événement. Par exemple, le code suivant ajoute un gestionnaire d'événements pour traiter tous les signaux envoyés au cours de la session :

session.on("signal", function(event) {
  console.log("Signal sent from connection: " + event.from.id);
  console.log("Signal data: " + event.data);
});

Vous pouvez vous abonner aux signaux d'un type donné en ajoutant un gestionnaire d'événements pour le signal:type événement (en remplacement de type avec la chaîne de caractères correspondant au type réel sur laquelle effectuer le filtrage).

Voir : : - Session.signal() - SignalEvent - signal : type événement

streamCreated

Un nouveau flux, publié par un autre client, a été créé au cours de cette session. Pour les flux publiés par votre propre client, l'objet Publisher envoie un streamCreated événement. Pour un exemple de code et plus de détails, consultez Événement de flux.

Voir : : - Événement de flux - Session.publish()

streamDestroyed

Un flux provenant d'un autre client a cessé d'être publié dans la session.

Par défaut, tous les objets « Subscriber » abonnés au flux sont désabonnés et supprimés du DOM HTML. Chaque objet « Subscriber » déclenche un destroyed événement déclenché lorsque l'élément est supprimé du DOM HTML. Si vous appelez la méthode preventDefault() méthode dans l'écouteur d'événement pour le streamDestroyed Dans ce cas, le comportement par défaut est désactivé et vous pouvez libérer un objet « Subscriber » associé au flux en appelant sa méthode destroy() méthode. Voir Session.getSubscribersForStream().

Pour les flux publiés par votre propre client, l'objet Publisher envoie un streamDestroyed événement.

Pour consulter un exemple de code et obtenir plus de détails, voir Événement de flux.

Voir : : - Événement de flux

streamPropertyChanged

Définit un événement déclenché lorsqu'une propriété d'un flux a changé. Cela peut se produire dans les conditions suivantes :

• Un flux a commencé ou cessé de diffuser du contenu audio, des sous-titres ou de la vidéo (voir Publisher.publishAudio(), Publisher.publishCaptions() et Publisher.publishVideo()). Remarque : la vidéo d'un abonné peut être désactivée ou activée pour des raisons autres que la décision de l'éditeur de la désactiver ou de l'activer. Un objet « Abonné » déclenche videoDisabled et videoEnabled les événements, quelles que soient les conditions, qui entraînent la désactivation ou l'activation du flux de l'abonné.
• Les videoDimensions La propriété de l'objet Stream a changé (voir Stream.videoDimensions).
• Les videoType Une propriété de l'objet Stream a changé. Cela peut se produire dans un flux publié par un appareil mobile. (Voir Stream.videoType.)

Voir : : - StreamPropertyChangedEvent - Publisher.publishAudio() - Publisher.publishCaptions() - Publisher.publishVideo() - Stream.hasAudio - Stream.hasCaptions - Stream.hasVideo - Stream.videoDimensions - Vidéo réservée aux abonnés — Événement désactivé - Événement avec vidéos réservées aux abonnés

signal : type

Un signal du type spécifié a été reçu depuis la session. Le SignalEvent La classe définit cet objet d'événement. Elle comprend les propriétés suivantes :

• data — (Chaîne) La chaîne de données envoyée avec le signal.
• from — (Connexion) La connexion correspondant au client qui a envoyé le signal.
• type — (Chaîne) Le type attribué au signal (le cas échéant).

Vous pouvez vous abonner aux signaux d'un type donné en ajoutant un gestionnaire d'événements pour le signal:type événement (en remplacement de type avec la chaîne de caractères correspondant au type réel sur lequel effectuer le filtrage). Par exemple, le code suivant ajoute un gestionnaire d'événements pour les signaux de type « foo » :

session.on("signal:foo", function(event) {
  console.log("foo signal sent from connection " + event.from.id);
  console.log("Signal data: " + event.data);
});

Vous pouvez vous inscrire pour recevoir tous les signaux envoyés au cours de la session, en ajoutant un gestionnaire d'événements pour le signal événement.

Voir : : - Session.signal() - SignalEvent - signal événement