StreamEvent est un événement pouvant prendre la valeur « streamCreated » ou « streamDestroyed ». Ces événements sont déclenchés par l'objet Session lorsqu'un autre client commence ou cesse de publier un flux vers un Session. Pour le flux d'un client local, l' objet Publisher déclenche l'événement.

Exemple — Événement « streamCreated » déclenché par l'objet Session

Le code suivant se connecte à une session et configure un écouteur d'événements pour être averti lorsqu' un flux publié par un autre client est créé :

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

Exemple — Événement « streamDestroyed » déclenché par l'objet Session

Le code suivant se connecte à une session et met en place un écouteur d'événements pour être averti lorsque les flux d'autres clients prennent fin :

session.on("streamDestroyed", function(event) {
    console.log("Stream " + event.stream.name + " ended. " + event.reason);
}).connect(token);

Exemple — Événement « streamCreated » déclenché par un objet Publisher

Le code suivant publie un flux et ajoute un écouteur d'événement pour signaler le début de la diffusion

var publisher = session.publish(targetElement)
  .on("streamCreated", function(event) {
    console.log("Publisher started streaming.");
  });

Exemple — Événement « streamDestroyed » déclenché par un objet Publisher

Le code suivant publie un flux et conserve l'éditeur dans le DOM HTML lorsque la diffusion prend fin :

var publisher = session.publish(targetElement)
  .on("streamDestroyed", function(event) {
    event.preventDefault();
    console.log("Publisher stopped streaming.");
  });

Propriétés

Nom Type Description
cancelable Booléen Que l'événement dispose ou non d'un comportement par défaut pouvant être annulé (true) ou non (false). Vous pouvez désactiver le comportement par défaut en appelant la méthode preventDefault() méthode de l'objet StreamEvent dans la fonction d'écoute d'événements. La streamDestroyed L'événement peut être annulé. (Voir preventDefault().)
reason Chaîne Pour un streamDestroyed événement, une description expliquant pourquoi le flux a été détruit. Cette propriété peut prendre l'une des valeurs suivantes : - "clientDisconnected" — Un client s'est déconnecté de la session en appelant la disconnect() méthode de l'objet Session ou en fermant le navigateur. (Voir Session.disconnect().) - "forceDisconnected" — Un modérateur a déconnecté l'auteur du flux de la session, en appelant la fonction forceDisconnect() méthode de l'objet `Session`. (Voir Session.forceDisconnect().) - "forceUnpublished" — Un modérateur a contraint l'éditeur du flux à cesser la diffusion de celui-ci, en faisant appel au forceUnpublish() méthode de l'objet `Session`. (Voir Session.forceUnpublish().) - "mediaStopped" — L'utilisateur qui diffuse le flux a cessé de partager des contenus multimédias. Par exemple, l’utilisateur a fermé la fenêtre qui servait de source à un flux de partage d’écran. Ou bien l’utilisateur a déconnecté un microphone qui servait de source audio à un flux audio seul. Ou encore, les sources vidéo et audio sont des éléments MediaStreamTrack et les sources des médias ont été arrêtées ou détruites. - "networkDisconnected" — La connexion réseau a été interrompue brusquement (par exemple, le client a perdu sa connexion Internet) et cela a été détecté par la plateforme Video API de Vonage. - "reset" — Le flux d’un diffuseur a été supprimé à la suite d’un signalement concernant son Publisher.destroy() méthode. - "serverRotation" — Le flux de l'éditeur a été interrompu car le client a été déconnecté de la session en raison de Rotation des serveurs de la Video API. Selon le contexte, cette description peut permettre au développeur d'affiner la ligne de conduite qu'il adopte en réponse à un événement. Pour un streamCreated événement, cette chaîne n'est pas définie.
stream Flux Un objet `Stream` correspondant au flux qui a été ajouté (dans le cas d'un streamCreated événement) ou supprimé (dans le cas d'un streamDestroyed événement).
streams Tableau Obsolète. Utilisez la fonction stream propriété. A streamCreated ou streamDestroyed Un événement est déclenché à chaque fois qu'un flux est ajouté ou supprimé.

Méthodes

Nom Description
isDefaultPrevented() → {Boolean} Que le comportement par défaut de l'événement ait été désactivé ou non par un appel à preventDefault() (true) ou non (false).
preventDefault() Empêche le comportement par défaut associé à l'événement de se produire.

isDefaultPrevented() → {Boolean}

Que le comportement par défaut de l'événement ait été empêché ou non par un appel à preventDefault() (true) ou non (false). Voir preventDefault().

Retours :

preventDefault()

Empêche le comportement par défaut associé à l'événement de se produire.

Pour les streamDestroyed événement déclenché par l'objet Session, le comportement par défaut est que 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 nettoyer les objets « Subscriber » à l'aide de votre propre code. Voir Session.getSubscribersForStream().

Pour les streamDestroyed Lorsqu'un événement est déclenché par un objet Publisher, le comportement par défaut consiste à supprimer cet objet Publisher du DOM HTML. L'objet Publisher 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 événement, le comportement par défaut est désactivé, et vous pouvez conserver l'éditeur pour le réutiliser ou le nettoyer à l'aide de votre propre code.

Pour savoir si un événement a un comportement par défaut, vérifiez le cancelable propriété de l'objet événement.

Appeler le preventDefault() méthode dans la fonction d'écouteur d'événement associée à cet événement.