Das vom OT.initSession() Die Methode bietet Zugriff auf einen Großteil der Funktionen der Vonage Video API.

Eigenschaften

Methoden

addEventListener(Typ, Listener, Kontext)

Parameter:

Abgelehnt — Verwendung on() oder einmal() stattdessen.

Mit dieser Methode wird eine Methode als Ereignisbehandler für ein bestimmtes Ereignis registriert.

Wenn für ein Ereignis kein Handler registriert ist, wird das Ereignis lokal ignoriert. Wenn die Ereignis-Listener-Funktion nicht existiert, wird das Ereignis lokal ignoriert.

Löst eine Ausnahme aus, wenn die listener Der Name ist ungültig.

Siehe: : - on() - einmal() - Veranstaltungen

connect(token, completionHandler)

Stellt eine Verbindung zu einer Vonage Video API-Sitzung her.

Bei erfolgreicher Verbindung wird der Abschluss-Handler (der zweite Parameter der Methode) aufgerufen, ohne dass ein Fehlerobjekt übergeben wird. (Tritt beim Herstellen der Verbindung ein Fehler auf, wird der Abschluss-Handler mit einem Fehlerobjekt aufgerufen.) Vergewissern Sie sich, dass die Verbindung zur Sitzung erfolgreich hergestellt wurde, bevor Sie andere Methoden des Session-Objekts aufrufen.

Das Session-Objekt sendet eine connectionCreated Ereignis, wenn ein beliebiger Client (einschließlich Ihres eigenen) eine Verbindung zur Sitzung herstellt.

Beispiel

Der folgende Code initialisiert eine Sitzung und richtet einen Ereignis-Listener für den Fall ein, dass die Sitzung eine Verbindung herstellt:

 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.
   }
 });

Ausgelöste Ereignisse:

exception (Ausnahmeereignis) — Wird im Falle eines Fehlers von der örtlichen OT-Klasse gesendet.

connectionCreated (Verbindungsereignis) — Wird vom Session-Objekt an alle mit der Sitzung verbundenen Clients gesendet.

sessionConnected (SessionConnectEvent) — Wird lokal vom Session-Objekt aufgerufen, sobald die Verbindung hergestellt ist. Sie können jedoch eine Abschluss-Handler-Funktion als zweiten Parameter der connect() und diese Funktion anstelle eines Listeners für die sessionConnected Veranstaltung.

Parameter:

Siehe: : - SessionConnectEvent

disableForceMute() → {Promise}

Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.

Nachdem Sie den Anruf an die Session.forceMuteAll() Methode (oder ein Moderator in einem anderen Client löst einen Aufruf aus, um alle Streams stummzuschalten), werden alle Streams, die nach dem Moderationsaufruf veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die disableForceMute() Methode zum Aufheben des Stummschaltzustands einer Sitzung (damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden).

Der Aufruf dieser Methode bewirkt, dass das Session-Objekt in jedem verbundenen Client eine muteForced Ereignis, mit dem active Flag auf false.

Prüfen Sie die capabilities.canForceMute Eigenschaft des Session-Objekts, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Diese ist für Clients reserviert, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Token-Erstellung (Dokumentation).

Siehe: : - Session.capabilities - Session.forceMuteAll() - Ereignis „muteForced“

Rückgabe:

Ein Promise, das bei erfolgreicher Ausführung der Operation keinen Wert zurückgibt. Bei einem Fehler wird das Promise abgelehnt. Das name Die Eigenschaft des Error-Objekts wird je nach Fehlertyp auf einen der folgenden Werte gesetzt:

• 'OT_NOT_CONNECTED' — Der Client ist nicht mit der Sitzung verbunden.
• 'OT_PERMISSION_DENIED' — Die Rolle des Benutzers umfasst keine Berechtigungen, die erforderlich sind, um andere Benutzer stummzuschalten. Sie legen die Rolle eines Benutzers fest, wenn Sie das Benutzer-Token erstellen (siehe Übersicht über die Token-Erstellung). Sie übergeben die Token-Zeichenkette als Parameter der connect() Methode des Session-Objekts .
• 'OT_UNEXPECTED_SERVER_RESPONSE' — Im Falle eines internen Serverfehlers.

disconnect() → {Promise.<void>}

Beendet die Verbindung zur Vonage Video API-Sitzung.

Aufrufen der disconnect() Diese Methode beendet Ihre Verbindung zur Sitzung. Im Zug der Beendigung Ihrer Verbindung wird auch die Veröffentlichung aller Streams eingestellt, die Sie veröffentlicht haben.

Session-Objekte auf Remote-Clients werden weitergeleitet streamDestroyed Ereignisse für jeden Stream, den Sie veröffentlicht haben. Das Session-Objekt löst ein sessionDisconnected Ereignis lokal. Die Session-Objekte auf den Remote-Clients leiten connectionDestroyed Ereignisse, durch die andere Teilnehmer darüber informiert werden, dass Sie die Sitzung verlassen haben. Die SessionDisconnectEvent und StreamEvent Objekte, die die sessionDisconnect und connectionDestroyed Jedes Ereignis hat ein reason Eigenschaft. Die reason Anhand dieser Eigenschaft kann der Entwickler feststellen, ob die Verbindung freiwillig beendet wird und ob dabei Streams als Nebenwirkung der freiwilligen Beendigung der zugrunde liegenden Verbindung zerstört werden.

Wenn derzeit keine Verbindung zur Sitzung besteht, wird beim Aufruf dieser Methode eine Warnung protokolliert. Siehe OT.setLogLevel().

Anmerkung: Wenn Sie beabsichtigen, ein Publisher-Objekt wiederzuverwenden, um nacheinander in verschiedenen Sitzungen (oder derselben Sitzung) zu veröffentlichen, fügen Sie einen Ereignis-Listener für das streamDestroyed Ereignis, das vom Publisher-Objekt ausgelöst wird (wenn es die Veröffentlichung beendet). Rufen Sie im Ereignis-Listener die preventDefault() Methode des Ereignisobjekts, um zu verhindern, dass das Video des Publishers von der Seite entfernt wird.

Ausgelöste Ereignisse:

sessionDisconnected (SessionDisconnectEvent) — Wird lokal ausgelöst, wenn die Verbindung unterbrochen wird.

connectionDestroyed (Verbindungsereignis) — Auf anderen Clients versendet, zusammen mit dem streamDestroyed Veranstaltung (sofern erforderlich).

streamDestroyed (StreamEvent) — Wird an andere Clients gesendet, wenn Streams aufgrund einer Unterbrechung der Sitzung verloren gehen.

Rückgabe:

Ein Promise, das aufgelöst wird, sobald das Ereignis „sessionDisconnected“ ausgelöst wird

forceDisconnect(Verbindung, Abschlusshandler) → {Promise.<void>}

Erzwingt eine Remote-Verbindung, um die Sitzung zu beenden.

Die forceDisconnect() Diese Methode wird in der Regel als Moderationsinstrument eingesetzt, um Nutzer aus einer laufenden Sitzung zu entfernen.

Wenn eine Verbindung mithilfe des forceDisconnect(), sessionDisconnected, connectionDestroyed und streamDestroyed Ereignisse werden auf dieselbe Weise ausgelöst, wie dies der Fall wäre, wenn die Verbindung mithilfe der disconnect() Methode. Allerdings ist die reason Eigenschaft einer Verbindungsereignis oder StreamEvent Das Objekt legt fest, "forceDisconnected" als Grund für die Unterbrechung der Verbindung und des/der Streams.

Sie können zwar die forceDisconnect() Methode zum Beenden der eigenen Verbindung, durch Aufruf der disconnect() Diese Methode ist einfacher.

Das OT-Objekt löst ein exception selbst wenn die Rolle des Benutzers nicht über die erforderlichen Berechtigungen verfügt, um andere Benutzer zur Trennung der Verbindung zu zwingen. Sie legen die Rolle eines Benutzers fest, wenn Sie das Benutzer-Token erstellen (siehe Übersicht über die Token-Erstellung). Siehe Ausnahmeereignis und OT.on().

The application gives a error message if no connection is established with the session.

Ausgelöste Ereignisse:

connectionDestroyed (Verbindungsereignis) — Auf anderen Clients als denen, bei denen die Verbindung beendet wurde.

exception (Ausnahmeereignis) — Die Rolle des Benutzers erlaubt es nicht, andere Benutzer zur Trennung der Verbindung zu zwingen (event.code = 1530), oder der angegebene Stream veröffentlicht keine Daten an die Sitzung (event.code = 1535).

sessionDisconnected (SessionDisconnectEvent) — Auf dem Client, dessen Verbindung beendet wurde.

streamDestroyed (StreamEvent) — Wenn Streams aufgrund einer unterbrochenen Verbindung gestoppt werden.

Parameter:

Rückgabe:

Ein Promise, das bei einer Unterbrechung der Verbindung aufgelöst wird

forceMuteAll(excludedStreams) → {Promise}

Zwingt alle Sender in der Sitzung (mit Ausnahme derjenigen, die ausgeschlossene Streams übertragen) dazu, den Ton stummzuschalten.

Ein vom Moderator veröffentlichter Stream, der die forceMuteAll() Die Methode wird zusammen mit anderen Streams in der Sitzung stummgeschaltet, es sei denn, Sie fügen den Stream (oder die Streams) des Moderators zum Array der ausgeschlossenen Streams hinzu.

Wenn Sie die excludedStreams Parameter: Alle Streams in der Sitzung (einschließlich derjenigen des Moderators) stellen die Audioübertragung ein:

session.forceMuteAll();

Außerdem werden alle Streams, die nach dem Aufruf der forceMuteAll() Methode werden mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltstatus einer Sitzung aufheben, indem Sie die disableForceMute() Methode des Session-Objekts.

session.disableForceMute();

Nachdem Sie die Session.disableForceMute() Mit dieser Methode wird die Stummschaltung bei neuen Streams, die in der Sitzung veröffentlicht werden, aufgehoben.

Der Aufruf dieser Methode bewirkt, dass die Publisher-Objekte in den Clients, die die Streams veröffentlichen, folgende Aktionen auslösen muteForced Ereignisse. Außerdem löst das Session-Objekt in jedem mit der Sitzung verbundenen Client das muteForced Veranstaltung (mit dem active Eigenschaft des Ereignisobjekts, die auf true).

Prüfen Sie die capabilities.canForceMute Eigenschaft des Session-Objekts, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Diese ist für Clients reserviert, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Token-Erstellung (Dokumentation).

Parameter:

Siehe: : - Session.capabilities - Session.forceMuteStream() - Session.disableForceMute() - Ereignis „muteForced“ der Sitzung - Verlag „muteForced“-Ereignis - Stummschalten des Tons von Streams in einer Sitzung

Rückgabe:

Ein Promise, das bei erfolgreicher Ausführung der Operation keinen Wert zurückgibt. Bei einem Fehler wird das Promise abgelehnt. Das name Die Eigenschaft des Error-Objekts wird je nach Fehlertyp auf einen der folgenden Werte gesetzt:

• 'OT_NOT_CONNECTED' — Der Client ist nicht mit der Sitzung verbunden.
• 'INVALID_PARAMETER' — wenn einer oder mehrere der übergebenen Parameter ungültig sind.
• 'OT_PERMISSION_DENIED' — Die Rolle des Benutzers umfasst keine Berechtigungen, die erforderlich sind, um andere Benutzer stummzuschalten. Sie legen die Rolle eines Benutzers fest, wenn Sie das Benutzer-Token erstellen (siehe Übersicht über die Token-Erstellung). Sie übergeben die Token-Zeichenkette als Parameter der connect() Methode des Session-Objekts .
• 'OT_UNEXPECTED_SERVER_RESPONSE' — im Falle eines internen Serverfehlers.

forceMuteStream(stream) → {Promise}

Zwingt den Anbieter eines bestimmten Streams dazu, dessen Ton stummzuschalten.

Der Aufruf dieser Methode bewirkt, dass das Publisher-Objekt auf dem Client, der den Stream veröffentlicht, einen muteForced Veranstaltung.

Prüfen Sie die capabilities.canForceMute Eigenschaft des Session-Objekts, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Diese ist für Clients reserviert, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Token-Erstellung (Dokumentation).

Parameter:

Siehe: : - Session.capabilities - Session.forceMuteAll() - Verlag „muteForced“-Ereignis - Stummschalten des Tons von Streams in einer Sitzung

Rückgabe:

Ein Promise, das bei erfolgreicher Ausführung der Operation keinen Wert zurückgibt. Bei einem Fehler wird das Promise abgelehnt. Das name Die Eigenschaft des Error-Objekts wird je nach Fehlertyp auf einen der folgenden Werte gesetzt:

• 'OT_NOT_CONNECTED' — Der Client ist nicht mit der Sitzung verbunden.
• 'OT_INVALID_PARAMETER' — wenn einer oder mehrere der übergebenen Parameter ungültig sind.
• 'OT_PERMISSION_DENIED' — Die Rolle des Benutzers umfasst keine Berechtigungen, die erforderlich sind, um andere Benutzer stummzuschalten. Sie legen die Rolle eines Benutzers fest, wenn Sie das Benutzer-Token erstellen (siehe Übersicht über die Token-Erstellung). Sie übergeben die Token-Zeichenkette als Parameter der connect() Methode des Session-Objekts .
• 'OT_NOT_FOUND' — Der Stream wurde in dieser Sitzung nicht gefunden.
• 'OT_UNEXPECTED_SERVER_RESPONSE' — Im Falle eines internen Serverfehlers.

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

Zwingt den Herausgeber des angegebenen Streams dazu, die Veröffentlichung des Streams zu beenden.

Durch den Aufruf dieser Methode löst das Session-Objekt eine streamDestroyed Ereignis auf allen Clients, die den Stream abonniert haben (einschließlich des Clients, der den Stream veröffentlicht). Das reason Die Eigenschaft des StreamEvent-Objekts wird auf "forceUnpublished".

Das OT-Objekt löst ein exception selbst wenn die Rolle des Benutzers nicht über die erforderlichen Berechtigungen verfügt, um andere Benutzer zur Aufhebung der Veröffentlichung zu zwingen. Sie legen die Rolle eines Benutzers fest, wenn Sie das Benutzer-Token erstellen (siehe Übersicht über die Token-Erstellung). Sie übergeben die Token-Zeichenkette als Parameter der connect() Methode des Session-Objekts . Siehe Ausnahmeereignis und OT.on().

Ausgelöste Ereignisse:

exception (Ausnahmeereignis) — Die Rolle des Benutzers erlaubt es nicht, andere Benutzer zur Rücknahme einer Veröffentlichung zu zwingen.

streamDestroyed (StreamEvent) — Der Stream wurde deaktiviert. Das Session-Objekt leitet diese Meldung an alle Clients weiter, die den Stream abonniert haben, sowie an den Client des Publishers.

Parameter:

Rückgabe:

Ein Promise, das bei der Rücknahme der Veröffentlichung aufgelöst wird

getPublisherForStream(stream) → {Herausgeber}

Gibt das lokale Publisher-Objekt für einen bestimmten Stream zurück.

Parameter:

Siehe: : - forceUnpublish() - Abonnent - StreamEvent

Rückgabe:

Ein Publisher-Objekt für den angegebenen Stream. Gibt Folgendes zurück: null wenn kein lokales Publisher-Objekt für den angegebenen Stream vorhanden ist.

getSubscribersForStream(stream) → {Array}

Gibt ein Array lokaler Subscriber-Objekte für einen bestimmten Stream zurück.

Parameter:

Siehe: : - unsubscribe() - Abonnent - StreamEvent

Rückgabe:

Eine Reihe von Abonnent Objekte für den angegebenen Stream.

off(Typ, Handler, Kontext) → {Object}

Entfernt einen oder mehrere Ereignis-Handler.

Wenn Sie einen Ereignisnamen und eine Handler-Methode übergeben, wird der Handler für dieses Ereignis entfernt:

obj.off("eventName", eventHandler);

Wenn Sie mehrere Ereignisnamen und eine Handler-Methode übergeben, wird der Handler für diese Ereignisse entfernt:

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

Wenn Sie einen Ereignisnamen (oder mehrere) übergeben und nein Handler-Methode werden alle Handler für diese Ereignisse entfernt:

obj.off("event1Name event2Name");

Wenn Sie keine Argumente übergeben, alle Ereignisbehandler werden für alle Ereignisse entfernt, die von dem Objekt ausgelöst werden:

obj.off();

Die Methode unterstützt auch eine alternative Syntax, bei der der erste Parameter ein Objekt ist, das aus einer Hash-Map mit Ereignisnamen und Handler-Funktionen besteht, und der zweite Parameter (optional) den Kontext für diesen in jedem Handler darstellt:

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

Parameter:

Siehe: : - on() - einmal() - Veranstaltungen

Rückgabe:

Das Objekt, das das Ereignis ausgelöst hat.

on(Typ, Handler, Kontext) → {EventDispatcher}

Fügt eine Ereignisbehandlungsfunktion für ein oder mehrere Ereignisse hinzu.

Der folgende Code fügt einen Ereignis-Handler für ein Ereignis hinzu:

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

Wenn Sie mehrere Ereignisnamen und eine Handler-Methode übergeben, wird der Handler für jedes dieser Ereignisse registriert:

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

Sie können auch ein drittes Argument übergeben context Parameter (der optional ist), um den Wert von this in der Handler-Methode:

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

Die Methode unterstützt auch eine alternative Syntax, bei der der erste Parameter ein Objekt ist, das eine Hash-Map aus Ereignisnamen und Handler-Funktionen darstellt, und der zweite Parameter (optional) den Kontext für diesen in jedem Handler darstellt:

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

Wenn Sie für ein Ereignis keinen Handler hinzufügen, wird das Ereignis lokal ignoriert.

Parameter:

Siehe: : - off() - einmal() - Veranstaltungen

Rückgabe:

Das EventDispatcher-Objekt.

once(Typ, Handler, Kontext) → {Object}

Fügt eine Ereignisbehandlungsfunktion für ein oder mehrere Ereignisse hinzu. Sobald der Handler aufgerufen wird, wird die angegebene Handler-Methode als Handler für dieses Ereignis entfernt. (Wenn Sie die on() Methode zum Hinzufügen eines Ereignis-Handlers; der Handler lautet nicht wird beim Aufruf entfernt.) Das once() Die Methode entspricht dem Aufruf der on() Methode und Aufruf off() beim ersten Aufruf des Handlers.

Der folgende Code fügt einen einmaligen Ereignis-Handler für ein Ereignis hinzu:

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

Wenn Sie mehrere Ereignisnamen und eine Handler-Methode übergeben, wird der Handler für jedes dieser Ereignisse registriert:

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

Sie können auch ein drittes Argument übergeben context Parameter (der optional ist), um den Wert von this in der Handler-Methode:

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

Die Methode unterstützt außerdem eine alternative Syntax, bei der der erste Parameter ein Objekt ist, das aus einer Hash-Map mit Ereignisnamen und Handler-Funktionen besteht, und der zweite Parameter (optional) den Kontext für diesen Parameter in jedem Handler darstellt:

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

Parameter:

Siehe: : - on() - off() - Veranstaltungen

Rückgabe:

Das Objekt, das das Ereignis ausgelöst hat.

publish(publisher, completionHandler)

Die publish() Die Methode beginnt mit der Übertragung eines Audio-Video-Streams an die Sitzung. Der Audio-Video-Stream wird von einem lokalen Mikrofon und einer Webcam erfasst. Nach erfolgreicher Übertragung lösen die Session-Objekte auf allen verbundenen Clients die streamCreated Veranstaltung.

Als einzigen Parameter der Methode übergeben Sie ein Publisher-Objekt. Sie können ein Publisher-Objekt initialisieren, indem Sie die OT.initPublisher() Methode. Vor dem Aufruf von Session.publish().

Diese Methode hat eine alternative Form: publish(targetElement: String | HTMLElement, properties: Object, completionHandler: Function): Publisher — In dieser Form machst du nicht ein Publisher-Objekt an die Funktion übergeben. Stattdessen übergeben Sie ein targetElement (das Ziel-HTML-Element oder die ID des Ziel-HTML-Elements für den Publisher), ein optionales properties Objekt, das Optionen für den Publisher definiert (siehe OT.initPublisher()) sowie eine optionale Abschluss-Handler-Funktion. Die Methode gibt ein neues Publisher-Objekt zurück, das mit der Übertragung eines Audio-Video-Streams an die Sitzung beginnt. Im weiteren Verlauf dieser Dokumentation wird die Form beschrieben, die ein einzelnes Publisher-Objekt als Parameter entgegennimmt.

Auf der Webseite wird eine lokale Anzeige des veröffentlichten Streams erstellt, indem das angegebene Element im DOM durch eine Streaming-Videoanzeige ersetzt wird. Der Videostream wird automatisch horizontal gespiegelt, sodass Nutzer sich selbst und die Bewegungen in ihrem Stream auf natürliche Weise sehen können. Wenn Breite und Höhe der Anzeige nicht dem Seitenverhältnis 4:3 des Videosignals entsprechen, wird der Videostream so zugeschnitten, dass er in die Anzeige passt.

Wenn durch den Aufruf dieser Methode ein neues Publisher-Objekt erstellt wird und die Vonage Video API-Bibliothek keinen Zugriff auf die Kamera oder das Mikrofon hat, fordert die Webseite den Benutzer auf, den Zugriff auf die Kamera und das Mikrofon zu gewähren.

Das OT-Objekt löst ein exception selbst wenn die Rolle des Benutzers nicht die für die Veröffentlichung erforderlichen Berechtigungen umfasst. Ist die Rolle des Benutzers beispielsweise auf „Abonnent“ festgelegt, kann er keine Beiträge veröffentlichen. Die Rolle eines Benutzers legen Sie beim Erstellen des Benutzer-Tokens fest (siehe Übersicht über die Token-Erstellung). Sie übergeben die Token-Zeichenkette als Parameter der connect() Methode des Session-Objekts . Siehe Ausnahmeereignis und OT.on().

The application gives a error message if no connection is established with the session.

Ausgelöste Ereignisse:

exception (Ausnahmeereignis) — Ausgelöst durch das OT-Objekt. Dies kann vorkommen, wenn die Rolle des Benutzers keine Veröffentlichung zulässt (die code Eigenschaft des Ereignisobjekts auf 1500 gesetzt ist); dies kann auch auftreten, wenn die Verbindung nicht hergestellt werden kann (die code Die Eigenschaft des Ereignisobjekts ist auf 1013 gesetzt). WebRTC ist ein Peer-to-Peer-Protokoll, und es kann vorkommen, dass Verbindungen nicht hergestellt werden können. Die häufigste Ursache für einen Verbindungsfehler ist eine Firewall, die das Protokoll nicht durchdringen kann.

streamCreated (StreamEvent) — Der Stream wurde veröffentlicht. Das Session-Objekt leitet dies an alle Clients weiter, die den Stream abonniert haben, sowie an den Client des Publishers.

Beispiel

Im folgenden Beispiel wird ein Video veröffentlicht, sobald die Sitzung hergestellt ist:

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);
  }
});

Parameter:

Rückgabe:

Das Publisher-Objekt für diesen Stream.

removeEventListener(Typ, Listener, Kontext)

Parameter:

Abgelehnt — Verwendung off() stattdessen.

Entfernt einen Ereignis-Listener für ein bestimmtes Ereignis.

Löst eine Ausnahme aus, wenn die listener Der Name ist ungültig.

Siehe: : - off() - Veranstaltungen

setEncryptionSecret(secret) → {Promise}

Legt den Verschlüsselungsschlüssel für eine Sitzung fest, bei der die End-to-End-Verschlüsselung aktiviert ist. Wird diese Methode in einer Sitzung aufgerufen, in der die Verschlüsselung nicht aktiviert ist, wird die Funktion ausgeführt, ohne dass ein Fehler ausgelöst wird. Benutzer können ihren festgelegten Verschlüsselungsschlüssel jederzeit ändern. Siehe End-to-End-Verschlüsselung Entwicklerhandbuch.

Parameter:

Siehe: : - OT.initSession - Veranstaltungen für Abonnenten

Rückgabe:

Ein Promise, das bei erfolgreicher Ausführung der Operation keinen Wert zurückgibt. Bei einem Fehler wird das Promise abgelehnt. Das name Die Eigenschaft des Error-Objekts wird je nach Fehlertyp auf einen der folgenden Werte gesetzt:

• 'OT_INVALID_ENCRYPTION_SECRET'; Das Passwort ist ungültig.

Ein geheimes Mismatch kann auftreten, wenn kein Fehler ausgelöst wird. Siehe Veranstaltungen für Abonnenten für weitere Informationen.

setIceConfig(newIceConfig)

Legt die ICE-Konfiguration für alle Verbindungen in einer Sitzung fest. Dies ersetzt alle zuvor festgelegten ICE-Konfigurationen.

Diese Funktion steht für Projekte zur Verfügung, die die konfigurierbar TURN-Server-Erweiterung.

Parameter:

Siehe: : - OT.initSession()

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

Sendet ein Signal an jeden Client oder einen bestimmten Client in der Sitzung. Geben Sie einen to Eigenschaft der signal Parameter, um das Signal auf einen bestimmten Client zu beschränken; andernfalls wird das Signal an jeden Client gesendet, der mit der Sitzung verbunden ist.

Im folgenden Beispiel wird ein Signal vom Typ „foo“ mit einer bestimmten Datenlast („hello“) an alle mit der Sitzung verbundenen Clients gesendet:

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

Wird diese Methode aufgerufen, ohne einen Empfänger-Client anzugeben (durch Setzen des to Eigenschaft des signal Parameter) führt dazu, dass mehrere Signale gesendet werden (jeweils eines an jeden Client in der Sitzung). Informationen zu den Gebühren für die Signalisierung finden Sie unter Preise für die Vonage Video API Seite.

Im folgenden Beispiel wird ein Signal vom Typ „foo“ mit einer Datenlast („hello“) an einen bestimmten, mit der Sitzung verbundenen Client gesendet:

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);
}

Füge einen Ereignis-Handler für das signal Ereignis, um alle in der Sitzung gesendeten Signale abzufangen. Fügen Sie einen Ereignis-Handler für das signal:type Ereignis, bei dem nur Signale eines bestimmten Typs abgehört werden sollen (ersetzen Sie type, in signal:type, mit der Art des Signals, auf das gewartet werden soll). Das Session-Objekt löst diese Ereignisse aus. (Siehe Veranstaltungen.)

Parameter:

Siehe: : - Signal und signal:type Veranstaltungen

Rückgabe:

Ein Promise, das aufgelöst wird, sobald das Signal gesendet wurde

subscribe(stream, targetElement, properties, completionHandler) → {Abonnent}

Abonniert einen Stream, der für die Sitzung verfügbar ist. Sie können ein Array der verfügbaren Streams über die streams Eigenschaft der sessionConnected und streamCreated Veranstaltungen (siehe SessionConnectEvent und StreamEvent).

Der abonnierte Stream wird auf der lokalen Webseite angezeigt, indem das angegebene Element im DOM durch eine Streaming-Videoanzeige ersetzt wird. Wenn Breite und Höhe der Anzeige nicht dem Seitenverhältnis 4:3 des Videosignals entsprechen, wird der Videostream so beschnitten, dass er auf die Anzeige passt. Fehlt im Stream eine Videokomponente, wird anstelle des Videostreams ein leerer Bildschirm mit einer Audioanzeige angezeigt.

The application solves a error if there is no connection to the session or if the session is not connected. targetElement ist im HTML-DOM nicht vorhanden.

Beispiel

Der folgende Code abonniert die Streams anderer 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);

Parameter:

Rückgabe:

Das „Subscriber“-Objekt für diesen Stream. Funktionen zur Stream-Steuerung werden über das „Subscriber“-Objekt bereitgestellt.

Veröffentlichung rückgängig machen (Herausgeber)

Beendet die Übertragung des Audio-Video-Streams des angegebenen Anbieters an die Sitzung. Standardmäßig wird die lokale Darstellung des Audio-Video-Streams von der Webseite entfernt. Bei erfolgreicher Beendigung löst das Session-Objekt auf jeder verbundenen Webseite ein Ereignis aus streamDestroyed Veranstaltung.

Um zu verhindern, dass der Publisher aus dem DOM entfernt wird, fügen Sie einen Ereignis-Listener für das streamDestroyed Ereignis, das vom Publisher-Objekt ausgelöst wird, und rufen die preventDefault() Methode des Ereignisobjekts.

Anmerkung: Wenn Sie beabsichtigen, ein Publisher-Objekt wiederzuverwenden, um nacheinander in verschiedenen Sitzungen (oder derselben Sitzung) zu veröffentlichen, fügen Sie einen Ereignis-Listener für das streamDestroyed Ereignis, das vom Publisher-Objekt ausgelöst wird (wenn es die Veröffentlichung beendet). Rufen Sie im Ereignis-Listener die preventDefault() Methode des Ereignisobjekts, um zu verhindern, dass das Video des Publishers von der Seite entfernt wird.

Ausgelöste Ereignisse:

streamDestroyed (StreamEvent) — Der mit dem Publisher verbundene Stream wurde gelöscht. Ausgelöst durch den Publisher im Browser des Publishers. Ausgelöst durch das Session-Objekt auf allen anderen Verbindungen, die den Stream des Publishers abonniert haben.

Beispiel

Im folgenden Beispiel wird ein Stream in einer Sitzung veröffentlicht und der Webseite ein Link „Trennen“ hinzugefügt. Durch Klicken auf diesen Link wird die Veröffentlichung des Streams beendet.

<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>

Parameter:

Siehe: : - publish() - Ereignis „streamDestroyed“

Abmelden (Abonnent)

Beendet das Abonnieren eines Streams in der Sitzung. Die Anzeige des Audio-Video-Streams wird von der lokalen Webseite entfernt.

Beispiel

Der folgende Code abonniert die Streams anderer Clients. Für jeden Stream fügt der Code außerdem einen Link zum Abmelden hinzu.

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);
        }
    }
}

Parameter:

Siehe: : - subscribe()

Veranstaltungen

Archiv gestartet

Wird gesendet, wenn eine Archivaufzeichnung der Sitzung beginnt.

Siehe: : - Archiv-Veranstaltung - Überblick über die Archivierung

Archiv gestoppt

Wird gesendet, wenn eine Archivaufzeichnung der Sitzung beendet wird.

Siehe: : - Archiv-Veranstaltung - Überblick über die Archivierung

Verbindung erstellt

Wird ausgelöst, wenn sich ein neuer Client (einschließlich Ihres eigenen) mit der Sitzung verbunden hat, sowie für jeden Client in der Sitzung, sobald dieser zum ersten Mal eine Verbindung herstellt. (Das Session-Objekt löst außerdem ein sessionConnected Ereignis, wenn sich Ihr lokaler Client verbindet.)

Siehe: : - Verbindungsereignis - OT.initSession()

Verbindung unterbrochen

Ein anderer Client als Ihr eigener hat die Verbindung zur Sitzung getrennt.

Siehe: : - Verbindungsereignis

cpuPerformanceChanged

Der Leistungsstatus der CPU hat sich geändert. Dieser kann auf eine der folgenden Stufen eingestellt werden: „nominal“, „fair“, „serious“ oder „critical“.

Siehe: : - CpuPerformanceChangedEvent

muteForced

Ein Moderator hat die Teilnehmer, die Streams in der Sitzung veröffentlichen, dazu gezwungen, den Ton stummzuschalten (die active Die Eigenschaft dieses MuteForcedEvent-Objekts ist auf true) oder ein Moderator hat den Status „Audio stummschalten“ in der Sitzung deaktiviert (der active Die Eigenschaft dieses MuteForcedEvent-Objekts ist auf false).

Siehe: : - MuteForcedEvent - Session.forceMuteAll() - Session.disableForceMute() - Stummschalten des Tons von Streams in einer Sitzung

sessionConnected

Der Client hat eine Verbindung zu einer Vonage Video API-Sitzung hergestellt. Dieses Ereignis wird asynchron ausgelöst als Reaktion auf einen erfolgreichen Aufruf der connect() Methode eines Session-Objekts . Vor dem Aufruf der connect() Methode: Initialisieren Sie die Sitzung durch Aufruf der OT.initSession() Methode. Ein Code-Beispiel und weitere Details finden Sie unter Session.connect().

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

Sitzung getrennt

Der Client hat die Verbindung zur Sitzung getrennt. Dieses Ereignis kann asynchron ausgelöst werden als Reaktion auf einen erfolgreichen Aufruf der disconnect() Methode des Session-Objekts. Das Ereignis kann auch ausgelöst werden, wenn eine Session-Verbindung unbeabsichtigt unterbrochen wird, beispielsweise bei einem Verbindungsabbruch.

Standardmäßig werden alle „Subscriber“-Objekte abgemeldet und aus dem HTML-DOM entfernt. Jedes „Subscriber“-Objekt löst ein destroyed Ereignis, wenn das Element aus dem HTML-DOM entfernt wird. Wenn Sie die preventDefault() Methode im Ereignis-Listener für den sessionDisconnect Ereignis wird das Standardverhalten unterbunden, und Sie können optional Subscriber-Objekte mithilfe Ihres eigenen Codes bereinigen.

Die reason Die Eigenschaft des Ereignisobjekts gibt den Grund dafür an, dass die Verbindung zum Client unterbrochen wurde.

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

sessionReconnected

Der lokale Client hat die Verbindung zur Vonage Video API-Sitzung wiederhergestellt, nachdem diese vorübergehend unterbrochen war. Wenn die Verbindung unterbrochen wird, löst das Session-Objekt ein sessionReconnecting Veranstaltung, vor der sessionReconnected Ereignis. Wenn der Client die Verbindung zur Sitzung nicht wiederherstellen kann, löst das Session-Objekt ein sessionDisconnected Veranstaltung anstelle dieser Veranstaltung.

Alle vorhandenen Publisher und Subscriber werden automatisch wieder verbunden, wenn der Client die Verbindung wiederherstellt und das Session-Objekt dieses Ereignis auslöst.

Alle Signale, die von anderen Clients gesendet wurden, während die Verbindung Ihres Clients unterbrochen war, werden bei der Wiederherstellung der Verbindung empfangen. Standardmäßig werden Signale, die vom lokalen Client während der Unterbrechung (durch Aufruf der Session.signal() Methode) werden gesendet, wenn der Client die Verbindung zur Vonage Video API-Sitzung wiederherstellt. Sie können dies verhindern, indem Sie die retryAfterReconnect Eigenschaft zu false im signal Objekt, das Sie an die Session.signal() Methode.

Siehe: : - Veranstaltung - Ereignis „sessionReconnecting“ - Ereignis „sessionDisconnected“

Sitzung wird neu verbunden

Der lokale Client hat die Verbindung zu einer Vonage Video API-Sitzung verloren und versucht, die Verbindung wiederherzustellen. Dies ist auf einen Ausfall der Netzwerkverbindung zurückzuführen. Wenn der Client die Verbindung zur Sitzung wiederherstellen kann, löst das Session-Objekt ein sessionReconnected Ereignis. Andernfalls, falls der Client die Verbindung nicht wiederherstellen kann, löst das Session-Objekt ein sessionDisconnected Veranstaltung.

Als Reaktion auf dieses Ereignis möchten Sie möglicherweise eine Benachrichtigung über die Benutzeroberfläche anzeigen, um den Benutzer darüber zu informieren, dass die App versucht, die Verbindung zur Sitzung wiederherzustellen, und dass die Audio- und Videostreams vorübergehend unterbrochen sind.

Siehe: : - Veranstaltung - Ereignis „sessionReconnected“ - Ereignis „sessionDisconnected“

Signal

Von der Sitzung wurde ein Signal empfangen. Das SignalEvent Die Klasse definiert dieses Ereignisobjekt. Es umfasst die folgenden Eigenschaften:

• data — (Zeichenkette) Die mit dem Signal gesendete Zeichenkette (falls vorhanden).
• from — (Verbindung) Die Verbindung, die dem Client entspricht, der das Signal gesendet hat.
• type — (Zeichenkette) Der dem Signal zugewiesene Typ (sofern vorhanden ).

Sie können sich registrieren, um alle in der Sitzung gesendeten Signale zu empfangen, indem Sie einen Ereignis-Handler für das signal Ereignis. Der folgende Code fügt beispielsweise einen Ereignis-Handler hinzu, um alle in der Sitzung gesendeten Signale zu verarbeiten:

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

Sie können sich für Signale eines bestimmten Typs registrieren, indem Sie einen Ereignis-Handler für das signal:type Ereignis (ersetzt type mit der tatsächlichen Typ-Zeichenkette (nach der gefiltert werden soll).

Siehe: : - Session.signal() - SignalEvent - signal:type Veranstaltung

streamCreated

In dieser Sitzung wurde ein neuer Stream erstellt, der von einem anderen Client veröffentlicht wurde. Bei Streams, die von Ihrem eigenen Client veröffentlicht werden, sendet das Publisher-Objekt eine streamCreated Ereignis. Ein Code-Beispiel und weitere Details finden Sie unter StreamEvent.

Siehe: : - StreamEvent - Session.publish()

streamDestroyed

Ein Stream eines anderen Clients hat die Übertragung an die Sitzung eingestellt.

Standardmäßig werden alle „Subscriber“-Objekte, die den Stream abonniert haben, abgemeldet und aus dem HTML-DOM entfernt. Jedes „Subscriber“-Objekt löst ein destroyed Ereignis, wenn das Element aus dem HTML-DOM entfernt wird. Wenn Sie die preventDefault() Methode im Ereignis-Listener für die streamDestroyed Ereignis wird das Standardverhalten unterbunden, und Sie können ein Subscriber-Objekt für den Stream bereinigen, indem Sie dessen destroy() Methode. Siehe Session.getSubscribersForStream().

Bei Streams, die von Ihrem eigenen Client veröffentlicht werden, sendet das Publisher-Objekt ein streamDestroyed Veranstaltung.

Ein Code-Beispiel und weitere Informationen finden Sie unter StreamEvent.

Siehe: : - StreamEvent

streamPropertyChanged

Definiert ein Ereignis, das ausgelöst wird, wenn sich eine Eigenschaft eines Streams geändert hat. Dies kann unter den folgenden Bedingungen geschehen:

• Ein Stream hat die Übertragung von Audio, Untertiteln oder Video gestartet oder beendet (siehe Publisher.publishAudio(), Publisher.publishCaptions() und Publisher.publishVideo()). Hinweis: Das Video eines Abonnenten kann auch aus anderen Gründen deaktiviert oder aktiviert werden als durch die Deaktivierung oder Aktivierung durch den Herausgeber. Ein „Subscriber“-Objekt löst videoDisabled und videoEnabled Ereignisse unter allen Bedingungen, die dazu führen, dass der Stream des Abonnenten deaktiviert oder aktiviert wird.
• Die videoDimensions Die Eigenschaft des Stream-Objekts hat sich geändert (siehe Stream.videoDimensions).
• Die videoType Eine Eigenschaft des Stream-Objekts hat sich geändert. Dies kann bei einem von einem Mobilgerät veröffentlichten Stream vorkommen. (Siehe Stream.videoType.)

Siehe: : - StreamPropertyChangedEvent - Publisher.publishAudio() - Publisher.publishCaptions() - Publisher.publishVideo() - Stream.hasAudio - Stream.hasCaptions - Stream.hasVideo - Stream.videoDimensions - Abonnentenvideo – Deaktiviertes Ereignis - Veranstaltung mit Video für Abonnenten

signal:type

Von der Sitzung wurde ein Signal des angegebenen Typs empfangen. Das SignalEvent Die Klasse definiert dieses Ereignisobjekt. Es umfasst die folgenden Eigenschaften:

• data — (Zeichenkette) Die mit dem Signal gesendete Zeichenkette.
• from — (Verbindung) Die Verbindung, die dem Client entspricht, der das Signal gesendet hat.
• type — (Zeichenkette) Der dem Signal zugewiesene Typ (falls vorhanden).

Sie können sich für Signale eines bestimmten Typs registrieren, indem Sie einen Ereignis-Handler für das signal:type Ereignis (ersetzt type mit der tatsächlichen Typ-Zeichenkette , nach der gefiltert werden soll). Der folgende Code fügt beispielsweise einen Ereignis-Handler für Signale vom Typ „foo“ hinzu:

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

Sie können sich registrieren, um alle Signale, die während der Sitzung gesendet werden, durch Hinzufügen eines Ereignis-Handlers für die signal Veranstaltung.

Siehe: : - Session.signal() - SignalEvent - Signal Veranstaltung