Hardware-Setup-Komponente

Die Komponente Hardware-Setup bietet eine Benutzeroberfläche für Clients die die [OpenTok.js] 1 Bibliothek, um die Kamera und das Mikrofon auszuwählen. Der Client kann die Kamera und das Mikrofon verwenden, um einen Stream in einer OpenTok.js Sitzung veröffentlichen.

Mit dem folgenden Skript-Tag können Sie eine vorgefertigte Version der Hardware-Setup-Komponente zu Ihrer Webseite hinzufügen:

<script src="https://static.opentok.com/hardware-setup/v1/js/opentok-hardware-setup.min.js"></script>

Sie können die Komponente auch aus der Datei Quellcode auf GitHub.

Verwendung der Komponente

Verwenden Sie die Komponente zusammen mit der [OpenTok.js] 1 SDK.

createOpentokHardwareSetupComponent()

Um die Komponente Hardware-Setup zu initialisieren, rufen Sie die Funktion createOpentokHardwareSetupComponent() Methode. Diese Methode nimmt die folgenden Parameter:

• targetElement -- Das DOM-Element, in das die Hardware-Einrichtung eingefügt werden soll Komponente eingefügt wird. (Siehe die Eigenschaft insertMode des nächsten Parameters, options).

• options -- Ein optionales Argument, das angibt, wie die Komponente in das HTML-DOM eingefügt wird, in Bezug auf den Parameter targetElement. Sie können diesen Parameter auf einen der folgenden Werte setzen:

  • "replace" -- Die Komponente ersetzt den Inhalt des targetElements. Dies ist der Standard.
  • "after" -- Die Komponente ist ein neues Element, das nach dem targetElement im dem HTML-DOM eingefügt. (Sowohl die Komponente als auch targetElement haben das gleiche übergeordnete Element.)
  • "before" -- Die Komponente ist ein neues Element, das vor dem targetElement im HTML-DOM eingefügt wird. (Sowohl die Komponente als auch das targetElement haben das gleiche übergeordnete Element.)
  • "append" -- Die Komponente ist ein neues Element, das als untergeordnetes Element des targetElement hinzugefügt. Wenn es andere untergeordnete Elemente gibt, wird die Komponente als das letzte untergeordnete Element des targetElements.

• completionHandler -- Eine Funktion, die aufgerufen wird, wenn die Komponente auf der Seite gerendert wird oder bei einem Fehler beim Aufruf der Methode. Im Fehlerfall wird dieser Funktion ein Objekt übergeben, das einen message Eigenschaft, die einen der folgenden Werte haben kann:

  • "Kein Element vorhanden, um Komponente zu platzieren"
  • "Dieser Browser unterstützt die getMediaDevices-APIs nicht"
  • "Es sind keine Audio- oder Videogeräte verfügbar".

  Wenn die Komponente erfolgreich auf der Seite gerendert wurde, wird der Completion Handler ohne Fehlerobjekt aufgerufen.

Die Methode gibt ein HardwareSetup-Objekt zurück, das über die folgenden Methoden verfügt: audioSource(), videoSource()und destroy().

Beispiel:

// Replace this with the ID of the target DOM element for the component
var element = document.querySelector('#hardware-setup');

var options = {
  insertMode: 'append' // Or use another insertMode setting.
};

var component = createOpentokHardwareSetupComponent(element, options, function(error) {
  if (error) {
    console.error('Error: ', error);
    element.innerHTML = '<strong>Error getting devices</strong>: '
      error.message;
    return;
  }
  // Add a button to call component.destroy() to close the component.
});

HardwareSetup.audioSource()

Gibt ein Objekt zurück, das die ausgewählte Audioquelle darstellt. Dieses Objekt hat eine deviceId Eigenschaft, die die eindeutige ID des Audiogeräts (eine Zeichenkette) darstellt. Sie können diese Zeichenfolge in einem Cookie speichern, um sie in einer späteren Sitzung zu verwenden. Sie können das Audioquellenobjekt oder dessen deviceId Eigenschaft als Wert für die audioSource Eigenschaft des Objekts properties, das in der Methode OT.initPublisher() Methode.

Beispiel:

// component is the object returned by createOpentokHardwareSetupComponent()
var publisherOptions = {
  audioSource: component.audioSource(),
  videoSource: component.videoSource()
};
OT.initPublisher(targetElement, publisherOptions);

HardwareSetup.videoSource()

Gibt ein Objekt zurück, das die ausgewählte Videoquelle darstellt. Dieses Objekt hat eine deviceId Eigenschaft, die die eindeutige ID des Videogeräts (eine Zeichenkette) darstellt. Sie können diese Zeichenfolge in einem Cookie zur Verwendung in einer zukünftigen Sitzung speichern. Sie können das Videoquellenobjekt oder dessen deviceId Eigenschaft als Wert für die videoSource Eigenschaft des Objekts properties, das in der Methode OT.initPublisher() Methode.

Beispiel:

// component is the object returned by createOpentokHardwareSetupComponent()
var publisherOptions = {
  audioSource: component.audioSource(),
  videoSource: component.videoSource()
};
OT.initPublisher(targetElement, publisherOptions);

HardwareSetup.destroy()

Schließt die Hardware-Einrichtungskomponente (falls sichtbar) und entfernt sie aus dem HTML-DOM.

Beispiel:

// component is the object returned by createOpentokHardwareSetupComponent()
component.destroy();