Verbindungsklasse - Amazon DCV

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verbindungsklasse

Die Verbindungsklasse, die durch den Aufruf der connectMethode des dcv Moduls abgerufen wurde. Ein Beispiel zur Verwendung finden Sie im Abschnitt Erste Schritte.

Enthüllt

Methoden

Auflisten

attachDisplay(SiegdisplayConf), → {Versprechen. <number>|Versprechen. < {Code: MultiMonitorErrorCode, Nachricht: Zeichenfolge} >}

Fügt einem Fenster eine bestimmte Anzeige hinzu. Sie können das Hauptdisplay nicht anschließen. Bei Erfolg gibt die Funktion den zurückdisplayId.

Parameter:

Name Typ Beschreibung
win Object Das Fenster, an das das Display angeschlossen werden muss.
displayConf Object Die Konfiguration des Displays.
Name Typ Attribute Beschreibung
displayId Zahl <optional> Die ID des Displays.
displayDivName Der Name des Display-Divs.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen. <number>| Versprechen. < {Code: MultiMonitorErrorCode, Nachricht: Zeichenfolge} >

captureClipboardEvents(aktiviert, Win,displayId) → {void}

Startet oder beendet das Abhören von Copy-Paste-Ereignissen. Bei interaktiven Zwischenablagen (immer beim Einfügen) müssen wir anfangen, die Copy/Paste-Ereignisse abzuhören. Es könnte nützlich sein, das Abhören nur dann zu starten und zu beenden, wenn es nötig ist, zum Beispiel wenn ein Modal angezeigt wird.

Parameter:

Name Typ Attribute Beschreibung
enabled boolesch Um mit dem Abhören von Ereignissen zu beginnen, geben Sie antrue. Um das Abhören von Ereignissen zu beenden, geben Sie anfalse.
win Object <optional> Das Fenster, in dem Sie nach Ereignissen Ausschau halten können. Wenn es weggelassen wird, wird das Standardfenster verwendet.
displayId Zahl <optional> Die ID des Displays, das die Ereignisse abhören soll. Wenn nicht angegeben, wird die Standardanzeige des Fensters verwendet.

Rückgabe:

Typ

void

detachDisplay(displayId) → {void}

Trennt ein bestimmtes Display ab. Das Hauptdisplay kann nicht abgenommen werden.

Parameter:

Name Typ Beschreibung
displayId Zahl Die ID des Displays, das abgenommen werden soll.

Rückgabe:

Typ

void

disconnect () → {void}

Trennt die Verbindung zum DCV Amazon-Server und schließt die Verbindung.

Rückgabe:

Typ

void

disconnectCollaborator(connectionId) → {void}

Fordert die Trennung eines Mitarbeiters an, der mit der angegebenen Verbindungs-ID verbunden ist (seit Amazon DCV Web Client SDK Version 1.1.0).

Parameter:

Name Typ Beschreibung
connectionId boolesch Die ID der Verbindung, die getrennt wird.

Rückgabe:

Typ

void

enableDisplayQualityUpdates (aktivieren) → {void}

Aktiviert oder deaktiviert Updates zur Anzeigequalität für Streaming-Bereiche, die keine Updates erhalten. Das Deaktivieren von Updates zur Anzeigequalität reduziert die Bandbreitennutzung, verringert aber auch die Anzeigequalität.

Parameter:

Name Typ Beschreibung
enable boolesch Um Aktualisierungen der Anzeigequalität zu aktivieren, geben Sie antrue. Geben Sie an, um Aktualisierungen der Anzeigequalität zu deaktivierenfalse.

Rückgabe:

Typ

void

enableHighPixelDichte (aktivieren) → {void}

Aktiviert oder deaktiviert die hohe Pixeldichte auf dem Client.

Parameter:

Name Typ Beschreibung
enable boolesch Ob eine hohe Pixeldichte aktiviert werden soll oder nicht.

Rückgabe:

Typ

void

enableTimezoneRedirection(aktivieren) → {Promise|Promise. < {Code: TimezoneRedirectionErrorCode, Nachricht: Zeichenfolge} >}

Aktiviert oder deaktiviert die Zeitzonenumleitung. Sobald sie aktiviert ist, fordert der Client den Server auf, die Zeitzone des Server-Desktops an die Zeitzone des Clients anzupassen.

Parameter:

Name Typ Beschreibung
enable boolesch Geben Sie an, um die Zeitzonenumleitung zu aktivieren. true Geben Sie an, um die Zeitzonenumleitung zu deaktivieren. false

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen. <number>| Versprechen. < {Code: TimezoneRedirectionErrorCode, Nachricht: Zeichenfolge} >

enterRelativeMouseModus () → {void}

Aktiviert den relativen Mausmodus.

Rückgabe:

Typ

void

getConnectedDevices() → {Versprechen. <Reihe. < MediaDeviceInfo >>|Versprechen. < {message: string} >}

Fordert eine Liste der Mediengeräte an, die mit dem Client-Computer verbunden sind.

Rückgabe:

Bei Erfolg wird ein Promise zurückgegeben, das in ein Array von MediaDeviceInfo Objekten aufgelöst wird. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen. <Reihe. < MediaDeviceInfo >> | Versprochen. < {message: string} >

getFileExplorer() → {Versprechen. < Dateispeicher >|Promise. < {Code: ChannelErrorCode, Nachricht: Zeichenfolge} >}

Ruft ein Objekt zur Verwaltung des Dateispeichers des DCV Amazon-Servers ab.

Rückgabe:

Versprich es. Löst das Ergebnis in das Datei-Explorer-Objekt auf, wenn es erfüllt ist, oder in ein Fehlerobjekt, wenn es abgelehnt wird.

Typ

Versprich es. < Dateispeicher > | Versprechen. < {Code: ChannelErrorCode, Nachricht: Zeichenfolge} >

getServerInfo() → {serverInfo}

Ruft Informationen über den DCV Amazon-Server ab.

Rückgabe:

Informationen über die Serversoftware.

getScreenshot() → {Versprechung|Versprechen. < {Code: ScreenshotErrorCode, Nachricht: Zeichenfolge} >}

Ruft den Screenshot des Remote-Desktops im PNG Format ab. Der Screenshot wird im screenshotCallbackObserver zurückgegeben. nullwird stattdessen im Falle von Fehlern zurückgegeben.

Rückgabe:

Versprechen, das gelöst wird, wenn die Anfrage bearbeitet wird. Bei Ablehnung erhalten wir ein Fehlerobjekt.

Typ

Versprechen | Versprechen. < {Code: ScreenshotErrorCode, Nachricht: Zeichenfolge} >

getStats() → {Statistiken}

Ruft Statistiken über den DCV Amazon-Server ab.

Rückgabe:

Informationen zu den Streaming-Statistiken.

latchModifierKey(Schlüssel, Ort,isDown) → {boolean}

Sendet eine einzelne Tastatur keydown oder ein einzelnes keyup Ereignis für einen zulässigen Modifikator.

Parameter:

Name Typ Beschreibung
key Steuerung | Alt | | Meta AltGraph | OS | Shift Der Schlüssel zum Senden.
location KeyboardEvent. Standort Der Standort des Schlüssels. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location.
isDown boolesch Wenn das einzufügende Schlüsselereignis ein Keydown (true) oder ein Keyup () ist. false

Rückgabe:

Wenn die angeforderte Kombination gültig ist, kehrt die Funktion zurücktrue, andernfalls kehrt sie zurück. false

Typ

boolesch

openChannel(Name, RückrufeauthToken, Namespace) → {Promise|Promise. < {Code: ChannelErrorCode, Nachricht: Zeichenfolge} >}

Öffnet einen benutzerdefinierten Datenkanal für die Verbindung, falls er auf dem DCV Amazon-Server erstellt wurde.

Parameter:

Name Typ Beschreibung
name Zeichenfolge Der Name des Kanal.
authToken Zeichenfolge Das Authentifizierungstoken, das für die Verbindung mit dem Kanal verwendet werden soll.
callbacks Object Die onMessage onClose aufzurufenden Funktionen und Callbacks.
namespace Zeichenfolge Der Namespace des Kanals. Verfügbar seit Amazon DCV Web Client SDK 1.2.0 und Amazon DCV Server 2022.1.

Rückgabe:

Versprochen. Bei Ablehnung erhalten wir ein Fehlerobjekt.

Typ

Versprechen | Versprechen. < {Code: ChannelErrorCode, Nachricht: Zeichenfolge} >

queryFeature(featureName) → {Versprechen. < {aktiviert: boolean, remote? : Zeichenfolge,? autoCopy : boolesch,? autoPaste : boolesch,? serviceStatus : Zeichenfolge, verfügbar? : boolean} >|Versprechen. < {message: string} >}

Fragt den Status einer bestimmten DCV Amazon-Serverfunktion ab.

Parameter:

Name Typ Beschreibung
featureName Funktion Der Name des Features, das abgefragt werden soll.

Rückgabe:

Versprich es. Bei Auflösung gibt die Funktion ein status Objekt zurück, das immer eine enabled Eigenschaft und möglicherweise auch andere Eigenschaften enthält. Bei Ablehnung gibt die Funktion ein error Objekt zurück.

Typ

{Versprechen. < {aktiviert: boolean, remote? : Zeichenfolge,? autoCopy : boolesch,? autoPaste : boolesch,? serviceStatus : Zeichenfolge, verfügbar? : boolean} > | Versprechen. < {message: string} >

registerKeyboardShortcuts(Abkürzungen) → {void}

Registriert Tastenkombinationen.

Parameter:

Name Typ Beschreibung
shortcuts Reihe. <Object> Das Array von Schlüsseln und Zuordnungen, die registriert werden sollen.
Name Typ Beschreibung
sequence Reihe. <Object> Die Tastenkombination zur Registrierung.
Name Typ Beschreibung
key KeyboardEvent.key Der Wert der vom Benutzer gedrückten Taste. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.location Das Array der zu sendenden Schlüssel. Die Position der Taste auf der Tastatur. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location.
output Reihe. <Object> Die beabsichtigte Aktion, die mit der Tastenkombination ausgeführt werden soll.
Name Typ Beschreibung
key KeyboardEvent. Schlüssel Der Wert der vom Benutzer gedrückten Taste. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.location Das Array der zu sendenden Schlüssel. Die Position der Taste auf der Tastatur. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location.

Rückgabe:

Typ

void

requestDisplayConfig(highColorAccuracy) → {Versprechung|Versprechen. < {Code: DisplayConfigErrorCode, Nachricht: Zeichenfolge} >}

Fordert eine aktualisierte Display-Konfiguration vom DCV Amazon-Server an. Verfügbar seit Amazon DCV Web Client SDK 1.1.0 und Amazon DCV Server 2022.0.

Parameter:

Name Typ Beschreibung
highColorAccuracy boolesch Ob eine hohe Farbgenauigkeit verlangt werden soll oder nicht.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen | Versprechen. < {Code: DisplayConfigErrorCode, Nachricht: Zeichenfolge} >

requestDisplayLayout(Layout) → {Versprechen|Versprechen. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >}

Fordert ein aktualisiertes Display-Layout für die Verbindung an.

Parameter:

Name Typ Beschreibung
layout Reihe. < Überwachen > Die angeforderten Anzeigen werden im Layout angezeigt.

Rückgabe:

Versprich es. Bei Ablehnung erhalten wir ein Fehlerobjekt.

Typ

Versprechen | Versprechen. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >

requestResolution(Breite, Höhe) → {Promise|Promise. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >}

Fordert eine aktualisierte Bildschirmauflösung vom DCV Amazon-Server an.

Parameter:

Name Typ Beschreibung
width Zahl Die anzufordernde Breite in Pixeln. Der zulässige Mindestwert ist0.
height Zahl Die anzufordernde Höhe in Pixeln. Der zulässige Mindestwert ist0.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen | Versprechen. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >

sendKeyboardEvent(Ereignis) → {boolean}

Sendet ein Tastaturkürzel-Ereignis. Weitere Informationen zu Tastaturereignissen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent. Zu den gültigen Tastaturereignissen gehören: keydownkeypress, undkeyup. Weitere Informationen zu diesen Ereignissen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events.

Parameter:

Name Typ Beschreibung
event KeyboardEvent Das zu sendende Tastaturereignis.

Rückgabe:

Wenn das Ereignis nicht gültig ist, kehrt die Funktion zurückfalse. Wenn das Ereignis gültig ist, kehrt die Funktion zurücktrue.

Typ

boolesch

sendKeyboardShortcut(Abkürzung) → {void}

Sendet eine Tastenkombination. Verwenden Sie diese Funktion, um eine vollständige keydown oder eine keyup Sequenz zu senden. Wenn Sie beispielsweise Strg + Alt + Del senden, werden die keydown Ereignisse für alle Tasten gesendet, gefolgt von den keyup Ereignissen. Verwenden Sie diese Funktion auch dann, wenn Sie eine einzelne Taste senden möchten.

Parameter:

Name Typ Beschreibung
shortcut Reihe. <Object> Das Array der zu sendenden Schlüssel.
Name Typ Beschreibung
key KeyboardEvent. Schlüssel Der Wert der vom Benutzer gedrückten Taste. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.location Das Array der zu sendenden Schlüssel. Die Position der Taste auf der Tastatur. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location.

Rückgabe:

Typ

void

setDisplayQuality(min, maxopt) → {void}

Legt die für die Verbindung zu verwendende Bildqualität fest. Gültiger Bereich ist 0 bis100, 1 wobei die niedrigste Bildqualität und die höchste Bildqualität angegeben 100 werden. Geben Sie 0 an, ob der aktuelle Wert beibehalten werden soll.

Parameter:

Name Typ Attribute Beschreibung
min Zahl Die minimale Bildqualität.
max Zahl <optional> Die maximale Bildqualität.

Rückgabe:

Typ

void

setDisplayScale(scaleRatio,displayId) → {Versprechen|Versprechen. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >} () DEPRECATED

Seit Version 1.3.0 veraltet. Die Anzeigeskala muss nicht mehr eingestellt werden. Mauskoordinaten werden automatisch intern verwaltet.

Informiert Amazon darüberDCV, dass die Anzeige auf der Client-Seite skaliert ist. Verwenden Sie diese Option, um den Server darüber zu informieren, dass er Mausereignisse skalieren muss, um sie an das Anzeigeverhältnis des Clients anzupassen.

Parameter:

Name Typ Beschreibung
scaleRatio float Das zu verwendende Skalierungsverhältnis. Muss eine strikt positive Zahl sein.
displayId Zahl Die ID des zu skalierenden Displays.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen | Versprechen. < {Code: ResolutionErrorCode, Nachricht: Zeichenfolge} >

setKeyboardQuirks(Macken) → {void}

Legt die Eigenheiten der Tastatur für den Client-Computer fest.

Parameter:

Name Typ Beschreibung
quirks Object Die Tastatur ist beim Aktivieren oder Deaktivieren eigenartig.
Name Typ Beschreibung
macOptionToAlt boolesch Geben Sie an, um die Optionstaste der Alt-Taste für macOS zuzuordnentrue. Andernfalls geben Sie false an.
macCommandToControl boolesch Um die Befehlstaste Strg für macOS zuzuordnen, geben Sie antrue. Andernfalls geben Sie false an.

Rückgabe:

Typ

void

setMaxDisplayAuflösung (maxWidth,maxHeight) → {void}

Legt die maximale Bildschirmauflösung fest, die für die Verbindung verwendet werden soll.

Parameter:

Name Typ Beschreibung
maxWidth Zahl Die maximale Anzeigebreite in Pixeln. Der zulässige Mindestwert ist0.
maxHeight Zahl Die maximale Anzeigehöhe in Pixeln. Der zulässige Mindestwert ist0.

Rückgabe:

Typ

void

setMicrophone(aktivieren) → {Promise|Promise. < {Code: AudioErrorCode, Nachricht: Zeichenfolge} >}

Aktiviert oder deaktiviert das Mikrofon.

Parameter:

Name Typ Beschreibung
enable boolesch Geben true Sie an, um das Mikrofon zu aktivieren. Um das Mikrofon zu deaktivieren, geben Sie anfalse.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen | Versprechen. < {Code: AudioErrorCode, Nachricht: Zeichenfolge} >

setMinDisplayAuflösung (minWidth,minHeight) → {void}

Legt die minimale Bildschirmauflösung fest, die für die Verbindung verwendet werden soll. Für einige Anwendungen ist möglicherweise eine minimale Bildschirmauflösung erforderlich. Wenn die erforderliche Mindestauflösung größer als die vom Client unterstützte maximale Auflösung ist, wird eine Strategie zur Größenänderung verwendet. Verwenden Sie diese Funktion mit Bedacht. Die Strategie zur Größenänderung könnte zu einem weniger präzisen Maus- und Touch-Eingabesystem führen.

Parameter:

Name Typ Beschreibung
minWidth Zahl Die minimale Anzeigebreite in Pixeln. Der zulässige Mindestwert ist0.
minHeight Zahl Die minimale Anzeigehöhe in Pixeln. Der zulässige Mindestwert ist0.

Rückgabe:

Typ

void

setUploadBandwidth(Wert) → {Zahl}

Legt die maximale Bandbreite fest, die für das Hochladen von Dateien auf den Amazon-Server verwendet werden soll. DCV

Parameter:

Name Typ Beschreibung
value Zahl Die maximale Bandbreitenbeschränkung in kBit/s. Der gültige Bereich liegt zwischen 1024 kbit/s und 102400 kbit/s.

Rückgabe:

- Das festgelegte Bandbreitenlimit. nullwenn die Dateispeicherfunktion auf dem Server deaktiviert ist.

Typ

Zahl

setVolume(Volumen) → {void}

Legt die Lautstärke fest, die für Audio verwendet werden soll. Der gültige Bereich liegt zwischen 0 und 100, wobei 0 die niedrigste Lautstärke und 100 die höchste Lautstärke ist.

Parameter:

Name Typ Beschreibung
volume Zahl Der zu verwendende Lautstärkepegel.

Rückgabe:

Typ

void

setMicrophone(aktivieren,deviceId) → {Promise|Promise. < {Code: AudioErrorCode, Nachricht: Zeichenfolge} >}

[Experimentell — könnte sich in future ändern] Aktiviert oder deaktiviert das Mikrofon.

Parameter:

Name Typ Beschreibung
enable boolesch Um das Mikrofon zu aktivieren, geben Sie antrue. Um das Mikrofon zu deaktivieren, geben Sie anfalse.
deviceId Zeichenfolge Die Geräte-ID des Mikrofons. Wenn kein angegeben deviceId ist, default deviceId wird das verwendet.

Rückgabe:

Versprich es. Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen | Versprechen. < {Code: AudioErrorCode, Nachricht: Zeichenfolge} >

setWebcam(aktivieren,deviceId) → {Versprechen|Versprechen. < {Code: WebcamErrorCode, Nachricht: Zeichenfolge} >}

Aktiviert oder deaktiviert die Webcam.

Parameter:

Name Typ Beschreibung
enable boolesch Geben true Sie an, um die Webcam zu aktivieren. Geben Sie an, um die Webcam zu deaktivierenfalse.
deviceId Zeichenfolge Die Geräte-ID der Webcam.

Rückgabe:

Versprechen Sie, dass bei Erfolg die Auflösung auf die angeschlossene/abgetrennte Webcam erfolgt. deviceId Wenn das Versprechen abgelehnt wird, gibt es ein Fehlerobjekt zurück.

Typ

Versprechen. <string>| Versprechen. < {Code: WebcamErrorCode, Nachricht: Zeichenfolge} >

syncClipboards() → {boolean}

Synchronisiert die Zwischenablage des lokalen Clients mit der Zwischenablage des DCV Remote-Amazon-Servers. Autocopy muss vom Browser unterstützt werden.

Rückgabe:

Wenn die Zwischenablagen synchronisiert wurden, kehrt die Funktion zurück. true Wenn die Zwischenablagen nicht synchronisiert wurden oder wenn der Browser das automatische Kopieren nicht unterstützt, kehrt die Funktion zurück. false

Typ

boolesch