Der erste Schritt bei der Nutzung der Vonage Video API besteht darin, die OT.initSession() Methode. Andere Methoden des OT-Objekts prüfen die Systemanforderungen und richten die Fehlerprotokollierung ein.

Methoden

(static) addEventListener(type, listener)

Diese Methode ist veraltet. Verwenden Sie stattdessen on() oder einmal() stattdessen.

Registriert eine Methode als Ereignis-Listener für ein bestimmtes Ereignis.

Das OT-Objekt löst eine Art von Ereignis aus – ein exception Ereignis. Der folgende Code fügt einen Ereignis-Listener für das exception Veranstaltung:

OT.addEventListener("exception", exceptionHandler);

function exceptionHandler(event) {
   alert("exception event. \n  code == " + event.code + "\n  message == " + event.message);
}

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.

Parameter:

Siehe: : - on() - einmal()

(static) checkScreenSharingCapability(callback) → {Promise.<ScreenSharingCapabilityResponse>}

Prüft, ob die Veröffentlichung von Bildschirmfreigabe-Streams im Client-Browser unterstützt wird. Das vom Promise zurückgegebene Objekt gibt an, ob die Bildschirmfreigabe unterstützt wird und welche Bildschirmfreigabequellen (Anwendung, Bildschirm oder Fenster) unterstützt werden. Außerdem wird angegeben, ob eine Erweiterung erforderlich ist, installiert und registriert wurde (falls erforderlich).

const response = await OT.checkScreenSharingCapability();
if (!response.supported || response.extensionRegistered === false) {
// This browser does not support screen sharing
} else if (response.extensionInstalled === false) {
  // Prompt to install the extension
} else {
  // Screen sharing is available.
}

Dieses Objekt verfügt über die folgenden Eigenschaften, die darauf hinweisen, dass die Veröffentlichung von Bildschirmfreigabe-Streams im Client unterstützt wird:

• extensionInstalled (Boolescher Wert) — In älteren Versionen von Chrome und Opera ist dieser Wert auf true sofern die Erweiterung installiert und registriert ist. In Chrome 72+, Firefox 52+, Safari 13+, Opera 59+, Edge 79+ und Internet Explorer ist diese Eigenschaft undefiniert.
• supported (Boolesch) — Setzen auf true wenn die Bildschirmfreigabe im Browser unterstützt wird. Überprüfen Sie die extensionRequired Eigenschaft um zu prüfen, ob der Browser eine Erweiterung für die Bildschirmfreigabe benötigt.
• supportedSources (Objekt) — Veraltet. In älteren Browserversionen konnte man eine Art von Bildschirmfreigabequelle auswählen (z. B. "application", "browser", "screen", oder "window" durch Einstellung der videoSource Eigenschaft der an die OT.initPublisher() Methode. In aktuellen Browsern, die die Bildschirmfreigabe unterstützen, führt die Übergabe eines dieser Werte jedoch zum gleichen Verhalten – der Browser zeigt ein Dialogfeld an, in dem der Endbenutzer die Quelle für die Bildschirmfreigabe auswählt (dies kann der gesamte Bildschirm oder ein bestimmtes Fenster sein). In Electron erfasst die Bildschirmfreigabe den gesamten Bildschirm, ohne den Benutzer um Erlaubnis zu bitten.

Der Parameter „options“ enthält außerdem die folgenden Eigenschaften, die für die Bildschirmfreigabe in älteren Versionen von Chrome und Opera gelten (in allen anderen Browsern sind diese Eigenschaften undefiniert):

• extensionRequired (Zeichenkette) — Auf "chrome" in älteren Versionen von Chrome und Opera, für die eine Erweiterung zur Bildschirmfreigabe installiert sein muss. In anderen Browsern ist diese Eigenschaft nicht definiert.
• extensionRegistered (Boolesch) — In älteren Versionen von Chrome und Opera ist diese Eigenschaft auf true wenn eine Erweiterung zur Bildschirmfreigabe registriert ist; ansonsten wird sie auf false. In anderen Browsern (die keine Erweiterung erfordern) ist diese Eigenschaft undefiniert. Verwenden Sie die OT.registerScreenSharingExtension() Vorgehensweise zur Registrierung einer Erweiterung für die Bildschirmfreigabe in älteren Versionen von Chrome oder Opera.

Chrome 72+, Firefox 52+, Safari 13+, Edge 79+ und Opera 59+ verfügen über eine integrierte Unterstützung für die Bildschirmfreigabe, sodass keine Erweiterung erforderlich ist. (Beachten Sie, dass die Unterstützung für das Vonage Video API-Plugin für Internet Explorer in der Version 2.17 der Vonage Video API entfernt wurde.) Die Bildschirmfreigabe ist nicht wird in mobilen Browsern unterstützt. In Electron wird die Bildschirmfreigabe unterstützt, wenn die webPreferences.contextIsolation Die Option des Electron-BrowserWindow ist auf false oder wenn die App ein Preload-Skript verwendet, um auf den Desktop-Capturer zuzugreifen. (Der Standardwert von webPreferences.contextIsolation Option ist true in Electron 12 und false (in früheren Versionen). Um ein Bildschirmfreigabe-Video in älteren Versionen von Chrome oder Opera zu veröffentlichen, installiert der Kunde eine Erweiterung, die die Veröffentlichung eines Bildschirmfreigabe-Videostreams auf Ihrer Domain ermöglicht. Die Vonage Video API Erweiterungen für die Bildschirmfreigabe Das Beispiel enthält Code zum Erstellen einer Erweiterung für die Bildschirmfreigabe in älteren Versionen von Chrome und Opera.

Weitere Informationen finden Sie in der Vonage Video API – Bildschirmfreigabe Leitfaden für Entwickler.

Parameter:

Siehe: : - OT.initPublisher() - OT.registerScreenSharingExtension()

Rückgabe:

Ein Versprechen, das es in sich hat

(static) checkSystemRequirements() → {Number}

Prüft, ob das System die Vonage Video API für WebRTC unterstützt. Beachten Sie, dass diese Methode automatisch aufgerufen wird, wenn Sie OT.initPublisher() oder OT.initSession(), und falls das System die Vonage Video API nicht unterstützt, zeigt die OpenTok.js-Bibliothek eine Meldung für den Benutzer an. Rufen Sie die OT.checkSystemRequirements() Methode vor dem Aufruf OT.initPublisher() oder OT.initSession() falls Sie nicht möchten, dass die Bibliothek diese Meldung anzeigt.

Siehe: : - OT.upgradeSystemRequirements()

Rückgabe:

Ob das System die Vonage Video API für WebRTC unterstützt (1) oder nicht (0).

(static) getActiveAudioOutputDevice()

Gibt ein Promise zurück, das das aktuelle Audioausgabegerät zurückgibt.

Die Methode gibt ein Promise zurück, das ein Objekt mit zwei Eigenschaften liefert: deviceId und label, die jeweils Zeichenfolgen sind.

Die deviceId Die Eigenschaft ist eine eindeutige ID für das Gerät. Sie können die deviceId als Parameter der OT.setAudioOutputDevice() Methode. Die Website deviceId Die Eigenschaft wird auf „undefined“ gesetzt, wenn der Benutzer zuvor keinen Zugriff auf eine Kamera und ein Mikrofon gewährt hat.

Die label Die Eigenschaft identifiziert das Gerät. Die label Die Eigenschaft wird auf eine leere Zeichenfolge gesetzt, wenn der Benutzer zuvor keinen Zugriff auf eine Kamera und ein Mikrofon gewährt hat.

Hinweis: Derzeit wird die Funktion von den Desktop-Versionen von Chrome 49+, Edge 17+, Opera 36+ sowie den aktuellen Versionen von Samsung Internet, WebView für Android und WebView für iOS unterstützt.

Siehe: : - OT.getAudioOutputDevices() - OT.setAudioOutputDevice()

(static) getAudioOutputDevices()

Listet die dem Browser zur Verfügung stehenden Audioausgabegeräte (z. B. Lautsprecher) auf.

Die Methode gibt ein Promise zurück, das ein Array von Objekten auflöst, die den verfügbaren Audioausgabegeräten entsprechen. Jedes Objekt verfügt über zwei Eigenschaften: deviceId und label, die jeweils Zeichenfolgen sind.

Die deviceId Die Eigenschaft ist eine eindeutige ID für das Gerät. Sie können die deviceId als Parameter der OT.setAudioOutputDevice() Methode. Die Website deviceId Die Eigenschaft wird auf „undefined“ gesetzt, wenn der Benutzer zuvor keinen Zugriff auf eine Kamera und ein Mikrofon gewährt hat. Falls keine Audioausgabegeräte verfügbar sind, wird die Eigenschaft auf null.

Die label Die Eigenschaft identifiziert das Gerät. Die label Die Eigenschaft wird auf eine leere Zeichenfolge gesetzt, wenn der Benutzer zuvor keinen Zugriff auf eine Kamera und ein Mikrofon gewährt hat.

Anmerkungen::

• Derzeit wird die Funktion von den Desktop-Versionen von Chrome 49+, Edge 17+, Opera 36+ sowie den aktuellen Versionen von Samsung Internet, WebView für Android und WebView für iOS unterstützt.
• Der Browser kann die Anzahl der angezeigten Audioausgabegeräte auf eines beschränken, bevor der Benutzer den Zugriff auf eine Kamera oder ein Mikrofon gewährt hat.

Siehe: : - OT.setAudioOutputDevice() - OT.getActiveAudioOutputDevice()

(static) getDevices(callback) → {Promise.<Array.<Device>>}

Listet die Audio-Eingabegeräte (z. B. Mikrofone) und Video-Eingabegeräte (Kameras) auf, die dem Browser zur Verfügung stehen. Diese Methode gibt ein Promise zurück, das das Array der Geräte enthält. Jedes Objekt verfügt über drei Eigenschaften: kind, deviceIdund label, die jeweils Zeichenfolgen sind.

Die kind Eigenschaft wird auf "audioInput" für Audio-Eingabegeräte oder "videoInput" für Video-Eingabegeräte.

Die deviceId Die Eigenschaft ist eine eindeutige ID für das Gerät. Sie können die deviceId als audioSource oder videoSource Eigenschaft des options Parameter des OT.initPublisher() Methode.

Die label Die Eigenschaft identifiziert das Gerät. Die label Die Eigenschaft wird auf eine leere Zeichenfolge gesetzt, wenn der Benutzer zuvor keinen Zugriff auf eine Kamera und ein Mikrofon gewährt hat.

Parameter:

Siehe: : - OT.initPublisher()

Rückgabe:

Ein Promise, das die Liste der Geräte enthält

(static) getSupportedCodecs() → {Promise}

Ruft die Liste der unterstützten Codecs für die Kodierung und Dekodierung von Videostreams ab.

Das folgende Beispiel ruft die Liste der unterstützten Codecs für die Kodierung und Dekodierung von Videostreams ab:

(async () => {
  try {
    const supportedCodecs = await OT.getSupportedCodecs();
    if (supportedCodecs.videoEncoders.indexOf('H264') < 0 &&
        supportedCodecs.videoDecoders.indexOf('H264') < 0) {
      // The client does not support encoding or decoding H264.
      // Let's recommend using a different browser.
    }
  } catch(err) {
    console.log(err);
  }
})();

Anhand der Listen der unterstützten Videocodecs können Sie feststellen, ob der Client Video unterstützt, je nach bevorzugtem Videocodec und Art der verwendeten Sitzung. Sie können den bevorzugten Videocodec auf der Seite „Projekt“ Ihres Vonage Video API-Konto. In weitergeleitete Sitzungen (Sitzungen, die den Vonage Video API Media Router verwenden) wird für alle Clients in der Sitzung der bevorzugte Videocodec verwendet. In weitergeleiteten Sitzungen senden die Clients Streams direkt untereinander, und jedes Publisher-Subscriber-Paar versucht, einen gemeinsamen Videocodec zu finden, den beide verwenden können. In dieser Hinsicht kann der von dem Paar in einer weitergeleiteten Sitzung verwendete Videocodec von der Einstellung für den bevorzugten Videocodec abweichen. Weitere Informationen finden Sie in der Vonage Video API Video-Codecs Leitfaden für Entwickler.

Rückgabe:

Ein Promise, das aufgelöst wird, sobald die Liste der unterstützten Codecs vorliegt. Das Promise wird (im Erfolgsfall) mit einem Objekt aufgelöst, das zwei Eigenschaften besitzt: videoDecoders, eine Reihe von unterstützten Videocodecs für die Dekodierung sowie videoEncoders, eine Reihe von unterstützten Videocodecs für die Codierung, wie zum Beispiel:

{
   videoDecoders: ['H264', 'VP8', 'VP9'],
   videoEncoders: ['H264', 'VP8', 'VP9']
}

Die Promise wird abgelehnt, wenn beim Abrufen der Liste ein Fehler auftritt.

(static) getUserMedia(options) → {Promise}

Ruft ein MediaStream-Objekt ab, das ein Mikrofon und eine Kamera als Audio- und Videoquelle verwendet. Diese Methode gibt ein Promise zurück, das aufgelöst wird, sobald der Benutzer die Berechtigung zur Nutzung der Kamera oder des Mikrofons (oder beider) erteilt hat und das MediaStream-Objekt verfügbar ist. Das Promise wird abgelehnt, wenn beim Abrufen der Medien ein Fehler auftritt oder wenn der Endbenutzer den Zugriff auf die Kamera oder das Mikrofon verweigert.

Mit dieser Methode können Sie `MediaStreamTrack`-Objekte abrufen, um sie an die audioSource und videoSource Optionen des OT.initPublisher() Methode. Rufen Sie diese Methode beispielsweise auf, um einen `MediaStream` abzurufen, der das Mikrofon und die Kamera als Audio- und Videoquellen verwendet. Anschließend können Sie getVideoTracks()[0] auf das MediaStream-Objekt, um ein MediaStreamTrack-Objekt für das Videomaterial der Kamera abzurufen. Anschließend können Sie das Video-MediaStreamTrack-Objekt als Quelle für ein HTML-Video-Element hinzufügen, dieses Video-Element in ein HTML-Canvas-Element zeichnen und Videofilter oder -effekte auf das Canvas anwenden. Dann können Sie die captureStream() Methode des HTMLCanvasElement-Objekts, um ein MediaStream-Objekt abzurufen und getVideoTracks()[0] auf das MediaStream-Objekt, um ein Video-MediaStreamTrack- Objekt zu erhalten (auf das die Videofilter oder -effekte angewendet wurden). Schließlich können Sie das Video- MediaStreamTrack-Objekt als videoSource Eigenschaft der Optionen, die Sie an OT.initPublisher(). Der Vonage Video API Publisher verwendet die Videospur (mit den angewendeten Filtern und Effekten) als Videoquelle.

Parameter:

Siehe: : - Die Optionen (insbesondere audioSource und videoSource) der OT.initPublisher() Methode

Rückgabe:

Ein Promise, das erfüllt wird, sobald der Benutzer die Berechtigung zur Nutzung der Kamera oder des Mikrofons (oder beider) erteilt hat und das MediaStream-Objekt verfügbar ist. Das Promise wird abgelehnt, wenn beim Abrufen der Medien ein Fehler auftritt, wenn der Endbenutzer den Zugriff auf die Kamera oder das Mikrofon verweigert oder wenn die Methode im Internet Explorer aufgerufen wird.

(static) hasEndToEndEncryptionSupport() → {Boolean}

Ob der Client eine End-to-End-Verschlüsselung unterstützt.

Das folgende Beispiel aktiviert die End-to-End-Verschlüsselung, sofern diese vom Client unterstützt wird:

// Publish in a session with end-to-end encryption, if supported
if (OT.hasEndToEndEncryptionSupport()) {
  session.publish(publisher, error) = {
    ...
  });
}

Siehe: : - OT.initSession() - Session.publish()

Rückgabe:

Ob der Client eine End-to-End-Verschlüsselung unterstützt (true), oder auch nicht (false).

(static) hasMediaProcessorSupport(mediaType) → {Boolean}

Ob der Client Medienprozessoren wie Video- und Audiofilter unterstützt.

Das folgende Beispiel aktiviert den Filter „Hintergrundunschärfe“, sofern dieser vom Client unterstützt wird:

// Add background blur, if supported
if (OT.hasMediaProcessorSupport('video')) {
  publisherOptions.videoFilter = {
    type: 'backgroundBlur',
  };
}
// Add advanced noise suppression, if supported
if (OT.hasMediaProcessorSupport('audio')) {
  publisherOptions.audioFilter = {
    type: 'advancedNoiseSuppression',
  };
}

const publisher = OT.initPublisher(publisherOptions);

Parameter:

Siehe: : - OT.initPublisher() - Publisher.applyVideoFilter() - Publisher.applyAudioFilter()

Rückgabe:

Ob der Client Medienprozessoren unterstützt (true), wie Video- und Audiofilter, oder auch nicht (false).

(static) initPublisher(targetElement, properties, completionHandler) → {Herausgeber}

Initialisiert ein Publisher-Objekt und gibt es zurück. Dieses Publisher-Objekt können Sie anschließend an Session.publish() um einen Stream in einer Sitzung zu veröffentlichen.

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.

Parameter:

Siehe: : - Session.publish()

Rückgabe:

Das Publisher-Objekt.

(static) initSession(apiKey, sessionId, options) → {Sitzung}

Initialisiert das lokale Sitzungsobjekt für eine angegebene Sitzungs-ID und gibt es zurück.

Sie stellen eine Verbindung zu einer Vonage Video API-Sitzung her, indem Sie die connect() Methode des Session-Objekts, das von der OT.initSession() Methode. Beachten Sie, dass der Aufruf von OT.initSession() stellt keine Verbindung zur Cloud her. Es initialisiert lediglich das Session-Objekt, mit dem Sie eine Verbindung herstellen (und nach dem Verbindungsaufbau weitere Vorgänge ausführen) können.

Beachten Sie, dass Sie pro Sitzungs-ID nur ein Session-Objekt initialisieren können. Der Aufruf von OT.initSession() Ein zweiter Aufruf mit derselben Sitzungs-ID liefert das zuvor erstellte Session-Objekt zurück. Sie können jedoch mehrere Session-Objekte für verschiedene Sitzungen (mit unterschiedlichen Sitzungs-IDs) initialisieren, um eine Verbindung zu mehreren Sitzungen herzustellen.

Wenn der Client die Verbindung zur Sitzung trennt (und die Sitzung ein sessionDisconnected Ereignis) können Sie das Session-Objekt wiederverwenden, um die Verbindung zur Sitzung wiederherzustellen. Das Session-Objekt behält jedoch alle vorhandenen Ereignisbehandler bei, die ihm zugeordnet sind. Sie können alle Ereignisbehandler entfernen, indem Sie die off() Methode des Session-Objekts (ohne Übergabe von Parametern).

Ein Beispiel finden Sie unter Session.connect().

Parameter:

Rückgabe:

Das Sitzungsobjekt, über das alle weiteren Interaktionen mit der Sitzung stattfinden werden.

(static) log(message)

Sendet eine Zeichenfolge an die Debugger-Konsole. Die Funktion protokolliert jedoch nur dann in der Konsole, wenn Sie die Protokollierungsstufe auf OT.LOG oder OT.DEBUG, durch einen Anruf bei OT.setLogLevel(OT.LOG) oder OT.setLogLevel(OT.DEBUG).

Parameter:

Siehe: : - OT.setLogLevel()

(static) off(type, handler, context)

Entfernt einen Ereignis-Handler.

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

OT.off("exceptionEvent", exceptionEventHandler);

Wenn Sie einen Ereignisnamen übergeben und nein Handler-Methode: Alle Handler für diese Ereignisse werden entfernt:

OT.off("exceptionEvent");

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 die Zuordnung der Handler angibt:

OT.off(
  {
    exceptionEvent: exceptionEventHandler
  },
  this
);

Parameter:

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

(static) on(type, handler, context)

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

Das OT-Objekt löst eine Art von Ereignis aus – ein exception Ereignis. Der folgende Code fügt einen Ereignis-Listener für das exception Veranstaltung:

OT.on("exception", 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:

OT.on("exception",
  function (event) {
    // This is the event handler.
  }),
  session
);

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

Parameter:

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

(static) once(type, handler, context)

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

Der folgende Code fügt einen einmaligen Ereignis-Handler für das exception Veranstaltung:

OT.once("exception", function (event) {
  console.log(event);
}

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

OT.once("exception",
  function (event) {
    // This is the event handler.
  },
  session
);

Die Methode unterstützt außerdem 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 dafür in jedem Handler angibt:

OT.once(
  {exeption: function (event) {
    // This is the event handler.
    }
  },
  session
);

Parameter:

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

(static) registerScreenSharingExtension(kind, id, version)

Registrieren Sie eine Erweiterung für die Bildschirmfreigabe in einer älteren Version von Chrome oder Opera.

Anmerkung: In Chrome 72+ oder Opera 59+ ist keine Erweiterung für die Bildschirmfreigabe erforderlich. Der Endnutzer wird aufgefordert, den Zugriff auf den Bildschirm zu gewähren, genau wie bei der Erteilung des Zugriffs auf eine Kamera. Eine Erweiterung für die Bildschirmfreigabe benötigen Sie nur für ältere Versionen von Opera und Chrome.

Verwenden Sie die OT.checkScreenSharingCapability() Methode zur Überprüfung, ob eine Erweiterung erforderlich, registriert und installiert ist.

Die Vonage Video API Erweiterungen für die Bildschirmfreigabe Das Repo enthält Code zur Erstellung einer Erweiterung für die Bildschirmfreigabe.

Parameter:

Siehe: : - OT.initPublisher() - OT.checkScreenSharingCapability()

(static) removeEventListener(type, listener)

Diese Methode ist veraltet. Verwenden Sie stattdessen off() stattdessen.

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

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

Parameter:

Siehe: : - off()

(static) reportIssue(completionHandler) → {Promise.<string>}

Melde ein Problem, das bei deiner App aufgetreten ist. Du kannst die Problem-ID mit Inspektor oder wenn Sie ein Problem mit dem Vonage-API-Supportteam besprechen.

Parameter:

Rückgabe:

Ein Promise, das auf die Berichts-ID verweist

(static) setAudioOutputDevice() → {Promise}

Legt das neue Audioausgabegerät fest.

Die Methode gibt ein Promise zurück, das aufgelöst wird, sobald der Vorgang erfolgreich abgeschlossen ist. Tritt ein Fehler auf, wird das Promise abgelehnt.

Hinweis: Derzeit werden folgende Desktop-Versionen der Browser unterstützt: Chrome 49+, Firefox 116+, Edge 17+, Opera 36+, Safari 26+ sowie WebView unter iOS 26+.

Siehe: : - OT.getAudioOutputDevices() - OT.getActiveAudioOutputDevice()

Rückgabe:

Ein Promise, das erfüllt wird, wenn der Vorgang erfolgreich abgeschlossen wurde. Tritt ein Fehler auf, wird das Promise abgelehnt.

(static) setLogLevel(logLevel)

Legt die Protokollierungsstufe der API fest.

Aufruf von OT.setLogLevel() legt die Protokollierungsstufe für Laufzeit-Protokollmeldungen fest, die von der Vonage Video API-Bibliothek generiert werden. Der Standardwert für die Protokollierungsstufe ist OT.ERROR.

Die JavaScript-Bibliothek der Vonage Video API zeigt Protokollmeldungen in der Debugger-Konsole (z. B. Firebug) an, sofern eine solche vorhanden ist.

Im folgenden Beispiel wird die Sitzungs-ID durch Aufruf von OT.log(). Der Code protokolliert außerdem eine Fehlermeldung, wenn er versucht, einen Stream zu veröffentlichen, bevor Sie eine Verbindung zur Sitzung hergestellt haben (durch Aufruf von Session.connect()).

OT.setLogLevel(OT.LOG);
session = OT.initSession(sessionId);
OT.log(sessionId);
publisher = OT.initPublisher("publishContainer");
session.publish(publisher);

Parameter:

Siehe: : - OT.log()

(static) setProxyUrl()

Legt die URL des IP-Proxy-Servers fest. Mit der IP-Proxy-Funktion leitet der Client den gesamten Internetverkehr (mit Ausnahme von Medien-Streams) über Ihren Proxy-Server weiter.

Sie müssen diese Methode aufrufen, bevor Sie andere Methoden der Vonage Video API aufrufen. Dadurch wird sichergestellt, dass der Proxy-Server für den Datenverkehr der Vonage Video API verwendet wird. Andernfalls schlägt der Aufruf fehl, und die OT Das Objekt sendet ein exception Veranstaltung. Die OT Das Objekt löst außerdem ein exception Selbst wenn Sie diese Methode aufrufen, nachdem Sie sie bereits zuvor aufgerufen haben.

Diese Funktion ist als Zusatzfunktion verfügbar. Weitere Informationen finden Sie unter Leitfaden für Entwickler von IP-Proxys.

(static) unblockAudio()

Bewirkt, dass die Audioinhalte von Abonnenten in Browsern wiedergegeben werden, in denen Audio blockiert ist. Sie müssen diese Methode aufrufen, wenn ein HTML-Element ein click Veranstaltung.

Sie müssen diese Methode nur aufrufen, wenn Sie die Anzeige des Standard-Symbols für die Audiowiedergabe des Abonnenten deaktivieren (indem Sie die style.audioBlockedDisplayMode Eigenschaft der options Parameter des Session.subscribe() Methode). Sie können diese Methode aufrufen, wenn der Benutzer auf ein HTML-Element klickt, das Sie auf der Seite anzeigen.

Der Abonnent versendet eine audioBlocked Ereignis , wenn Audio blockiert wird. Als Reaktion auf dieses Ereignis können Sie ein UI-Element anzeigen, um den Endbenutzer darauf hinzuweisen, auf das Audio des Wiedergabe-Abonnenten zu reagieren. Rufen Sie die OT.unblockAudio() Methode, die als Reaktion darauf ausgeführt wird, dass der Benutzer auf ein DOM-Element klickt.

Anmerkung: Der Ton des Teilnehmers wird ebenfalls automatisch freigeschaltet, wenn der lokale Client Zugriff auf die Kamera oder das Mikrofon erhält (beispielsweise als Reaktion auf einen erfolgreichen Aufruf von OT.initPublisher()).

Siehe: : - Subscriber.isAudioBlocked() - Die audioBlocked und audioUnblocked Veranstaltungen für Abonnenten

Rückgabe:

Versprechen Das Versprechen wird erfüllt, wenn die Audiowiedergabe bei allen blockierten Abonnenten erfolgreich ist. Das Versprechen wird abgelehnt, wenn die Wiedergabe fehlschlägt. Siehe Fehler für Einzelheiten.

(static) upgradeSystemRequirements()

Zeigt Informationen zu den Systemanforderungen für die Vonage Video API für WebRTC an. Diese Informationen werden in einem iframe-Element angezeigt, das das Browserfenster ausfüllt.

Anmerkung: Diese Informationen werden automatisch angezeigt, wenn Sie die OT.initSession() oder die OT.initPublisher() Methode falls der Client die Vonage Video API für WebRTC nicht unterstützt.

Anmerkung: Diese Funktion wird in Zukunft nicht mehr unterstützt.

Siehe: : - OT.checkSystemRequirements()

Veranstaltungen

Ausnahme

Wird von der OT-Klasse ausgelöst, wenn in der App eine Ausnahme auftritt. Beachten Sie, dass Sie einen Ereignis-Handler für die exception Ereignis durch Aufruf der OT.on() Methode.

Siehe: : - Ausnahmeereignis