

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
<a name="dcv-module"></a>

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

**Topics**
+ [Methoden](#methods)
+ [Mitglieder](#members)
+ [Definitionen für Typ und Rückruf](#type-definitions)

## Methoden
<a name="methods"></a>

**Topics**
+ [[authentifizieren (authParams) → \$1Authentifizierung\$1](authentication-class.md)](#authenticate)
+ [verbinden (config) → \$1Versprechen. < [Verbindung](connection-class.md) >\$1Promise. < \$1Code: [ConnectionErrorCode](#ConnectionErrorCode), Nachricht: Zeichenfolge\$1 >\$1](#connect)
+ [setLogHandler(Handler) → \$1void\$1](#setLogHandler)
+ [setLogLevel(Ebene) → \$1void\$1](#setLogLevel)

### [authentifizieren (authParams) → \$1Authentifizierung\$1](authentication-class.md)
<a name="authenticate"></a>

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

#### Parameter:
<a name="parameters"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  url  |  Zeichenfolge  |  Der Hostname und der Port des laufenden Amazon DCV-Servers im folgenden Format:https://dcv\$1host\$1address:port. Beispiel: https://my-dcv-server:8443.  | 
|  authenticationToken  |  Zeichenfolge  |  Das Authentifizierungstoken, das für die Authentifizierung verwendet werden soll.  | 
|  callbacks  |  [Authentifizierungs-Callbacks](#authenticationCallbacks)  |  Die Callbacks, die während des Authentifizierungsprozesses aufgerufen werden können.  | 

#### Rückgabe:
<a name="returns"></a>

 - Das Authentifizierungsobjekt. 

 Typ   
 [Authentifizierung](authentication-class.md) 

### verbinden (config) → \$1Versprechen. < [Verbindung](connection-class.md) >\$1Promise. < \$1Code: [ConnectionErrorCode](#ConnectionErrorCode), Nachricht: Zeichenfolge\$1 >\$1
<a name="connect"></a>

 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:
<a name="parameters-1"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  config  |  [ConnectionConfig](#ConnectionConfig)  |  Das ConnectionConfig Objekt.  | 

#### Rückgabe:
<a name="returns-1"></a>

 - Ein Connection-Objekt oder ein Fehlerobjekt. 

 Typ   
 Versprich es. < [Verbindung](connection-class.md) > \$1 Versprechen. < \$1Code: [ConnectionErrorCode](#ConnectionErrorCode), Nachricht: Zeichenfolge\$1 > 

### setLogHandler(Handler) → \$1void\$1
<a name="setLogHandler"></a>

 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:
<a name="parameters-2"></a>


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

#### Rückgabe:
<a name="returns-2"></a>

 Typ   
 void 

### setLogLevel(Ebene) → \$1void\$1
<a name="setLogLevel"></a>

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

#### Parameter:
<a name="parameters-3"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  level  |  [LogLevel](#LogLevel)  |  Die zu verwendende Protokollstufe.  | 

#### Rückgabe:
<a name="returns-3"></a>

 Typ   
 void 

## Mitglieder
<a name="members"></a>

**Topics**
+ [(Konstante) AudioError : [AudioErrorCode](#AudioErrorCode)](#AudioError)
+ [(konstant) AuthenticationError : [AuthenticationErrorCode](#AuthenticationErrorCode)](#AuthenticationError)
+ [(konstant) ChannelError : [ChannelErrorCode](#ChannelErrorCode)](#ChannelError)
+ [(konstant) ClosingReasonError : [ClosingReasonErrorCode](#ClosingReasonErrorCode)](#ClosingReasonError)
+ [(konstant) ConnectionError : [ConnectionErrorCode](#ConnectionErrorCode)](#ConnectionError)
+ [(konstant) CustomChannelError : [CustomChannelErrorCode](#CustomChannelErrorCode)](#CustomChannelError)
+ [(konstant) DisplayConfigError : [DisplayConfigErrorCode](#DisplayConfigErrorCode)](#DisplayConfigError)
+ [(konstant) FileStorageError : [FileStorageErrorCode](#FileStorageErrorCode)](#FileStorageError)
+ [(konstant) LogLevel : [LogLevel](#LogLevel)](#LogLevel_)
+ [(konstant) MultiMonitorError : [MultiMonitorErrorCode](#MultiMonitorErrorCode)](#MultiMonitorError)
+ [(konstant) ResolutionError : [ResolutionErrorCode](#ResolutionErrorCode)](#ResolutionError)
+ [(konstant) TimezoneRedirectionError : [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)](#TimezoneRedirectionError)
+ [(konstant) TimezoneRedirectionSetting : [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)](#TimezoneRedirectionSetting)
+ [(konstant) TimezoneRedirectionStatus : [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)](#TimezoneRedirectionStatus)
+ [(konstante) Version](#version)
+ [(konstant): ScreenshotError [ScreenshotErrorCode](#ScreenshotErrorCode)](#ScreenshotError)
+ [(konstant) WebcamError : [WebcamErrorCode](#WebcamErrorCode)](#WebcamError)

### (Konstante) AudioError : [AudioErrorCode](#AudioErrorCode)
<a name="AudioError"></a>

 Die AudioError Codes enumieren. 

#### Type:
<a name="type"></a>
+  [AudioErrorCode](#AudioErrorCode) 

### (konstant) AuthenticationError : [AuthenticationErrorCode](#AuthenticationErrorCode)
<a name="AuthenticationError"></a>

 Die AuthenticationError Codes enumieren. 

#### Type:
<a name="type-1"></a>
+  [AuthenticationErrorCode](#AuthenticationErrorCode) 

### (konstant) ChannelError : [ChannelErrorCode](#ChannelErrorCode)
<a name="ChannelError"></a>

 Die ChannelError Codes enumieren. 

#### Type:
<a name="type-2"></a>
+  [ChannelErrorCode](#ChannelErrorCode) 

### (konstant) ClosingReasonError : [ClosingReasonErrorCode](#ClosingReasonErrorCode)
<a name="ClosingReasonError"></a>

 Die ClosingReasonError Codes enumieren. 

#### Type:
<a name="type-3"></a>
+  [ClosingReasonErrorCode](#ClosingReasonErrorCode) 

### (konstant) ConnectionError : [ConnectionErrorCode](#ConnectionErrorCode)
<a name="ConnectionError"></a>

 Die ConnectionError Codes enumieren. 

#### Type:
<a name="type-4"></a>
+  [ConnectionErrorCode](#ConnectionErrorCode) 

### (konstant) CustomChannelError : [CustomChannelErrorCode](#CustomChannelErrorCode)
<a name="CustomChannelError"></a>

 Die CustomChannelError Codes enumieren. 

#### Type:
<a name="type-5"></a>
+  [CustomChannelErrorCode](#CustomChannelErrorCode) 

### (konstant) DisplayConfigError : [DisplayConfigErrorCode](#DisplayConfigErrorCode)
<a name="DisplayConfigError"></a>

 Die DisplayConfigError Codes enumieren. 

#### Type:
<a name="type-8"></a>
+  [DisplayConfigErrorCode](#DisplayConfigErrorCode) 

### (konstant) FileStorageError : [FileStorageErrorCode](#FileStorageErrorCode)
<a name="FileStorageError"></a>

 Die FileStorageError Codes enumieren. 

#### Type:
<a name="type-6"></a>
+  [FileStorageErrorCode](#FileStorageErrorCode) 

### (konstant) LogLevel : [LogLevel](#LogLevel)
<a name="LogLevel_"></a>

 Die verfügbaren SDK-Protokollebenen. 

#### Type:
<a name="type-31"></a>
+  [LogLevel](#LogLevel) 

### (konstant) MultiMonitorError : [MultiMonitorErrorCode](#MultiMonitorErrorCode)
<a name="MultiMonitorError"></a>

 Die MultiMonitorError Codes enumieren. 

#### Type:
<a name="type-7"></a>
+  [MultiMonitorErrorCode](#MultiMonitorErrorCode) 

### (konstant) ResolutionError : [ResolutionErrorCode](#ResolutionErrorCode)
<a name="ResolutionError"></a>

 Die ResolutionError Codes enumieren. 

#### Type:
<a name="w2aac14b9c13c25b5"></a>
+  [ResolutionErrorCode](#ResolutionErrorCode) 

### (konstant) TimezoneRedirectionError : [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)
<a name="TimezoneRedirectionError"></a>

 Die TimezoneRedirectionError Codes enumieren. 

#### Type:
<a name="w2aac14b9c13c27b5"></a>
+  [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) 

### (konstant) TimezoneRedirectionSetting : [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)
<a name="TimezoneRedirectionSetting"></a>

 Die TimezoneRedirectionSetting Codes enumieren. 

#### Type:
<a name="w2aac14b9c13c29b5"></a>
+  [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) 

### (konstant) TimezoneRedirectionStatus : [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)
<a name="TimezoneRedirectionStatus"></a>

 Die TimezoneRedirectionStatus Codes enumieren. 

#### Type:
<a name="w2aac14b9c13c31b5"></a>
+  [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) 

### (konstante) Version
<a name="version"></a>

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

#### Eigenschaften:
<a name="properties"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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\$1build.revision  | 

### (konstant): ScreenshotError [ScreenshotErrorCode](#ScreenshotErrorCode)
<a name="ScreenshotError"></a>

 Die ScreenshotError Codes enumieren. 

#### Type:
<a name="type-34"></a>
+  [ScreenshotErrorCode](#ScreenshotErrorCode) 

### (konstant) WebcamError : [WebcamErrorCode](#WebcamErrorCode)
<a name="WebcamError"></a>

 Die WebcamError Codes enumieren. 

#### Type:
<a name="type-9"></a>
+  [WebcamErrorCode](#WebcamErrorCode) 

## Definitionen für Typ und Rückruf
<a name="type-definitions"></a>

**Topics**
+ [AudioErrorCode](#AudioErrorCode)
+ [Rückrufe zur Authentifizierung](#authenticationCallbacks)
+ [AuthenticationErrorCode](#AuthenticationErrorCode)
+ [authErrorCallback(Authentifizierung, Fehler)](#authErrorCallback)
+ [authPromptCredentialsRückruf (Authentifizierung, Herausforderung)](#authPromptCredentialsCallback)
+ [authSuccessCallback(Authentifizierung, Authentifizierungsdaten)](#authSuccessCallback)
+ [Kanal](#Channel)
+ [ChannelErrorCode](#ChannelErrorCode)
+ [clipboardEventCallback(Ereignis)](#clipboardEventCallback)
+ [ClosingReasonErrorCode](#ClosingReasonErrorCode)
+ [Farbraum](#Colorspace)
+ [Verbindungsrückrufe](#connectionCallbacks)
+ [ConnectionConfig](#ConnectionConfig)
+ [ConnectionErrorCode](#ConnectionErrorCode)
+ [Verzeichnis erstellen (Pfad)](#createDirectory)
+ [CustomChannelErrorCode](#CustomChannelErrorCode)
+ [dataChannelCallback(Information)](#dataChannelCallback)
+ [deleteFile (Pfad)](#deleteFile)
+ [deviceChangeEventRückruf ()](#deviceChangeEventCallback)
+ [disconnectCallback (Grund)](#disconnectCallback)
+ [displayAvailabilityCallback(Status, DisplayID)](#displayAvailabilityCallback)
+ [DisplayConfigErrorCode](#DisplayConfigErrorCode)
+ [displayLayoutCallback(ServerWidth, ServerHeight, Heads)](#displayLayoutCallback)
+ [Feature](#feature)
+ [featuresUpdateCallback(Liste der Funktionen)](#featuresUpdateCallback)
+ [fileDownloadCallback(Dateiressource)](#fileDownloadCallback)
+ [filePrintedCallback(Ressource drucken)](#filePrintedCallback)
+ [Dateispeicher](#filestorage)
+ [filestorageEnabledCallback(aktiviert)](#filestorageEnabledCallback)
+ [FileStorageErrorCode](#FileStorageErrorCode)
+ [firstFrameCallback(ResizeEnabled, Enabled, DisplayID relativeMouseMode)](#firstFrameCallback)
+ [idleWarningNotificationRückruf () disconnectionDateTime](#idleWarningNotificationCallback)
+ [collaboratorListCallback(Mitarbeiter)](#collaboratorListCallback)
+ [licenseNotificationCallback(Benachrichtigung)](#licenseNotificationCallback)
+ [Liste (Pfad)](#list)
+ [LogLevel](#LogLevel)
+ [Überwachen](#Monitor)
+ [MultiMonitorErrorCode](#MultiMonitorErrorCode)
+ [qualityIndicatorStateRückruf (Status)](#qualityIndicatorStateCallback)
+ [Verzeichnis umbenennen (src, dest)](#renameDirectory)
+ [Datei umbenennen (src, dest)](#renameFile)
+ [ResolutionErrorCode](#ResolutionErrorCode)
+ [Datei abrufen (Pfad)](#retrieveFile)
+ [ScreenshotCallback (Bildschirmfoto)](#screenshotCallback)
+ [ScreenshotErrorCode](#ScreenshotErrorCode)
+ [Serverinfo](#serverInfo)
+ [stats](#stats)
+ [StoreFile (Datei, Verzeichnis)](#storeFile)
+ [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)
+ [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)
+ [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)
+ [WebcamErrorCode](#WebcamErrorCode)
+ [httpExtraSearchParamsCallback(Methode, URL, Hauptteil)](#httpExtraSearchParamsCallback)
+ [httpExtraHeadersRückruf (Methode, URL, Text)](#httpExtraHeadersCallback)

### AudioErrorCode
<a name="AudioErrorCode"></a>

 Die im AudioError DCV-Modul verfügbaren Code-Aufzählungen 
+  `SETTING_AUDIO_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### Type:
<a name="type-10"></a>
+  number 

### Rückrufe zur Authentifizierung
<a name="authenticationCallbacks"></a>

 Authentifizierungs-Rückrufe 

#### Type:
<a name="type-11"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-1"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  promptCredentials  |  [authPromptCredentialsRückruf](#authPromptCredentialsCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn der Benutzer zur Eingabe von Anmeldeinformationen aufgefordert wird.  | 
|  error  |  [authErrorCallback](#authErrorCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung fehlschlägt.  | 
|  success  |  [authSuccessCallback](#authSuccessCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn die Authentifizierung erfolgreich ist.  | 
|  httpExtraSearchParamsCallback  |  [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
<a name="AuthenticationErrorCode"></a>

 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:
<a name="type-12"></a>
+  number 

### authErrorCallback(Authentifizierung, Fehler)
<a name="authErrorCallback"></a>

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

#### Parameter:
<a name="parameters-4"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  authentication  |  [Authentifizierung](authentication-class.md)  |  Das Authentifizierungsobjekt.  | 
|  error  |  Objekt  |  Das Fehlerobjekt, das durch den Authentifizierungsprozess ausgelöst wurde. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  [AuthenticationErrorCode](#AuthenticationErrorCode)  |  Der Fehlercode.  | 
|  message  |  Zeichenfolge  |  Die Fehlermeldung.  | 

### authPromptCredentialsRückruf (Authentifizierung, Herausforderung)
<a name="authPromptCredentialsCallback"></a>

 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:
<a name="parameters-5"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  authentication  |  [Authentifizierung](authentication-class.md)  |  Das Authentifizierungsobjekt.  | 
|  challenge  |  Objekt  |  Die Herausforderung. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  requiredCredentials  |  Reihe. <Object>  |  Eine Reihe von angeforderten Anmeldeinformationsobjekten. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  Zeichenfolge  |  Der Name der angeforderten Anmeldeinformationen.  | 
|  type  |  Zeichenfolge  |  Der Typ der angeforderten Anmeldeinformationen.  | 

### authSuccessCallback(Authentifizierung, Authentifizierungsdaten)
<a name="authSuccessCallback"></a>

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

#### Parameter:
<a name="parameters-6"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  authentication  |  [Authentifizierung](authentication-class.md)  |  Das Authentifizierungsobjekt.  | 
|  authenticationData  |  Array. <Object>  |  Eine Reihe von Objekten, die Amazon DCV-Sitzungs IDs - und Authentifizierungstoken enthalten. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  sessionId  |  Zeichenfolge  |  Die Amazon DCV-Sitzungs-ID.  | 
|  authToken  |  Zeichenfolge  |  Das Authentifizierungstoken für die Amazon DCV-Sitzung.  | 

### Kanal
<a name="Channel"></a>

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

#### Type:
<a name="type-13"></a>
+  „Zwischenablage“ \$1 „Anzeige“ \$1 „Eingabe“ \$1 „Audio“ \$1 „Dateispeicher“ 

### ChannelErrorCode
<a name="ChannelErrorCode"></a>

 Die im ChannelError DCV-Modul verfügbaren Code-Aufzählungen 
+  `ALREADY_OPEN` 
+  `INITIALIZATION_FAILED` 
+  `REJECTED` 

#### Type:
<a name="type-14"></a>
+  number 

### clipboardEventCallback(Ereignis)
<a name="clipboardEventCallback"></a>

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

#### Parameter:
<a name="parameters-7"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Attribute  |  Description  | 
| --- | --- | --- | --- | 
|  event  |  Objekt  |  Informationen über das Zwischenablage-Ereignis. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  eingerichtet \$1 kopieren \$1 einfügen \$1 \$1 \$1 dataSizeAlert \$1 autoCopyDone newDataAvailable \$1 autoPasteDone RemoteError \$1 pasteAvailableData  |   |  Immer präsent. Der Name des Ereignisses.  | 
|  clipboardData  |  Objekt \$1 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  |  number  |  <optional>  |  Die maximale Datenmenge, die in der Zwischenablage platziert werden kann.  | 
|  error  |  Zeichenfolge  |  <optional>  |  Fehlerinformationen, falls zutreffend.  | 

### ClosingReasonErrorCode
<a name="ClosingReasonErrorCode"></a>

 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:
<a name="type-15"></a>
+  number 

### Farbraum
<a name="Colorspace"></a>

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

#### Type:
<a name="type-16"></a>
+  „RGB“ \$1 „YUV\$1REC601" \$1 „YUV\$1“ REC709 

### Verbindungsrückrufe
<a name="connectionCallbacks"></a>

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

#### Type:
<a name="type-17"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-7"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  disconnect  |  [DisconnectCallback](#disconnectCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn die Verbindung beendet wird.  | 
|  displayLayout  |  [displayLayoutCallback](#displayLayoutCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn das Display-Layout oder die Auflösung geändert werden.  | 
|  displayAvailability  |  [displayAvailabilityCallback](#displayAvailabilityCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn sich die Verfügbarkeit eines Displays ändert.  | 
|  firstFrame  |  [firstFrameCallback](#firstFrameCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn der erste Frame vom Amazon DCV-Server empfangen wird.  | 
|  filePrinted  |  [filePrintedCallback](#filePrintedCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn eine Datei auf dem Amazon DCV-Server gedruckt wird.  | 
|  fileDownload  |  [fileDownloadCallback](#fileDownloadCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn eine Datei bereit ist, vom Amazon DCV-Server heruntergeladen zu werden.  | 
|  dataChannel  |  [dataChannelCallback](#dataChannelCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über die Verfügbarkeit eines Datenkanals sendet.  | 
|  licenseNotification  |  [licenseNotificationCallback](#licenseNotificationCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Benachrichtigung über den Lizenzstatus sendet.  | 
|  idleWarningNotification  |  [idleWarningNotificationRückruf](#idleWarningNotificationCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn der Amazon DCV-Server eine Leerlaufzeitüberschreitungswarnung sendet.  | 
|  collaboratorList  |  [collaboratorListCallback](#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](#qualityIndicatorStateCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status der Verbindungsqualitätsanzeige ändert.  | 
|  filestorageEnabled  |  [filestorageEnabledCallback](#filestorageEnabledCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn die Dateispeicherung aktiviert oder deaktiviert ist.  | 
|  featuresUpdate  |  [featuresUpdateCallback](#featuresUpdateCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn sich der Status einer Funktion ändert.  | 
|  clipboardEvent  |  [clipboardEventCallback](#clipboardEventCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn eine generiert clipboardEvent wird.  | 
|  deviceChangeEvent  |  [deviceChangeEventRückruf](#deviceChangeEventCallback)  |  Die Callback-Funktion, die aufgerufen wird, wenn ein deviceChange Ereignis ausgelöst wird.  | 
|  screenshot  |  [ScreenshotCallback](#screenshotCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, wenn a verfügbar ist. screenshot  | 
|  httpExtraSearchParamsCallback  |  [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](#httpExtraHeadersCallback)  |  Die Callback-Funktion, die aufgerufen werden soll, um der HTTP-Anfrage beim Verbindungsaufbau benutzerdefinierte Header hinzuzufügen.  | 

### ConnectionConfig
<a name="ConnectionConfig"></a>

 Die Konfiguration für eine Amazon DCV-Verbindung. 

#### Type:
<a name="type-18"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-8"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  url  |  Zeichenfolge  |  Der Hostname und der Port des laufenden Amazon DCV-Servers im folgenden Format:https://dcv\$1host\$1address: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](#Channel) >  |  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](#Colorspace)  |  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  |  Der bevorzugte Lautstärkepegel. Der gültige Bereich liegt zwischen 0 und 100.  | 
|  clipboardAutoSync  |  boolesch  |  Gibt an, ob das automatische Kopieren aus 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 des DPI-Werts des Clients skaliert werden soll.  | 
|  highColorAccuracy  |  boolesch  |  Gibt an, ob eine hohe Farbgenauigkeit verwendet werden sollte, sofern verfügbar. Wenn nicht angegeben, ist der Standardwert. 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](#connectionCallbacks)  |  Die Callback-Funktionen zum Aufrufen von Ereignissen, die sich auf die Verbindung beziehen.  | 
|  callbacks  |  [ConnectionCallbacks](#connectionCallbacks)  |  Entspricht der observers Eigenschaft, aber jeder Callback enthält das [Connection-Objekt](connection-class.md) als ersten Parameter.  | 

### ConnectionErrorCode
<a name="ConnectionErrorCode"></a>

 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:
<a name="type-19"></a>
+  number 

### Verzeichnis erstellen (Pfad)
<a name="createDirectory"></a>

#### Parameter:
<a name="parameters-8"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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
<a name="CustomChannelErrorCode"></a>

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

#### Type:
<a name="type-20"></a>
+  number 

### dataChannelCallback(Information)
<a name="dataChannelCallback"></a>

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

#### Parameter:
<a name="parameters-9"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  info  |  Objekt  |  Informationen über den Datenkanal. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  Zeichenfolge  |  Der Name des Datenkanals.  | 
|  token  |  Zeichenfolge  |  Das Authentifizierungstoken für den Datenkanal.  | 

### deleteFile (Pfad)
<a name="deleteFile"></a>

#### Parameter:
<a name="parameters-10"></a>


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

### deviceChangeEventRückruf ()
<a name="deviceChangeEventCallback"></a>

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

### disconnectCallback (Grund)
<a name="disconnectCallback"></a>

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

#### Parameter:
<a name="parameters-11"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Beschreibung  | 
| --- | --- | --- | 
|  reason  |  Objekt  |  Der Grund für die Unterbrechung der Verbindung. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  number  |  Der Ursachencode.  | 
|  message  |  Zeichenfolge  |  Die Ursachenmeldung.  | 

### displayAvailabilityCallback(Status, DisplayID)
<a name="displayAvailabilityCallback"></a>

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

#### Parameter:
<a name="parameters-12"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Beschreibung  | 
| --- | --- | --- | 
|  status  |  Objekt  |  Der Status der Anzeige. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  displayId  |  number  |  Die Kennung für das Display.  | 
|  enabled  |  boolesch  |  Zeigt an, ob die Anzeige aktiviert ist.  | 
|  closed  |  boolesch  |  Zeigt an, ob das Display geschlossen ist.  | 

### DisplayConfigErrorCode
<a name="DisplayConfigErrorCode"></a>

 Die im DCV-Modul verfügbaren DisplayConfigError Code-Aufzählungen 
+  `INVALID_ARGUMENT` 
+  `UNSUPPORTED_OPERATION` 
+  `NO_CHANNEL` 

#### Type:
<a name="type-32"></a>
+  number 

### displayLayoutCallback(ServerWidth, ServerHeight, Heads)
<a name="displayLayoutCallback"></a>

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

#### Parameter:
<a name="parameters-13"></a>


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

### Feature
<a name="feature"></a>

 Die Funktionswerte. 
+  `display`- Zeigt die Verfügbarkeit eines Videostreams mit einem Bildschirm 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 \$1 Alt \$1 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 die Verfügbarkeit der Funktion zum Einfügen in die Zwischenablage vom Client zum Amazon DCV-Server an. 
+  `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:
<a name="type-21"></a>
+  Zeichenfolge 

### featuresUpdateCallback(Liste der Funktionen)
<a name="featuresUpdateCallback"></a>

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

#### Parameter:
<a name="parameters-14"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  featuresList  |  Reihe. < [Funktion](#feature) >  |  Eine Reihe von Funktionen, die sich geändert haben.  | 

### fileDownloadCallback(Dateiressource)
<a name="fileDownloadCallback"></a>

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

#### Parameter:
<a name="parameters-15"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  fileResource  |  Objekt  |  Informationen über die Datei, die zum Herunterladen bereit ist. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  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)
<a name="filePrintedCallback"></a>

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

#### Parameter:
<a name="parameters-16"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  printResource  |  Objekt  |  Informationen über die gedruckte Datei. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  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
<a name="filestorage"></a>

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

#### Type:
<a name="type-22"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-14"></a>


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

### filestorageEnabledCallback(aktiviert)
<a name="filestorageEnabledCallback"></a>

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

#### Parameter:
<a name="parameters-17"></a>


|  Name  |  Typ  |  Beschreibung  | 
| --- | --- | --- | 
|  enabled  |  boolesch  |  Zeigt an, ob der Dateispeicher aktiviert ist.  | 

### FileStorageErrorCode
<a name="FileStorageErrorCode"></a>

 Die im DCV-Modul verfügbaren FileStorageError Codeaufzählungen 
+  `CANCELLED` 
+  `ABORTED` 
+  `INVALID_ARGUMENT` 
+  `NOT_IMPLEMENTED` 
+  `ERROR` 
+  `ALREADY_EXIST` 
+  `NOT_FOUND` 

#### Type:
<a name="type-23"></a>
+  number 

### firstFrameCallback(ResizeEnabled, Enabled, DisplayID relativeMouseMode)
<a name="firstFrameCallback"></a>

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

#### Parameter:
<a name="parameters-18"></a>


|  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  |  number  |  Der Bezeichner für das Display.  | 

### idleWarningNotificationRückruf () disconnectionDateTime
<a name="idleWarningNotificationCallback"></a>

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

#### Parameter:
<a name="parameters-19"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  disconnectionDateTime  |  Date  |  Das Datum und die Uhrzeit der Verbindungsunterbrechung.  | 

### collaboratorListCallback(Mitarbeiter)
<a name="collaboratorListCallback"></a>

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

#### Parameter:
<a name="parameters-20"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  collaborators  |  Reihe. <Object>  |  Eine Liste von Objekten, die Informationen über Mitarbeiter enthält. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  username  |  Zeichenfolge  |  Der Benutzername des Mitarbeiters.  | 
|  owner  |  boolesch  |  Gibt an, ob der Mitarbeiter der Sitzungsbesitzer ist.  | 
|  connectionId  |  number  |  Gibt die ID an, die der Server der Verbindung zugewiesen hat.  | 

### licenseNotificationCallback(Benachrichtigung)
<a name="licenseNotificationCallback"></a>

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

#### Parameter:
<a name="parameters-21"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  notification  |  Objekt  |  Die Benachrichtigung. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  product  |  Zeichenfolge  |  Das DCV-Produkt.  | 
|  status  |  Zeichenfolge  |  Der Status der Lizenz.  | 
|  message  |  Zeichenfolge  |  Eine Nachricht.  | 
|  leftDays  |  number  |  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  |  number  |  Die Anzahl der nicht lizenzierten Verbindungen.  | 
|  licensingMode  |  Zeichenfolge  |  Der Lizenzierungsmodus.  | 
|  documentationUrl  |  Zeichenfolge  |  Die URL für die Dokumentation.  | 

### Liste (Pfad)
<a name="list"></a>

#### Parameter:
<a name="parameters-22"></a>


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

### LogLevel
<a name="LogLevel"></a>

 Die verfügbaren SDK-Protokollebenen. 

#### Type:
<a name="type-24"></a>
+  TRACE \$1 DEBUG \$1 INFO \$1 WARNUNG \$1 FEHLER \$1 STUMM 

### Überwachen
<a name="Monitor"></a>

#### Type:
<a name="type-25"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-16"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Beschreibung  | 
| --- | --- | --- | 
|  name  |  Zeichenfolge  |  Der Name des Displaykopfs.  | 
|  rect  |  Objekt  |  Informationen über den Displaykopf. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  primary  |  boolesch  |  Gibt an, ob der Displaykopf der primäre Displaykopf ist. Dies wird anhand des Remote-Betriebssystems ermittelt, sofern verfügbar.  | 
|  dpi  |  number  |  Der DPI-Wert des Displaykopfs.  | 
|  x  |  number  |  Die x Anfangskoordinate für den Displaykopf.  | 
|  y  |  number  |  Die y Anfangskoordinate für den Displaykopf.  | 
|  width  |  number  |  Die Breite (in Pixeln) des Displaykopfs.  | 
|  height  |  number  |  Die Höhe (in Pixeln) des Displaykopfs.  | 

### MultiMonitorErrorCode
<a name="MultiMonitorErrorCode"></a>

 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:
<a name="type-26"></a>
+  number 

### qualityIndicatorStateRückruf (Status)
<a name="qualityIndicatorStateCallback"></a>

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

#### Parameter:
<a name="parameters-23"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  state  |  Reihe. <Object>  |  Informationen über die Verbindungsqualität. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  Zeichenfolge  |  Der Name des Indikators.  | 
|  status  |  NORMAL \$1 WARNUNG \$1 KRITISCH  |  Beschreibung des Status.  | 
|  changed  |  boolesch  |  Zeigt an, ob sich der Status geändert hat.  | 

### Verzeichnis umbenennen (src, dest)
<a name="renameDirectory"></a>

#### Parameter:
<a name="parameters-24"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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)
<a name="renameFile"></a>

#### Parameter:
<a name="parameters-25"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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
<a name="ResolutionErrorCode"></a>

 Die im DCV-Modul verfügbaren ResolutionError Codeaufzählungen 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `NOT_IMPLEMENTED` 

#### Type:
<a name="type-27"></a>
+  number 

### Datei abrufen (Pfad)
<a name="retrieveFile"></a>

#### Parameter:
<a name="parameters-26"></a>


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

### ScreenshotCallback (Bildschirmfoto)
<a name="screenshotCallback"></a>

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

#### Parameter:
<a name="parameters-27"></a>


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

### ScreenshotErrorCode
<a name="ScreenshotErrorCode"></a>

 Die im ScreenshotError DCV-Modul verfügbaren Code-Aufzählungen 
+  `NO_CHANNEL` 
+  `GENERIC_ERROR` 

#### Type:
<a name="type-33"></a>
+  number 

### Serverinfo
<a name="serverInfo"></a>

#### Type:
<a name="type-28"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-19"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  Name  |  Typ  |  Beschreibung  | 
| --- | --- | --- | 
|  name  |  Zeichenfolge  |  Der Name der Software.  | 
|  version  |  Objekt  |  Die Versionsnummer der Software. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/dcv/latest/websdkguide/dcv-module.html)  | 
|  os  |  Zeichenfolge  |  Das Betriebssystem.  | 
|  arch  |  Zeichenfolge  |  Die Architektur.  | 
|  hostname  |  Zeichenfolge  |  Der Hostname  | 
|  major  |  number  |  Die Hauptversionsnummer.  | 
|  minor  |  number  |  Die Nummer der Nebenversion.  | 
|  revision  |  number  |  Die Versionsnummer der Revision.  | 

### stats
<a name="stats"></a>

#### Type:
<a name="type-29"></a>
+  Objekt 

#### Eigenschaften:
<a name="properties-21"></a>


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

### StoreFile (Datei, Verzeichnis)
<a name="storeFile"></a>

#### Parameter:
<a name="parameters-28"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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
<a name="TimezoneRedirectionErrorCode"></a>

 Die im DCV-Modul verfügbaren TimezoneRedirectionError Code-Aufzählungen 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `USER_CANNOT_CHANGE` 

#### Type:
<a name="w2aac14b9c17d101b7"></a>
+  number 

### TimezoneRedirectionSettingCode
<a name="TimezoneRedirectionSettingCode"></a>

 Die im TimezoneRedirectionSetting DCV-Modul verfügbaren Code-Aufzählungen 
+  `ALWAYS_OFF` 
+  `ALWAYS_ON` 
+  `CLIENT_DECIDES` 

#### Type:
<a name="w2aac14b9c17d103b7"></a>
+  number 

### TimezoneRedirectionStatusCode
<a name="TimezoneRedirectionStatusCode"></a>

 Die im TimezoneRedirectionStatus DCV-Modul verfügbaren Code-Aufzählungen 
+  `SUCCESS` 
+  `PERMISSION_ERROR` 
+  `GENERIC_ERROR` 

#### Type:
<a name="w2aac14b9c17d105b7"></a>
+  number 

### WebcamErrorCode
<a name="WebcamErrorCode"></a>

 Die im WebcamError DCV-Modul verfügbaren Code-Aufzählungen 
+  `SETTING_WEBCAM_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### Type:
<a name="type-30"></a>
+  number 

### httpExtraSearchParamsCallback(Methode, URL, Hauptteil)
<a name="httpExtraSearchParamsCallback"></a>

 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:
<a name="parameters-29"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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:
<a name="returns-30"></a>

 `URLSearchParams`Objekt, das die benutzerdefinierten Abfrageparameter enthält, die an die URL angehängt werden sollen. 

 Typ   
 URLSearchParameter 

### httpExtraHeadersRückruf (Methode, URL, Text)
<a name="httpExtraHeadersCallback"></a>

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

#### Parameter:
<a name="parameters-31"></a>


|  Name  |  Typ  |  Description  | 
| --- | --- | --- | 
|  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:
<a name="returns-32"></a>

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

 Typ   
 Objekt 