Documentation d'OpenTok.js

OpenTok.js comprend les classes suivantes :

Classe	Description
ArchiveÉvénement	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Événement « AudioInputDeviceChanged »	Pour plus d'informations, consultez cette documentation.
Événement de mise à jour du niveau audio	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Capacités	Toutes les propriétés de Capabilities sont indéfinies tant que vous ne vous êtes pas connecté à une session et que l'objet Session n'a pas déclenché l'événement sessionConnected.
CaptionReceivedEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Connexion	L'objet `Session` dispose d'une propriété `connection` qui est un objet `Connection`. Elle représente la connexion du client local. (Un client ne dispose d'une connexion qu'une fois qu'il a appelé avec succès la méthode `connect()` de l'objet `Session`.)
ConnectionEvent	L'objet Session déclenche un événement `connectionCreated` lorsqu'un client (y compris le vôtre) se connecte à une session. Il déclenche également un événement `connectionCreated` pour chaque client de la session lors de votre première connexion. (Lorsque votre client local se connecte, l'objet Session déclenche également un événement `sessionConnect`)
CpuPerformanceChangedEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Erreur	La classe `Error` définit également l'exception `Error` levée lorsque la promesse renvoyée par l'une des méthodes suivantes est rejetée :
Événement	Par exemple, l'objet `Stream` déclenche un événement `streamPropertyChanged` lorsque les propriétés du flux sont mises à jour. Pour ajouter un rappel à un événement, on utilise la méthode `on()` de l'objet `Stream` :
EventDispatcher	Obsolète — utilisez plutôt on() ou once().
ExceptionEvent	Notez que vous configurez une fonction de rappel pour l'événement d'exception en appelant la méthode OT.on().
MediaStoppedEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Événement « MediaStreamAvailable »	Notez que le son sera diffusé à la fois via l'élément personnalisé et via le widget « Publisher » ou « Subscriber ». Les éléments personnalisés doivent être mis en sourdine pour éviter l'écho.
MuteForcedEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
OT	Initialise et renvoie un objet Publisher.
Éditeur	Le code suivant instancie une session et publie un flux audio-vidéo dès la connexion à la session :
Événement de modification du Quality Score	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Session	Obsolète — utilisez plutôt on() ou once().
SessionConnectEvent	Dans la version 2.2, la méthode `completionHandler` de la méthode `Session.connect()` indique si la connexion à la session a abouti ou a échoué.
SessionDisconnectEvent	Le code suivant initialise une session et met en place un écouteur d'événement pour détecter la déconnexion de la session.
SignalEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Flux	Lorsqu'un flux est ajouté à une session, l'objet Session déclenche un événement `streamCreatedEvent`. Lorsqu'un flux est détruit, l'objet Session déclenche un événement `streamDestroyed`. L'objet `StreamEvent`, qui définit ces objets d'événement, dispose d'une propriété `stream`, qui est un tableau d'objets `Stream`. Pour plus de détails
Événement de flux	Le code suivant se connecte à une session et configure un écouteur d'événements pour détecter la création d'un flux publié par un autre client :
StreamPropertyChangedEvent	Pour savoir si un événement dispose d'un comportement par défaut, vérifiez la propriété `cancelable` de l'objet événement.
Abonné	Obsolète — utilisez plutôt on() ou once().
Événement « VideoDimensionsChanged »	Du côté de l'éditeur, cet événement se déclenche lorsque l'élément vidéo local de l'éditeur détecte un changement de dimensions. Lorsque l'éditeur est en cours de publication, cela met également à jour la propriété `stream.videoDimensions`. Exemples de situations pouvant entraîner un redimensionnement de l'élément vidéo local : le redimensionnement d'une fenêtre de partage d'écran capturée.
Événement de création d'un élément vidéo	N'ajoutez un écouteur pour cet événement que si vous avez défini l'option `insertDefaultUI` sur `false`. Si vous n'avez pas défini l'option `insertDefaultUI` sur `false`, ne déplacez pas l'élément `video` (ou l'élément `object` contenant la vidéo dans Internet Explorer) dans le DOM HTML. Cela entraînerait une erreur de l'éditeur ou de l'abonné
VideoEnabledChangedEvent	Si la connexion s'améliore et permet à nouveau la diffusion de la vidéo, l'objet « Subscriber » déclenche un événement « videoEnabled », et le « Subscriber » recommence à recevoir la vidéo.