DCV-Modul - Amazon DCV
MethodenMitgliederDefinitionen für Typ und Rückruf

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.

DCV-Modul

Ein Modul, das die Client-Seite des DCV-Protokolls implementiert.

Methoden

authentifizieren (authParams) → {Authentifizierung}

Startet den Authentifizierungsprozess für den angegebenen Amazon DCV-Serverendpunkt.

Parameter:

Name Typ Beschreibung
url Zeichenfolge Der Hostname und der Port des laufenden Amazon DCV-Servers im folgenden Format:https://dcv_host_address:port. Beispiel: https://my-dcv-server:8443.
authenticationToken Zeichenfolge Das Authentifizierungstoken, das für die Authentifizierung verwendet werden soll.
callbacks Authentifizierungs-Callbacks Die Callbacks, die während des Authentifizierungsprozesses aufgerufen werden können.

Rückgabe:

- Das Authentifizierungsobjekt.

Typ

Authentifizierung

verbinden (config) → {Versprechen. < Verbindung >|Promise. < {Code: ConnectionErrorCode, Nachricht: Zeichenfolge} >}

Stellt eine Verbindung zum angegebenen Amazon DCV-Serverendpunkt her. Wenn die Verbindung erfolgreich ist, wird ein Connection-Objekt zurückgegeben. Wenn die Verbindung fehlschlägt, wird ein Fehlerobjekt zurückgegeben.

Parameter:

Name Typ Beschreibung
config ConnectionConfig Das ConnectionConfig Objekt.

Rückgabe:

- Ein Connection-Objekt oder ein Fehlerobjekt.

Typ

Versprich es. < Verbindung > | Versprechen. < {Code: ConnectionErrorCode, Nachricht: Zeichenfolge} >

setLogHandler(Handler) → {void}

Legt eine benutzerdefinierte Log-Handler-Funktion fest. Beim Überschreiben des Standard-Log-Handlers geht beim Debuggen mit der Browserkonsole die ursprüngliche Position des Logeintrags verloren.

Parameter:

Name Typ Beschreibung
handler function Die benutzerdefinierte Log-Handler-Funktion. Die Handlerfunktion enthält level (number), levelName (string), domain (string) und message (string).

Rückgabe:

Typ

void

setLogLevel(Ebene) → {void}

Legt die Protokollebene fest. Dies ist nur erforderlich, wenn der Standard-Log-Handler verwendet wird.

Parameter:

Name Typ Beschreibung
level LogLevel Die zu verwendende Protokollstufe.

Rückgabe:

Typ

void

Mitglieder

(Konstante) AudioError: AudioErrorCode

Die AudioError Codes enumieren.

Type:

(konstant) AuthenticationError: AuthenticationErrorCode

Die AuthenticationError Codes enumieren.

Type:

(konstant) ChannelError: ChannelErrorCode

Die ChannelError Codes enumieren.

Type:

(konstant) ClosingReasonError: ClosingReasonErrorCode

Die ClosingReasonError Codes enumieren.

Type:

(konstant) ConnectionError: ConnectionErrorCode

Die ConnectionError Codes enumieren.

Type:

(konstant) CustomChannelError: CustomChannelErrorCode

Die CustomChannelError Codes enumieren.

Type:

(konstant) DisplayConfigError: DisplayConfigErrorCode

Die DisplayConfigError Codes enumieren.

Type:

(konstant) FileStorageError: FileStorageErrorCode

Die FileStorageError Codes enumieren.

Type:

(konstant) LogLevel: LogLevel

Die verfügbaren SDK-Protokollebenen.

Type:

(konstant) MultiMonitorError: MultiMonitorErrorCode

Die MultiMonitorError Codes enumieren.

Type:

(konstant) ResolutionError: ResolutionErrorCode

Die ResolutionError Codes enumieren.

Type:

(konstant) TimezoneRedirectionError: TimezoneRedirectionErrorCode

Die TimezoneRedirectionError Codes enumieren.

Type:

(konstant) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

Die TimezoneRedirectionSetting Codes enumieren.

Type:

(konstant) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

Die TimezoneRedirectionStatus Codes enumieren.

Type:

(konstante) Version

Die Amazon DCV-Version mit Major, Minor, Patch, Revision, Extended und VersionStr.

Eigenschaften:

Name Typ Beschreibung
major Ganzzahl Die Hauptversionsnummer.
minor Ganzzahl Die Nummer der Nebenversion.
patch Ganzzahl Die Versionsnummer des Patches.
revision Ganzzahl Die Revisionsnummer.
extended Zeichenfolge Die erweiterte Zeichenfolge.
versionStr Zeichenfolge Eine Verkettung der Haupt-, Neben-, Patch- und Revisionsnummern im Formular. major.minor.patch+build.revision

(konstant): ScreenshotError ScreenshotErrorCode

Die ScreenshotError Codes enumieren.

Type:

(konstant) WebcamError: WebcamErrorCode

Die WebcamError Codes enumieren.

Type:

Definitionen für Typ und Rückruf

Auflisten

AudioErrorCode

Die im AudioError DCV-Modul verfügbaren Code-Aufzählungen

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • Zahl

Rückrufe zur Authentifizierung

Authentifizierungs-Rückrufe

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
promptCredentials authPromptCredentialsRückruf Die Callback-Funktion, die aufgerufen wird, wenn der Benutzer zur Eingabe von Anmeldeinformationen aufgefordert wird.
error authErrorCallback Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung fehlschlägt.
success authSuccessCallback Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung erfolgreich ist.
httpExtraSearchParamsCallback httpExtraSearchParamsCallback Die Callback-Funktion, die in der authenticate Methode aufgerufen werden soll, um benutzerdefinierte Abfrageparameter in die Authentifizierungs-URL einzufügen, bevor die Anfrage initiiert wird. Sie kann auch in der connect Methode verwendet werden, um die URL anzupassen, die beim Herstellen einer WebSocket Verbindung zum DCV-Server verwendet wird.

AuthenticationErrorCode

Die im AuthenticationError DCV-Modul verfügbaren Code-Aufzählungen

  • INVALID_MESSAGE

  • UNKNOWN_AUTH_MODE

  • SESSION_NOT_AVAILABLE

  • NO_SESSIONS

  • WRONG_CREDENTIALS

  • SASL_CHALLENGE

  • SASL_AUTH_MECHANISM

  • FAILED_COMMUNICATION

  • AUTHENTICATION_REJECTED

  • GENERIC_ERROR

  • WRONG_CREDENTIALS_FORMAT

  • WRONG_CREDENTIALS_TYPE

  • UNREQUESTED_CREDENTIALS

  • MISSING_CREDENTIAL

Type:

  • Zahl

authErrorCallback(Authentifizierung, Fehler)

Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung fehlschlägt.

Parameter:

Name Typ Beschreibung
authentication Authentifizierung Das Authentifizierungsobjekt.
error Object Das Fehlerobjekt, das durch den Authentifizierungsprozess ausgelöst wurde.
Name Typ Beschreibung
code AuthenticationErrorCode Der Fehlercode.
message Zeichenfolge Die Fehlermeldung.

authPromptCredentialsRückruf (Authentifizierung, Herausforderung)

Die Callback-Funktion, die aufgerufen wird, wenn der Benutzer zur Eingabe von Anmeldeinformationen aufgefordert wird. Der Benutzer muss die Aufforderung beantworten, indem er die angeforderten Anmeldeinformationen eingibt.

Parameter:

Name Typ Beschreibung
authentication Authentifizierung Das Authentifizierungsobjekt.
challenge Object Die Herausforderung.
Name Typ Beschreibung
requiredCredentials Reihe. <Object> Eine Reihe von angeforderten Anmeldeinformationsobjekten.
Name Typ Beschreibung
name Zeichenfolge Der Name der angeforderten Anmeldeinformationen.
type Zeichenfolge Der Typ der angeforderten Anmeldeinformationen.

authSuccessCallback(Authentifizierung, Authentifizierungsdaten)

Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung erfolgreich ist.

Parameter:

Name Typ Beschreibung
authentication Authentifizierung Das Authentifizierungsobjekt.
authenticationData Array. <Object> Eine Reihe von Objekten, die Amazon DCV-Sitzungs IDs - und Authentifizierungstoken enthalten.
Name Typ Beschreibung
sessionId Zeichenfolge Die Amazon DCV-Sitzungs-ID.
authToken Zeichenfolge Das Authentifizierungstoken für die Amazon DCV-Sitzung.

Kanal

Die verfügbaren Kanäle, die angegeben werden können.

Type:

  • „Zwischenablage“ | „Anzeige“ | „Eingabe“ | „Audio“ | „Dateispeicher“

ChannelErrorCode

Die im ChannelError DCV-Modul verfügbaren Code-Aufzählungen

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Type:

  • Zahl

clipboardEventCallback(Ereignis)

Die Callback-Funktion, die aufgerufen werden soll, wenn a generiert clipboardEvent wird.

Parameter:

Name Typ Beschreibung
event Object Informationen über das Zwischenablage-Ereignis.
Name Typ Attribute Beschreibung
name eingerichtet | kopieren | einfügen | | | dataSizeAlert | autoCopyDone newDataAvailable | autoPasteDone RemoteError | pasteAvailableData Immer präsent. Der Name des Ereignisses.
clipboardData Objekt | Zeichenfolge Die Daten in der Zwischenablage.
autoCopy boolesch <optional> Gibt an, ob das automatische Kopieren aus der Zwischenablage der Sitzung in die Zwischenablage des lokalen Clients aktiviert ist.
maxDataSize Zahl <optional> Die maximale Datenmenge, die in der Zwischenablage platziert werden kann.
error Zeichenfolge <optional> Fehlerinformationen, falls zutreffend.

ClosingReasonErrorCode

Die im DCV-Modul verfügbaren ClosingReasonError Code-Aufzählungen

  • TRANSPORT_ERROR

  • NO_ERROR

  • GENERIC_ERROR

  • INTERNAL_SERVER_ERROR

  • PROTOCOL_ERROR

  • AUTHORIZATION_DENIED

  • AUTHORIZATION_REVOKED

  • ACCESS_REJECTED

  • IDLE_TIMEOUT_EXPIRED

  • DISCONNECT_BY_OWNER

  • DISCONNECT_BY_USER

  • EVICTED

  • EXTERNAL_PROTOCOL_CONNECTION_EVICTED

  • DISCONNECTION_REQUESTED

Type:

  • Zahl

Farbraum

Die verfügbaren Farbräume, die angegeben werden können.

Type:

  • „RGB“ | „REC6YUV_01" | „YUV_09" REC7

Verbindungsrückrufe

Die Callbacks, die im Falle eines Verbindungsfehlers aufgerufen werden können.

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
disconnect DisconnectCallback Die Callback-Funktion, die aufgerufen werden soll, wenn die Verbindung beendet wird.
displayLayout displayLayoutCallback Die Callback-Funktion, die aufgerufen werden soll, wenn das Display-Layout oder die Auflösung geändert werden.
displayAvailability displayAvailabilityCallback Die Callback-Funktion, die aufgerufen werden soll, wenn sich die Verfügbarkeit eines Displays ändert.
firstFrame firstFrameCallback Die Callback-Funktion, die aufgerufen wird, wenn der erste Frame vom Amazon DCV-Server empfangen wird.
filePrinted filePrintedCallback Die Callback-Funktion, die aufgerufen wird, wenn eine Datei auf dem Amazon DCV-Server gedruckt wird.
fileDownload fileDownloadCallback Die Callback-Funktion, die aufgerufen wird, wenn eine Datei bereit ist, vom Amazon DCV-Server heruntergeladen zu werden.
dataChannel dataChannelCallback Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über die Verfügbarkeit eines Datenkanals sendet.
licenseNotification licenseNotificationCallback Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über den Lizenzstatus sendet.
idleWarningNotification idleWarningNotificationRückruf Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Leerlaufzeitüberschreitungswarnung sendet.
collaboratorList collaboratorListCallback Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server die Liste der Mitarbeiter sendet (seit Amazon DCV Web Client SDK Version 1.1.0).
qualityIndicatorState qualityIndicatorStateRückruf Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status der Verbindungsqualitätsanzeige ändert.
filestorageEnabled filestorageEnabledCallback Die Callback-Funktion, die aufgerufen werden soll, wenn die Dateispeicherung aktiviert oder deaktiviert ist.
featuresUpdate featuresUpdateCallback Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status einer Funktion ändert.
clipboardEvent clipboardEventCallback Die Callback-Funktion, die aufgerufen werden soll, wenn eine generiert clipboardEvent wird.
deviceChangeEvent deviceChangeEventRückruf Die Callback-Funktion, die aufgerufen werden soll, wenn ein deviceChange Ereignis ausgelöst wird.
screenshot ScreenshotCallback Die Callback-Funktion, die aufgerufen werden soll, wenn a verfügbar ist. screenshot
httpExtraSearchParamsCallback httpExtraSearchParamsCallback Die Callback-Funktion, die aufgerufen werden soll, um die URL anzupassen, wenn eine WebSocket Verbindung zum Amazon DCV-Server hergestellt wird. Beachten Sie, dass dieser Callback auch mit der authenticate Methode verwendet werden kann, um Abfrageparameter dynamisch an die Authentifizierungs-URL anzuhängen, bevor das SDK die Anfrage sendet.
httpExtraHeadersCallback httpExtraHeadersRückruf Die Callback-Funktion, die aufgerufen werden soll, um der HTTP-Anfrage beim Verbindungsaufbau benutzerdefinierte Header hinzuzufügen.

ConnectionConfig

Die Konfiguration für eine Amazon DCV-Verbindung.

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
url Zeichenfolge Der Hostname und der Port des laufenden Amazon DCV-Servers im folgenden Format:https://dcv_host_address:port. Beispiel: https://my-dcv-server:8443.
sessionId Zeichenfolge Die Amazon DCV-Sitzungs-ID.
authToken Zeichenfolge Das Authentifizierungstoken, das für die Verbindung mit dem Server verwendet werden soll.
baseUrl Zeichenfolge Die absolute oder relative URL, von der aus SDK-Dateien geladen werden sollen.
resourceBaseUrl Zeichenfolge Die absolute oder relative URL, von der aus auf DCV-Ressourcen zugegriffen werden soll.
enabledChannels Array. < Kanal > Zeigt die Liste der Kanäle an, die aktiviert werden können. Wenn nicht angegeben oder ein leeres Array bereitgestellt wird, werden standardmäßig alle verfügbaren Kanäle verwendet.
losslessColorspace Farbraum Gibt den Farbraum an, der verwendet wird. Wenn nicht angegeben, wird standardmäßig „RGB“ verwendet.
divId Zeichenfolge Die ID des div Objekts im HTML-DOM, in dem das SDK die Zeichenfläche mit dem Remote-Stream erstellen soll.
volumeLevel Ganzzahl Die bevorzugte Lautstärke. Der gültige Bereich liegt zwischen 0 und 100.
clipboardAutoSync boolesch Gibt an, ob das automatische Kopieren von der Zwischenablage der Amazon DCV-Sitzung in die Zwischenablage des lokalen Clients für kompatible Webbrowser aktiviert ist.
dynamicAudioTuning boolesch Gibt an, ob das Audio basierend auf den Audioeinstellungen des Amazon DCV-Servers dynamisch eingestellt werden soll, wenn eine Verbindung hergestellt wird.
clientHiDpiScaling boolesch Gibt an, ob die Leinwand auf der Grundlage der DPI des Clients skaliert werden soll.
highColorAccuracy boolesch Gibt an, ob eine hohe Farbgenauigkeit verwendet werden sollte, sofern verfügbar. Wenn nicht angegeben, ist die Standardeinstellung. false
enableWebCodecs Boolesch Gibt an, ob verwendet werden WebCodecs soll, falls verfügbar. Es gilt der Standardwert false, wenn keine Angabe gemacht wird.
observers Verbindungsrückrufe Die Callback-Funktionen zum Aufrufen von Ereignissen, die sich auf die Verbindung beziehen.
callbacks ConnectionCallbacks Entspricht der observers Eigenschaft, aber jeder Callback enthält das Connection-Objekt als ersten Parameter.

ConnectionErrorCode

Die im ConnectionError DCV-Modul verfügbaren Code-Aufzählungen

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR(seit DCV Server 2021.0)

  • INTERNAL_SERVER_ERROR(seit DCV Server 2021.0)

  • AUTHENTICATION_FAILED(seit DCV Server 2021.0)

  • PROTOCOL_ERROR(seit DCV Server 2021.0)

  • INVALID_SESSION_ID(seit DCV Server 2021.0)

  • INVALID_CONNECTION_ID(seit DCV Server 2021.0)

  • CONNECTION_LIMIT_REACHED(seit DCV Server 2021.0)

  • SERVER_UNREACHABLE(seit DCV Server 2022.1)

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL(seit DCV Server 2022.2)

  • TRANSPORT_ERROR

Type:

  • Zahl

Verzeichnis erstellen (Pfad)

Parameter:

Name Typ Beschreibung
path Zeichenfolge Der absolute Pfad auf dem Server, auf dem wir ein Verzeichnis erstellen möchten. Er sollte auch den Namen des Zielverzeichnisses enthalten.

CustomChannelErrorCode

Die im DCV-Modul verfügbaren CustomChannelError Code-Aufzählungen

  • TRANSPORT_ERROR

Type:

  • Zahl

dataChannelCallback(Information)

Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über die Verfügbarkeit eines Datenkanals sendet.

Parameter:

Name Typ Beschreibung
info Object Informationen über den Datenkanal.
Name Typ Beschreibung
name Zeichenfolge Der Name des Datenkanals.
token Zeichenfolge Das Authentifizierungstoken für den Datenkanal.

deleteFile (Pfad)

Parameter:

Name Typ Beschreibung
path Zeichenfolge Der absolute Pfad auf dem Server, der die Datei identifiziert, die wir löschen möchten.

deviceChangeEventRückruf ()

Die Callback-Funktion, die aufgerufen wird, wenn ein deviceChange Ereignis ausgelöst wird.

disconnectCallback (Grund)

Die Callback-Funktion, die aufgerufen werden soll, wenn die Verbindung beendet wird.

Parameter:

Name Typ Beschreibung
reason Object Der Grund für die Unterbrechung der Verbindung.
Name Typ Beschreibung
code Zahl Der Ursachencode.
message Zeichenfolge Die Ursachenmeldung.

displayAvailabilityCallback(Status, DisplayID)

Die Callback-Funktion, die aufgerufen wird, wenn sich die Verfügbarkeit eines Displays ändert.

Parameter:

Name Typ Beschreibung
status Object Der Status der Anzeige.
Name Typ Beschreibung
enabled boolesch Zeigt an, ob die Anzeige aktiviert ist.
closed boolesch Zeigt an, ob das Display geschlossen ist.
displayId Zahl Die Kennung für das Display.

DisplayConfigErrorCode

Die im DCV-Modul verfügbaren DisplayConfigError Code-Aufzählungen

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Type:

  • Zahl

displayLayoutCallback(ServerWidth, ServerHeight, Heads)

Die Callback-Funktion, die aufgerufen werden soll, wenn das Display-Layout oder die Auflösung geändert werden.

Parameter:

Name Typ Beschreibung
serverWidth Zahl Die Breite (in Pixeln) der primären Anzeige.
serverHeight Zahl Die Höhe (in Pixeln) des primären Displays.
heads Reihe. < Überwachen > Die vom Amazon DCV-Server unterstützten Displayköpfe.

Merkmal

Die Merkmalswerte.

  • display- Zeigt die Verfügbarkeit eines Videostreams mit einem einzigen Display an.

  • display-multi- Zeigt die Verfügbarkeit eines Videostreams mit mehreren Displays an.

  • high-color-accuracy- Zeigt die Verfügbarkeit einer hohen Farbgenauigkeit an (seit Amazon DCV Web Client SDK Version 1.1.0).

  • mouse- Zeigt die Verfügbarkeit von Mausfunktionen an.

  • keyboard- Zeigt die Verfügbarkeit von Tastaturfunktionen an.

  • keyboard-sas- Zeigt die Verfügbarkeit der SAS-Sequenzfunktion (Strg + Alt + Löschen) an.

  • relative-mouse- Zeigt die Verfügbarkeit des relativen Mausmodus an.

  • clipboard-copy- Zeigt die Verfügbarkeit der Funktion zum Kopieren der Zwischenablage vom Amazon DCV-Server zum Client an.

  • clipboard-paste- Zeigt an, ob die Funktion zum Einfügen in die Zwischenablage vom Client auf den Amazon DCV-Server verfügbar ist.

  • audio-in- Zeigt die Verfügbarkeit der Audioeingabefunktion über das Mikrofon an.

  • audio-out- Zeigt die Verfügbarkeit der Audiowiedergabefunktion an.

  • webcam- Zeigt die Verfügbarkeit der Webcam-Streaming-Funktionalität an.

  • file-download- Zeigt die Verfügbarkeit der Funktion zum Herunterladen von Dateien vom Amazon DCV-Server zum Client an.

  • file-upload- Zeigt die Verfügbarkeit der Datei-Upload-Funktionalität vom Client auf den Amazon DCV-Server an.

  • timezone-redirection— Zeigt die Verfügbarkeit von Funktionen zur Zeitzonenumleitung an (seit Amazon DCV Web Client SDK Version 1.3.0).

Type:

  • Zeichenfolge

featuresUpdateCallback(Liste der Funktionen)

Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status einer Funktion ändert.

Parameter:

Name Typ Beschreibung
featuresList Reihe. < Funktion > Eine Reihe von Funktionen, die sich geändert haben.

fileDownloadCallback(Dateiressource)

Die Callback-Funktion, die aufgerufen wird, wenn eine Datei bereit ist, vom Amazon DCV-Server heruntergeladen zu werden.

Parameter:

Name Typ Beschreibung
fileResource Object Informationen über die Datei, die zum Herunterladen bereit ist.
Name Typ Beschreibung
id Zeichenfolge Der Bezeichner für die Datei.
url Zeichenfolge Die URL, die zum Herunterladen der Datei verwendet werden soll.
domain Zeichenfolge Die Ressourcendomäne.
token Zeichenfolge Das Authentifizierungstoken, das zum Herunterladen der Datei verwendet werden soll. Das Token ist auch in der URL enthalten.

filePrintedCallback(Ressource drucken)

Die Callback-Funktion, die aufgerufen wird, wenn eine Datei auf dem Amazon DCV-Server gedruckt wird.

Parameter:

Name Typ Beschreibung
printResource Object Informationen über die gedruckte Datei.
Name Typ Beschreibung
id Zeichenfolge Die Kennung für die gedruckte Datei.
url Zeichenfolge Die URL, die zum Herunterladen der gedruckten Datei verwendet werden soll.
domain Zeichenfolge Die Ressourcendomäne. In diesem Fallprinter.
token Zeichenfolge Das Authentifizierungstoken, das zum Herunterladen der gedruckten Datei verwendet werden soll. Das Token ist auch in der URL enthalten.

Dateispeicher

Objekt, das das Erkunden und Ausführen von Aktionen im Dateisystem ermöglicht.

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
list Liste Funktion, die es ermöglicht, die Elemente (Dateien und Verzeichnisse) aufzulisten, die sich im angegebenen Pfad auf dem Server befinden.
createDirectory Verzeichnis erstellen Funktion, die es ermöglicht, ein Verzeichnis im angegebenen Pfad auf dem Server zu erstellen.
retrieveFile Datei abrufen Funktion, die es ermöglicht, eine Datei lokal unter dem angegebenen Pfad auf dem Server herunterzuladen.
deleteFile Datei löschen Funktion, die es ermöglicht, eine Datei im angegebenen Pfad auf dem Server zu löschen.
renameFile Datei umbenennen Funktion, die es ermöglicht, eine Datei vom angegebenen Quellpfad in den angegebenen Zielpfad umzubenennen.
renameDirectory Verzeichnis umbenennen Funktion, die es ermöglicht, ein Verzeichnis vom angegebenen Quellpfad in den absoluten Zielpfad umzubenennen.
storeFile Datei speichern Funktion, die es ermöglicht, eine lokale Datei in den angegebenen Pfad auf dem Server hochzuladen.

filestorageEnabledCallback(aktiviert)

Die Callback-Funktion, die aufgerufen werden soll, wenn die Dateispeicherung aktiviert ist. Lazy-Channel nur in Internet Explorer 11.

Parameter:

Name Typ Beschreibung
enabled boolesch Zeigt an, ob die Dateispeicherung aktiviert ist.

FileStorageErrorCode

Die im DCV-Modul verfügbaren FileStorageError Code-Aufzählungen

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Type:

  • Zahl

firstFrameCallback(ResizeEnabled, Enabled, DisplayID relativeMouseMode)

Die Callback-Funktion, die aufgerufen wird, wenn der erste Frame vom Amazon DCV-Server empfangen wird. Wird für jedes Display ausgegeben.

Parameter:

Name Typ Beschreibung
resizeEnabled boolesch Gibt an, ob der Server die Größenänderung des Client-Display-Layouts unterstützt.
relativeMouseModeEnabled boolesch Gibt an, ob der Server den relativen Mausmodus unterstützt.
displayId Zahl Der Bezeichner für das Display.

idleWarningNotificationRückruf () disconnectionDateTime

Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Leerlaufzeitüberschreitungswarnung sendet.

Parameter:

Name Typ Beschreibung
disconnectionDateTime Datum Datum und Uhrzeit der Verbindungsunterbrechung.

collaboratorListCallback(Mitarbeiter)

Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server die Liste der Mitarbeiter sendet.

Parameter:

Name Typ Beschreibung
collaborators Reihe. <Object> Eine Liste von Objekten, die Informationen über Mitarbeiter enthält.
Name Typ Beschreibung
username Zeichenfolge Der Benutzername des Mitarbeiters.
owner boolesch Gibt an, ob der Mitarbeiter der Sitzungsbesitzer ist.
connectionId Zahl Gibt die ID an, die der Server der Verbindung zugewiesen hat.

licenseNotificationCallback(Benachrichtigung)

Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über den Lizenzstatus sendet.

Parameter:

Name Typ Beschreibung
notification Object Die Benachrichtigung.
Name Typ Beschreibung
product Zeichenfolge Das DCV-Produkt.
status Zeichenfolge Der Status der Lizenz.
message Zeichenfolge Eine Nachricht.
leftDays Zahl Die Anzahl der Tage, bevor die Lizenz abläuft.
isDemo boolesch Gibt an, ob es sich bei der Lizenz um eine Demo-Lizenz handelt.
numUnlicensed Zahl Die Anzahl der nicht lizenzierten Verbindungen.
licensingMode Zeichenfolge Der Lizenzierungsmodus.
documentationUrl Zeichenfolge Die URL für die Dokumentation.

Liste (Pfad)

Parameter:

Name Typ Beschreibung
path Zeichenfolge Der absolute Pfad auf dem Server, dessen Inhalt wir auflisten möchten.

LogLevel

Die verfügbaren SDK-Protokollebenen.

Type:

  • TRACE | DEBUG | INFO | WARNUNG | FEHLER | STUMM

Überwachen

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
name Zeichenfolge Der Name des Displaykopfs.
rect Object Informationen über den Displaykopf.
Name Typ Beschreibung
x Zahl Die x Anfangskoordinate für den Displaykopf.
y Zahl Die y Anfangskoordinate für den Displaykopf.
width Zahl Die Breite (in Pixeln) des Displaykopfs.
height Zahl Die Höhe (in Pixeln) des Displaykopfs.
primary boolesch Gibt an, ob der Displaykopf der primäre Displaykopf ist. Dies wird anhand des Remote-Betriebssystems ermittelt, sofern verfügbar.
dpi Zahl Der DPI-Wert des Displaykopfs.

MultiMonitorErrorCode

Die im DCV-Modul verfügbaren MultiMonitorError Code-Aufzählungen

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

Type:

  • Zahl

qualityIndicatorStateRückruf (Status)

Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status der Verbindungsqualitätsanzeige ändert.

Parameter:

Name Typ Beschreibung
state Reihe. <Object> Informationen über die Verbindungsqualität.
Name Typ Beschreibung
name Zeichenfolge Der Name des Indikators.
status NORMAL | WARNUNG | KRITISCH Beschreibung des Status.
changed boolesch Zeigt an, ob sich der Status geändert hat.

Verzeichnis umbenennen (src, dest)

Parameter:

Name Typ Beschreibung
src Zeichenfolge Der absolute Quellpfad auf dem Server, der das Verzeichnis identifiziert, das wir umbenennen möchten.
dest Zeichenfolge Der absolute Zielpfad auf dem Server, der den Zielpfad und den Verzeichnisnamen angibt.

Datei umbenennen (src, dest)

Parameter:

Name Typ Beschreibung
src Zeichenfolge Der absolute Quellpfad auf dem Server, der die Datei identifiziert, die wir umbenennen möchten.
dest Zeichenfolge Der absolute Zielpfad auf dem Server, der den Zielpfad und den Dateinamen angibt.

ResolutionErrorCode

Die im DCV-Modul verfügbaren ResolutionError Codeaufzählungen

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Type:

  • Zahl

Datei abrufen (Pfad)

Parameter:

Name Typ Beschreibung
path Zeichenfolge Der absolute Pfad auf dem Server, der die Datei identifiziert, die wir lokal herunterladen möchten.

ScreenshotCallback (Bildschirmfoto)

Die Callback-Funktion, die aufgerufen werden soll, wenn ein Screenshot verfügbar ist.

Parameter:

Name Typ Beschreibung
screenshot byte[] Screenshot-Puffer im PNG-Format oder null wenn das Abrufen des Screenshots fehlgeschlagen ist.

ScreenshotErrorCode

Die im ScreenshotError DCV-Modul verfügbaren Code-Aufzählungen

  • NO_CHANNEL

  • GENERIC_ERROR

Type:

  • Zahl

Serverinfo

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
name Zeichenfolge Der Name der Software.
version Object Die Versionsnummer der Software.
Name Typ Beschreibung
major Zahl Die Hauptversionsnummer.
minor Zahl Die Nummer der Nebenversion.
revision Zahl Die Versionsnummer der Revision.
os Zeichenfolge Das Betriebssystem.
arch Zeichenfolge Die Architektur.
hostname Zeichenfolge Der Hostname

stats

Type:

  • Object

Eigenschaften:

Name Typ Beschreibung
fps Zahl Die aktuellen Frames pro Sekunde.
traffic Zahl Der aktuelle Verkehr in Bit/s.
peakTraffic Zahl Der Spitzenwert des Datenverkehrs bit/s seit dem Verbindungsaufbau.
latency Zahl Die aktuelle Latenz in ms.
currentChannels Zahl Die Anzahl der Kanäle, die seit dem Verbindungsaufbau geöffnet wurden.
openedChannels Zahl Die Anzahl der aktuell geöffneten Kanäle.
channelErrors Zahl Die Anzahl der Kanäle, die einen Fehler gemeldet haben.

StoreFile (Datei, Verzeichnis)

Parameter:

Name Typ Beschreibung
file Datei Das Dateiobjekt (weitere Informationen finden Sie unter https://developer.mozilla). org/en-US/docs/Web/API/File) wollen wir auf den Server hochladen.
dir Zeichenfolge Der absolute Pfad auf dem Server, auf den wir die Datei hochladen möchten.

TimezoneRedirectionErrorCode

Die im DCV-Modul verfügbaren TimezoneRedirectionError Code-Aufzählungen

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Type:

  • Zahl

TimezoneRedirectionSettingCode

Die im TimezoneRedirectionSetting DCV-Modul verfügbaren Code-Aufzählungen

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Type:

  • Zahl

TimezoneRedirectionStatusCode

Die im TimezoneRedirectionStatus DCV-Modul verfügbaren Code-Aufzählungen

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Type:

  • Zahl

WebcamErrorCode

Die im WebcamError DCV-Modul verfügbaren Code-Aufzählungen

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • Zahl

httpExtraSearchParamsCallback(Methode, URL, Hauptteil)

Die Callback-Funktion, die aufgerufen werden soll, um URLs während der Authentifizierung und beim Verbindungsaufbau benutzerdefinierte Abfrageparameter einzufügen. Dies ermöglicht erweiterte Integrationsszenarien, einschließlich der Möglichkeit, benutzerdefinierte Abfrageparameter anzuhängen und signierte AWS Signature Version 4 (Sigv4) -Werte hinzuzufügen, um Verbindungen über externe Systeme zu sichern und zu autorisieren.

Dieser Callback wird auch verwendet, um die URL anzupassen, die beim Herstellen einer WebSocket Verbindung zum Amazon DCV-Server verwendet wird.

Parameter:

Name Typ Beschreibung
method Zeichenfolge Die HTTP-Methode, die für die Anfrage verwendet wird.
url Zeichenfolge Die URL, die für die Anfrage verwendet wird.
body Zeichenfolge Der Inhalt des Anforderungs-Bodys.

Rückgabe:

URLSearchParamsObjekt, das die benutzerdefinierten Abfrageparameter enthält, die an die URL angehängt werden sollen.

Typ

URLSearchParameter

httpExtraHeadersRückruf (Methode, URL, Text)

Die Callback-Funktion, die aufgerufen werden soll, um beim Verbindungsaufbau benutzerdefinierte Header (z. B.Authorization) in die HTTP-Anfrage einzufügen.

Parameter:

Name Typ Beschreibung
method Zeichenfolge Die HTTP-Methode, die für die Anfrage verwendet wird.
url Zeichenfolge Die URL, die für die Anfrage verwendet wird.
body Zeichenfolge Der Inhalt des Anforderungs-Bodys.

Rückgabe:

Objekt, das Schlüssel-Wert-Paare enthält, die die benutzerdefinierten Header darstellen, die der HTTP-Anfrage hinzugefügt werden sollen.

Typ

Object