OpenTok.js-Referenz

OpenTok.js enthält die folgenden Klassen:

Klasse	Beschreibung
Archiv-Veranstaltung	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
AudioInputDeviceChangedEvent	Weitere Informationen finden Sie in dieser Dokumentation.
AudioLevelUpdatedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Fähigkeiten	Alle Eigenschaften von „Capabilities“ sind undefiniert, bis Sie eine Verbindung zu einer Sitzung hergestellt haben und das „Session“-Objekt das Ereignis „sessionConnected“ ausgelöst hat.
CaptionReceivedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Verbindung	Das Session-Objekt verfügt über eine „connection“-Eigenschaft, bei der es sich um ein Connection-Objekt handelt. Diese repräsentiert die Verbindung des lokalen Clients. (Ein Client verfügt erst dann über eine Verbindung, wenn er die Methode „connect()“ des Session-Objekts erfolgreich aufgerufen hat.)
Verbindungsereignis	Das Session-Objekt löst ein „connectionCreated“-Ereignis aus, wenn ein Client (einschließlich Ihres eigenen) eine Verbindung zu einer Session herstellt. Außerdem löst es bei der ersten Verbindungsherstellung für jeden Client in der Session ein „connectionCreated“-Ereignis aus. (Wenn Ihr lokaler Client eine Verbindung herstellt, löst das Session-Objekt zudem ein „sessionConnect“-Ereignis aus.)
CpuPerformanceChangedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Fehler	Die Klasse „Error“ definiert außerdem den Fehler, der ausgelöst wird, wenn das von einer der folgenden Methoden zurückgegebene Promise abgelehnt wird:
Veranstaltung	Beispielsweise löst das Stream-Objekt ein „streamPropertyChanged“-Ereignis aus, wenn die Eigenschaften des Streams aktualisiert werden. Einen Callback für ein Ereignis fügen Sie mithilfe der on()-Methode des Stream-Objekts hinzu:
EventDispatcher	Veraltet – verwende stattdessen on() oder once().
Ausnahmeereignis	Beachten Sie, dass Sie durch den Aufruf der Methode OT.on() einen Callback für das Ausnahmereignis einrichten.
MediaStoppedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
MediaStreamAvailableEvent	Beachten Sie, dass der Ton sowohl über das benutzerdefinierte Element als auch über das Publisher- oder Subscriber-Widget wiedergegeben wird. Die benutzerdefinierten Elemente sollten stummgeschaltet werden, um ein Echo zu vermeiden.
MuteForcedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
OT	Initialisiert ein Publisher-Objekt und gibt es zurück.
Herausgeber	Der folgende Code instanziiert eine Sitzung und veröffentlicht bei Herstellung der Verbindung zur Sitzung einen Audio-Video-Stream:
QualityScoreChangedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Sitzung	Veraltet – verwende stattdessen on() oder once().
SessionConnectEvent	In Version 2.2 gibt der „completionHandler“ der Methode „Session.connect()“ an, ob die Verbindung zur Sitzung erfolgreich hergestellt wurde oder fehlgeschlagen ist.
SessionDisconnectEvent	Der folgende Code initialisiert eine Sitzung und richtet einen Ereignis-Listener für den Fall ein, dass die Verbindung zur Sitzung unterbrochen wird.
SignalEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Stream	Wenn ein Stream zu einer Sitzung hinzugefügt wird, löst das Session-Objekt ein „streamCreatedEvent“ aus. Wenn ein Stream gelöscht wird, löst das Session-Objekt ein „streamDestroyed“-Ereignis aus. Das StreamEvent-Objekt, das diese Ereignisobjekte definiert, verfügt über eine „stream“-Eigenschaft, bei der es sich um ein Array von Stream-Objekten handelt. Für weitere Details
StreamEvent	Der folgende Code stellt eine Verbindung zu einer Sitzung her und richtet einen Ereignis-Listener ein, der ausgelöst wird, wenn ein von einem anderen Client veröffentlichter Stream erstellt wird:
StreamPropertyChangedEvent	Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die Eigenschaft „cancelable“ des Ereignisobjekts.
Abonnent	Veraltet – verwende stattdessen on() oder once().
VideoDimensionsChangedEvent	Auf dem Publisher wird dieses Ereignis ausgelöst, wenn das lokale Element des Publishers eine Änderung der Abmessungen feststellt. Wenn der Publisher aktiv veröffentlicht, wird dadurch auch die Eigenschaft „stream.videoDimensions“ aktualisiert. Beispiele dafür, was zu einer Größenänderung des lokalen Videoelements führen kann: Größenänderung eines erfassten Bildschirmfreigabefensters
VideoElementCreatedEvent	Fügen Sie nur dann einen Listener für dieses Ereignis hinzu, wenn Sie die Option „insertDefaultUI“ auf „false“ gesetzt haben. Wenn Sie die Option „insertDefaultUI“ nicht auf „false“ gesetzt haben, verschieben Sie das Video-Element (oder das Objekt-Element, das das Video in Internet Explorer enthält) nicht im HTML-DOM. Andernfalls führt dies dazu, dass der Publisher oder der Subscriber
VideoEnabledChangedEvent	Wenn sich die Verbindung verbessert und die Videoübertragung wieder möglich ist, löst das „Subscriber“-Objekt ein „videoEnabled“-Ereignis aus, und der „Subscriber“ nimmt den Empfang von Videodaten wieder auf.