Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Módulo DCV
<a name="dcv-module"></a>

Módulo que implementa el lado del cliente del protocolo DCV.

**Topics**
+ [Métodos](#methods)
+ [Miembros](#members)
+ [Definiciones de tipo y devolución de llamada](#type-definitions)

## Métodos
<a name="methods"></a>

**Topics**
+ [authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1](#authenticate)
+ [connect (config) → \$1Promesa. < [Conexión](connection-class.md) >\$1Promesa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensaje: cadena\$1 >\$1](#connect)
+ [setLogHandler(controlador) → \$1vacío\$1](#setLogHandler)
+ [setLogLevel(nivel) → \$1vacío\$1](#setLogLevel)

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

 Inicia el proceso de autenticación para el punto de conexión del servidor Amazon DCV especificado. 

#### Parámetros:
<a name="parameters"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  url  |  cadena  |  Nombre y puerto de host del servidor Amazon DCV en ejecución con el siguiente formato: https://dcv\$1host\$1address:port. Por ejemplo: https://my-dcv-server:8443.  | 
|  authenticationToken  |  cadena  |  El token de autenticación para usar en la autenticación.  | 
|  callbacks  |  [authenticationCallbacks](#authenticationCallbacks)  |  Devoluciones de llamada que están disponibles para invocarse durante el proceso de autenticación.  | 

#### Devuelve:
<a name="returns"></a>

 - El objeto de autenticación. 

 Tipo   
 [Autenticación](authentication-class.md) 

### connect (config) → \$1Promesa. < [Conexión](connection-class.md) >\$1Promesa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensaje: cadena\$1 >\$1
<a name="connect"></a>

 Se conecta al punto de conexión del servidor Amazon DCV especificado. Si la conexión se realiza correctamente, devuelve un objeto Connection. Si se produce un error de conexión, devuelve un objeto de error. 

#### Parámetros:
<a name="parameters-1"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  config  |  [ConnectionConfig](#ConnectionConfig)  |  El ConnectionConfig objeto.  | 

#### Devuelve:
<a name="returns-1"></a>

 - Un objeto Connection o un objeto de error. 

 Tipo   
 Lo prometo. < [Conexión](connection-class.md) > \$1 Promesa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensaje: cadena\$1 > 

### setLogHandler(controlador) → \$1vacío\$1
<a name="setLogHandler"></a>

 Establece una función de controlador de registros personalizada. Cuando se sustituye el controlador de registros predeterminado, la posición original de la entrada de registro se perderá al depurar con la consola del navegador. 

#### Parámetros:
<a name="parameters-2"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  handler  |  función  |  La función de controlador de registros personalizada. La función de controlador contiene level (número), levelName (cadena), domain (cadena) y message (cadena).  | 

#### Devuelve:
<a name="returns-2"></a>

 Tipo   
 void 

### setLogLevel(nivel) → \$1vacío\$1
<a name="setLogLevel"></a>

 Establece el nivel de registro. Solo es necesario si se utiliza el controlador de registro predeterminado. 

#### Parámetros:
<a name="parameters-3"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  level  |  [LogLevel](#LogLevel)  |  Nivel de registro que se debe utilizar.  | 

#### Devuelve:
<a name="returns-3"></a>

 Tipo   
 void 

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

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

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

 La AudioError enumeración de códigos. 

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

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

 La AuthenticationError enumeración de códigos. 

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

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

 La ChannelError enumeración de códigos. 

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

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

 La ClosingReasonError enumeración de códigos. 

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

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

 La ConnectionError enumeración de códigos. 

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

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

 La CustomChannelError enumeración de códigos. 

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

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

 La DisplayConfigError enumeración de códigos. 

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

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

 La FileStorageError enumeración de códigos. 

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

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

 Niveles de registro del SDK disponibles. 

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

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

 La MultiMonitorError enumeración de códigos. 

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

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

 La ResolutionError enumeración de códigos. 

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

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

 La TimezoneRedirectionError enumeración de códigos. 

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

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

 La TimezoneRedirectionSetting enumeración de códigos. 

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

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

 La TimezoneRedirectionStatus enumeración de códigos. 

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

### (constant) version
<a name="version"></a>

 Versión de Amazon DCV con las opciones major, minor, patch, revision, extended y versionStr. 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  major  |  entero  |  Número de la versión principal.  | 
|  minor  |  entero  |  Número de la versión secundaria.  | 
|  patch  |  entero  |  Número de versión del parche.  | 
|  revision  |  entero  |  Número de revisión.  | 
|  extended  |  cadena  |  Cadena ampliada.  | 
|  versionStr  |  cadena  |  Concatenación de los números de versión principal, secundaria, de parche y de revisión con el formato major.minor.patch\$1build.revision.  | 

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

 La ScreenshotError enumeración de códigos. 

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

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

 La WebcamError enumeración de códigos. 

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

## Definiciones de tipo y devolución de llamada
<a name="type-definitions"></a>

**Topics**
+ [AudioErrorCode](#AudioErrorCode)
+ [authenticationCallbacks](#authenticationCallbacks)
+ [AuthenticationErrorCode](#AuthenticationErrorCode)
+ [authErrorCallback(autenticación, error)](#authErrorCallback)
+ [authPromptCredentialsDevolución de llamada (autenticación, impugnación)](#authPromptCredentialsCallback)
+ [authSuccessCallback(autenticación, datos de autenticación)](#authSuccessCallback)
+ [Canal](#Channel)
+ [ChannelErrorCode](#ChannelErrorCode)
+ [clipboardEventCallback(evento)](#clipboardEventCallback)
+ [ClosingReasonErrorCode](#ClosingReasonErrorCode)
+ [Colorspace](#Colorspace)
+ [connectionCallbacks](#connectionCallbacks)
+ [ConnectionConfig](#ConnectionConfig)
+ [ConnectionErrorCode](#ConnectionErrorCode)
+ [createDirectory(path)](#createDirectory)
+ [CustomChannelErrorCode](#CustomChannelErrorCode)
+ [dataChannelCallback(información)](#dataChannelCallback)
+ [deleteFile(path)](#deleteFile)
+ [deviceChangeEventLlamada de vuelta ()](#deviceChangeEventCallback)
+ [disconnectCallback(reason)](#disconnectCallback)
+ [displayAvailabilityCallback(estado, DisplayID)](#displayAvailabilityCallback)
+ [DisplayConfigErrorCode](#DisplayConfigErrorCode)
+ [displayLayoutCallback(ServerWidth, ServerHeight, heads)](#displayLayoutCallback)
+ [característica](#feature)
+ [featuresUpdateCallback(Lista de características)](#featuresUpdateCallback)
+ [fileDownloadCallback(Recurso de archivo)](#fileDownloadCallback)
+ [filePrintedCallback(Recurso de impresión)](#filePrintedCallback)
+ [filestorage](#filestorage)
+ [filestorageEnabledCallback(habilitado)](#filestorageEnabledCallback)
+ [FileStorageErrorCode](#FileStorageErrorCode)
+ [firstFrameCallback(Resize Enabled, Enabled, DisplayID relativeMouseMode)](#firstFrameCallback)
+ [idleWarningNotificationLlamada de vuelta () disconnectionDateTime](#idleWarningNotificationCallback)
+ [collaboratorListCallback(colaboradores)](#collaboratorListCallback)
+ [licenseNotificationCallback(notificación)](#licenseNotificationCallback)
+ [list(path)](#list)
+ [LogLevel](#LogLevel)
+ [Supervisión](#Monitor)
+ [MultiMonitorErrorCode](#MultiMonitorErrorCode)
+ [qualityIndicatorStateLlamada de vuelta (estado)](#qualityIndicatorStateCallback)
+ [renameDirectory(src, dest)](#renameDirectory)
+ [renameFile(src, dest)](#renameFile)
+ [ResolutionErrorCode](#ResolutionErrorCode)
+ [retrieveFile(path)](#retrieveFile)
+ [screenshotCallback(screenshot)](#screenshotCallback)
+ [ScreenshotErrorCode](#ScreenshotErrorCode)
+ [serverInfo](#serverInfo)
+ [stats](#stats)
+ [storeFile(file, dir)](#storeFile)
+ [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)
+ [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)
+ [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)
+ [WebcamErrorCode](#WebcamErrorCode)
+ [httpExtraSearchParamsCallback(método, url, cuerpo)](#httpExtraSearchParamsCallback)
+ [httpExtraHeadersRetrollamada (método, URL, cuerpo)](#httpExtraHeadersCallback)

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

 Las enumeraciones AudioError de códigos disponibles en el módulo DCV 
+  `SETTING_AUDIO_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### Escriba:
<a name="type-10"></a>
+  número 

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

 Devoluciones de llamada de autenticación 

#### Escriba:
<a name="type-11"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  promptCredentials  |  [authPromptCredentialsLlamada de vuelta](#authPromptCredentialsCallback)  |  Función de devolución de llamada que se invoca cuando se solicitan credenciales al usuario.  | 
|  error  |  [authErrorCallback](#authErrorCallback)  |  Función de devolución de llamada que se invoca cuando se produce un error en la autenticación.  | 
|  success  |  [authSuccessCallback](#authSuccessCallback)  |  Función de devolución de llamada que se invoca cuando la autenticación es correcta.  | 
|  httpExtraSearchParamsCallback  |  [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback)  |  La función de devolución de llamada a la que se debe llamar en el método authenticate para inyectar parámetros de consulta personalizados en la URL de autenticación antes de iniciar la solicitud. También se puede utilizar en el connect método para personalizar la URL que se utiliza al establecer una WebSocket conexión con el servidor DCV.  | 

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

 Las enumeraciones AuthenticationError de códigos disponibles en el módulo DCV 
+  `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` 

#### Escriba:
<a name="type-12"></a>
+  número 

### authErrorCallback(autenticación, error)
<a name="authErrorCallback"></a>

 Función de devolución de llamada que se invoca cuando se produce un error en la autenticación. 

#### Parámetros:
<a name="parameters-4"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  authentication  |  [Autenticación](authentication-class.md)  |  El objeto de autenticación.  | 
|  error  |  Objeto  |  Objeto de error generado por el proceso de autenticación. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  [AuthenticationErrorCode](#AuthenticationErrorCode)  |  Código de error.  | 
|  message  |  cadena  |  Mensaje de error.  | 

### authPromptCredentialsDevolución de llamada (autenticación, impugnación)
<a name="authPromptCredentialsCallback"></a>

 Función de devolución de llamada que se invoca cuando se solicitan credenciales al usuario. El usuario debe responder a la solicitud proporcionando las credenciales requeridas. 

#### Parámetros:
<a name="parameters-5"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  authentication  |  [Autenticación](authentication-class.md)  |  El objeto de autenticación.  | 
|  challenge  |  Objeto  |  La solicitud. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  requiredCredentials  |  Array.<Object>  |  Matriz de objetos de credenciales solicitados. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  cadena  |  Nombre de la credencial solicitada.  | 
|  type  |  cadena  |  Tipo de la credencial solicitada.  | 

### authSuccessCallback(autenticación, datos de autenticación)
<a name="authSuccessCallback"></a>

 Función de devolución de llamada que se invoca cuando la autenticación es correcta. 

#### Parámetros:
<a name="parameters-6"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  authentication  |  [Autenticación](authentication-class.md)  |  El objeto de autenticación.  | 
|  authenticationData  |  Array.<Object>  |  Conjunto de objetos que incluyen tokens de sesión IDs y autenticación de Amazon DCV. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  sessionId  |  cadena  |  ID de la sesión de Amazon DCV.  | 
|  authToken  |  cadena  |  Token de autenticación de la sesión de Amazon DCV.  | 

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

 Canales disponibles que se pueden especificar. 

#### Escriba:
<a name="type-13"></a>
+  "clipboard" \$1 "display" \$1 "input" \$1 "audio" \$1 "filestorage" 

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

 Las enumeraciones ChannelError de códigos están disponibles en el módulo DCV 
+  `ALREADY_OPEN` 
+  `INITIALIZATION_FAILED` 
+  `REJECTED` 

#### Escriba:
<a name="type-14"></a>
+  número 

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

 Función de devolución de llamada que se invoca cuando se genera un `clipboardEvent`. 

#### Parámetros:
<a name="parameters-7"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Atributos  |  Description (Descripción)  | 
| --- | --- | --- | --- | 
|  event  |  Objeto  |  Información sobre el evento del portapapeles. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  establecido \$1 copiar \$1 pegar \$1 \$1 dataSizeAlert \$1 autoCopyDone newDataAvailable autoPasteDone \$1 RemoteError \$1 pasteAvailableData  |   |  Siempre están presentes. El nombre del evento.  | 
|  clipboardData  |  Objeto \$1 cadena  |   |  Datos del portapapeles.  | 
|  autoCopy  |  booleano  |  <optional>  |  Indica si está habilitada la copia automática del portapapeles de la sesión en el portapapeles del cliente local.  | 
|  maxDataSize  |  número  |  <optional>  |  Cantidad máxima de datos que se pueden colocar en el portapapeles.  | 
|  error  |  cadena  |  <optional>  |  Información de error, en su caso.  | 

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

 Las enumeraciones ClosingReasonError de códigos disponibles en el módulo DCV 
+  `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` 

#### Escriba:
<a name="type-15"></a>
+  número 

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

 Espacios de color disponibles que se pueden especificar. 

#### Escriba:
<a name="type-16"></a>
+  «RGB» \$1 «YUV\$1REC601" \$1 «YUV\$1» REC709 

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

 Devoluciones de llamada disponibles para invocar en caso de un error de conexión. 

#### Escriba:
<a name="type-17"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  disconnect  |  [disconnectCallback](#disconnectCallback)  |  Función de devolución de llamada que se invoca cuando finaliza la conexión.  | 
|  displayLayout  |  [displayLayoutCallback](#displayLayoutCallback)  |  Función de devolución de llamada que se invoca cuando cambia el diseño o la resolución de pantalla.  | 
|  displayAvailability  |  [displayAvailabilityCallback](#displayAvailabilityCallback)  |  Función de devolución de llamada que se invoca cuando cambia la disponibilidad de una pantalla.  | 
|  firstFrame  |  [firstFrameCallback](#firstFrameCallback)  |  Función de devolución de llamada que se invoca cuando se recibe el primer fotograma del servidor Amazon DCV.  | 
|  filePrinted  |  [filePrintedCallback](#filePrintedCallback)  |  Función de devolución de llamada que se invoca cuando se imprime un archivo en el servidor Amazon DCV.  | 
|  fileDownload  |  [fileDownloadCallback](#fileDownloadCallback)  |  Función de devolución de llamada que se invoca cuando hay un archivo listo para descargar desde el servidor Amazon DCV.  | 
|  dataChannel  |  [dataChannelCallback](#dataChannelCallback)  |  Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una notificación sobre la disponibilidad de un canal de datos.  | 
|  licenseNotification  |  [licenseNotificationCallback](#licenseNotificationCallback)  |  Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una notificación sobre el estado de licencia.  | 
|  idleWarningNotification  |  [idleWarningNotificationLlamada de vuelta](#idleWarningNotificationCallback)  |  Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una advertencia de tiempo de espera de inactividad.  | 
|  collaboratorList  |  [collaboratorListCallback](#collaboratorListCallback)  |  Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía la lista de colaboradores (desde Amazon DCV Web Client SDK versión 1.1.0).  | 
|  qualityIndicatorState  |  [qualityIndicatorStateLlamada de vuelta](#qualityIndicatorStateCallback)  |  Función de devolución de llamada que se invoca cuando el indicador de calidad de la conexión cambia de estado.  | 
|  filestorageEnabled  |  [filestorageEnabledCallback](#filestorageEnabledCallback)  |  Función de devolución de llamada que se invoca cuando el almacenamiento de archivos está habilitado o deshabilitado.  | 
|  featuresUpdate  |  [featuresUpdateCallback](#featuresUpdateCallback)  |  Función de devolución de llamada que se invoca cuando cambia el estado de una característica.  | 
|  clipboardEvent  |  [clipboardEventCallback](#clipboardEventCallback)  |  Función de devolución de llamada que se invoca cuando se genera un clipboardEvent.  | 
|  deviceChangeEvent  |  [deviceChangeEventLlamada de vuelta](#deviceChangeEventCallback)  |  Función de devolución de llamada que se invoca cuando se desencadena un evento deviceChange.  | 
|  screenshot  |  [screenshotCallback](#screenshotCallback)  |  Función de devolución de llamada que se invoca cuando a está disponible una screenshot.  | 
|  httpExtraSearchParamsCallback  |  [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback)  |  La función de devolución de llamada a la que se debe llamar para personalizar la URL al establecer una WebSocket conexión con el servidor Amazon DCV. Tenga en cuenta que esta devolución de llamada también se puede utilizar con el método authenticate para añadir de manera dinámica los parámetros de consulta a la URL de autenticación antes de que el SDK envíe la solicitud.  | 
|  httpExtraHeadersCallback  |  [httpExtraHeadersLlamada de retorno](#httpExtraHeadersCallback)  |  La función de devolución de llamada a la que se debe llamar para añadir encabezados personalizados a la solicitud HTTP durante el establecimiento de la conexión.  | 

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

 Configuración de una conexión Amazon DCV. 

#### Escriba:
<a name="type-18"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  url  |  cadena  |  Nombre y puerto de host del servidor Amazon DCV en ejecución con el siguiente formato: https://dcv\$1host\$1address:port. Por ejemplo: https://my-dcv-server:8443.  | 
|  sessionId  |  cadena  |  ID de la sesión de Amazon DCV.  | 
|  authToken  |  cadena  |  Token de autenticación que se utilizará al conectarse al servidor.  | 
|  baseUrl  |  cadena  |  URL absoluta o relativa desde la que se cargarán los archivos del SDK.  | 
|  resourceBaseUrl  |  cadena  |  URL absoluta o relativa desde la que se accederá a los recursos de DCV.  | 
|  enabledChannels  |  Array.<[Channel](#Channel)>  |  Indica la lista de canales que se pueden habilitar. Si no se especifica o se especifica una matriz vacía, el valor predeterminado es todos los canales disponibles.  | 
|  losslessColorspace  |  [Colorspace](#Colorspace)  |  Indica el espacio de color que se utilizará. Si no se especifica, toma el valor "RGB" como predeterminado.  | 
|  divId  |  cadena  |  ID del objeto div en el HTML DOM donde el SDK debe crear el lienzo con el flujo remoto.  | 
|  volumeLevel  |  entero  |  Nivel de volumen preferido. El intervalo válido es de 0 a 100.  | 
|  clipboardAutoSync  |  booleano  |  Indica si la copia automática del portapapeles de la sesión de Amazon DCV al portapapeles del cliente local está habilitada para los navegadores web compatibles.  | 
|  dynamicAudioTuning  |  booleano  |  Indica si se debe sintonizar dinámicamente el audio en función de la configuración de audio del servidor Amazon DCV cuando se establece una conexión.  | 
|  clientHiDpiScaling  |  booleano  |  Indica si se debe escalar el lienzo en función del DPI del cliente.  | 
|  highColorAccuracy  |  booleano  |  Indica si se debe utilizar una alta precisión de color, si está disponible. Si no se especifica, toma el valor false como predeterminado.  | 
|  enableWebCodecs  |  Booleano  |  Indica si se WebCodecs debe utilizar si está disponible. Toma false como valor predeterminado si no se especifica.  | 
|  observers  |  [connectionCallbacks](#connectionCallbacks)  |  Funciones de devolución de llamada que se invocan para eventos relacionados con la conexión.  | 
|  callbacks  |  [connectionCallbacks](#connectionCallbacks)  |  Igual que la propiedad observers, pero cada devolución de llamada incluye el objeto [Connection](connection-class.md) como primer parámetro.  | 

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

 Las enumeraciones de ConnectionError códigos disponibles en el módulo DCV 
+  `ALREADY_OPEN` 
+  `INVALID_CONFIG` 
+  `INITIALIZATION_FAILED` 
+  `REJECTED` 
+  `MAIN_CHANNEL_ALREADY_OPEN` 
+  `GENERIC_ERROR` (desde DCV Server 2021.0) 
+  `INTERNAL_SERVER_ERROR` (desde DCV Server 2021.0) 
+  `AUTHENTICATION_FAILED` (desde DCV Server 2021.0) 
+  `PROTOCOL_ERROR` (desde DCV Server 2021.0) 
+  `INVALID_SESSION_ID` (desde DCV Server 2021.0) 
+  `INVALID_CONNECTION_ID` (desde DCV Server 2021.0) 
+  `CONNECTION_LIMIT_REACHED` (desde DCV Server 2021.0) 
+  `SERVER_UNREACHABLE` (desde DCV Server 2022.1) 
+  `GATEWAY_BUSY` 
+  `UNSUPPORTED_CREDENTIAL` (desde DCV Server 2022.2) 
+  `TRANSPORT_ERROR` 

#### Escriba:
<a name="type-19"></a>
+  número 

### createDirectory(path)
<a name="createDirectory"></a>

#### Parámetros:
<a name="parameters-8"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  path  |  cadena  |  Ruta absoluta del servidor en el que queremos crear un directorio. También debe incluir el nombre del directorio de destino.  | 

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

 Las enumeraciones CustomChannelError de códigos disponibles en el módulo DCV 
+  `TRANSPORT_ERROR` 

#### Escriba:
<a name="type-20"></a>
+  número 

### dataChannelCallback(información)
<a name="dataChannelCallback"></a>

 Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una notificación sobre la disponibilidad de un canal de datos. 

#### Parámetros:
<a name="parameters-9"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  info  |  Objeto  |  Información sobre el canal de datos. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  cadena  |  Nombre del canal de datos.  | 
|  token  |  cadena  |  Token de autenticación del canal de datos.  | 

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

#### Parámetros:
<a name="parameters-10"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  path  |  cadena  |  Ruta absoluta del servidor que identifica el archivo que queremos eliminar.  | 

### deviceChangeEventLlamada de vuelta ()
<a name="deviceChangeEventCallback"></a>

 Función de devolución de llamada que se invoca cuando se desencadena un evento `deviceChange`. 

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

 Función de devolución de llamada que se invoca cuando finaliza la conexión. 

#### Parámetros:
<a name="parameters-11"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  reason  |  Objeto  |  Motivo de la desconexión. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  número  |  Código de región.  | 
|  message  |  cadena  |  Mensaje del motivo.  | 

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

 Función de devolución de llamada que se invoca cuando cambia la disponibilidad de una pantalla. 

#### Parámetros:
<a name="parameters-12"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  status  |  Objeto  |  Estado de la pantalla. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  displayId  |  número  |  Identificador de la pantalla.  | 
|  enabled  |  booleano  |  Indica si la pantalla está habilitada.  | 
|  closed  |  booleano  |  Indica si la pantalla está habilitada.  | 

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

 Las enumeraciones DisplayConfigError de códigos disponibles en el módulo DCV 
+  `INVALID_ARGUMENT` 
+  `UNSUPPORTED_OPERATION` 
+  `NO_CHANNEL` 

#### Escriba:
<a name="type-32"></a>
+  número 

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

 Función de devolución de llamada que se invoca cuando cambia el diseño o la resolución de pantalla. 

#### Parámetros:
<a name="parameters-13"></a>


|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  serverWidth  |  número  |  Ancho (en píxeles) de la pantalla principal.  | 
|  serverHeight  |  número  |  Alto (en píxeles) de la pantalla principal.  | 
|  heads  |  Array.<[Monitor](#Monitor)>  |  Cabezales de pantalla compatibles con el servidor Amazon DCV.  | 

### característica
<a name="feature"></a>

 Valores de características. 
+  `display`: indica la disponibilidad de una transmisión de vídeo de una sola pantalla. 
+  `display-multi`: indica la disponibilidad de una transmisión de vídeo de varias pantallas. 
+  `high-color-accuracy`: indica la disponibilidad de una alta precisión de color (desde Amazon DCV Web Client SDK versión 1.1.0). 
+  `mouse`: indica la disponibilidad de la funcionalidad del ratón. 
+  `keyboard`: indica la disponibilidad de la funcionalidad del teclado. 
+  `keyboard-sas`: indica la disponibilidad de la funcionalidad de secuencia SAS (Control \$1 Alt \$1 Eliminar). 
+  `relative-mouse`: indica la disponibilidad del modo de ratón relativo. 
+  `clipboard-copy`: indica la disponibilidad de la funcionalidad de copia del portapapeles desde el servidor Amazon DCV hasta el cliente. 
+  `clipboard-paste`: indica la disponibilidad de la funcionalidad de pegado del portapapeles desde el cliente hasta el servidor Amazon DCV. 
+  `audio-in`: indica la disponibilidad de la funcionalidad de entrada de audio utilizando el micrófono. 
+  `audio-out`: indica la disponibilidad de la funcionalidad de reproducción de audio. 
+  `webcam`: indica la disponibilidad de la funcionalidad de streaming de la cámara web. 
+  `file-download`: indica la disponibilidad de la funcionalidad de descarga desde el servidor Amazon DCV hasta el cliente. 
+  `file-upload`: indica la disponibilidad de la funcionalidad de carga desde el servidor Amazon DCV hasta el cliente. 
+  `timezone-redirection`: indica la disponibilidad de la funcionalidad de redireccionamiento de zona horaria (desde Amazon DCV Web Client SDK versión 1.3.0). 

#### Escriba:
<a name="type-21"></a>
+  cadena 

### featuresUpdateCallback(Lista de características)
<a name="featuresUpdateCallback"></a>

 Función de devolución de llamada que se invoca cuando cambia el estado de una característica. 

#### Parámetros:
<a name="parameters-14"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  featuresList  |  Array.<[feature](#feature)>  |  Matriz de características que han cambiado.  | 

### fileDownloadCallback(Recurso de archivo)
<a name="fileDownloadCallback"></a>

 Función de devolución de llamada que se invoca cuando hay un archivo listo para descargar desde el servidor Amazon DCV. 

#### Parámetros:
<a name="parameters-15"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  fileResource  |  Objeto  |  Información sobre el archivo que está listo para su descarga. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  id  |  cadena  |  Identificador del archivo.  | 
|  url  |  cadena  |  URL que se utilizará para descargar el archivo.  | 
|  domain  |  cadena  |  Dominio del recurso.  | 
|  token  |  cadena  |  Token de autenticación que se utilizará para descargar el archivo. El token también se incluye en la URL.  | 

### filePrintedCallback(Recurso de impresión)
<a name="filePrintedCallback"></a>

 Función de devolución de llamada que se invoca cuando se imprime un archivo en el servidor Amazon DCV. 

#### Parámetros:
<a name="parameters-16"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  printResource  |  Objeto  |  Información sobre el archivo impreso. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  id  |  cadena  |  Identificador del archivo impreso.  | 
|  url  |  cadena  |  URL que se utilizará para descargar el archivo impreso.  | 
|  domain  |  cadena  |  Dominio del recurso. En este caso, printer.  | 
|  token  |  cadena  |  Token de autenticación que se utilizará para descargar el archivo. El token también se incluye en la URL.  | 

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

 Objeto que permite explorar y realizar acciones en el sistema de archivos. 

#### Escriba:
<a name="type-22"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  list  |  [list](#list)  |  Función que permite enumerar los elementos (archivos y directorios) presentes en la ruta proporcionada en el servidor.  | 
|  createDirectory  |  [createDirectory](#createDirectory)  |  Función que permite crear un directorio en la ruta especificada en el servidor.  | 
|  retrieveFile  |  [retrieveFile](#retrieveFile)  |  Función que permite descargar localmente un archivo en la ruta especificada en el servidor.  | 
|  deleteFile  |  [deleteFile](#deleteFile)  |  Función que permite descargar localmente un archivo en la ruta especificada en el servidor.  | 
|  renameFile  |  [renameFile](#renameFile)  |  Función que permite cambiar el nombre de un archivo de la ruta de origen especificada a la ruta de destino especificada.  | 
|  renameDirectory  |  [renameDirectory](#renameDirectory)  |  Función que permite cambiar el nombre de un directorio de la ruta de origen especificada a la ruta de destino absoluta.  | 
|  storeFile  |  [storeFile](#storeFile)  |  Función que permite cargar un archivo local en la ruta proporcionada en el servidor.  | 

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

 Función de devolución de llamada que se invoca cuando el almacenamiento de archivos está habilitado. Canal en diferido solo en Internet Explorer 11. 

#### Parámetros:
<a name="parameters-17"></a>


|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  enabled  |  booleano  |  Indica si el almacenamiento de archivos está habilitado.  | 

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

 Las enumeraciones de FileStorageError códigos disponibles en el módulo DCV 
+  `CANCELLED` 
+  `ABORTED` 
+  `INVALID_ARGUMENT` 
+  `NOT_IMPLEMENTED` 
+  `ERROR` 
+  `ALREADY_EXIST` 
+  `NOT_FOUND` 

#### Escriba:
<a name="type-23"></a>
+  número 

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

 Función de devolución de llamada que se invoca cuando se recibe el primer fotograma del servidor Amazon DCV. Se emite para cada pantalla. 

#### Parámetros:
<a name="parameters-18"></a>


|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  resizeEnabled  |  booleano  |  Indica si el servidor admite el cambio de tamaño del diseño de la pantalla del cliente.  | 
|  relativeMouseModeEnabled  |  booleano  |  Indica si el servidor admite el modo de ratón relativo.  | 
|  displayId  |  número  |  Identificador de la pantalla.  | 

### idleWarningNotificationLlamada de vuelta () disconnectionDateTime
<a name="idleWarningNotificationCallback"></a>

 Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una advertencia de tiempo de espera de inactividad. 

#### Parámetros:
<a name="parameters-19"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  disconnectionDateTime  |  Fecha  |  Fecha y hora de la desconexión.  | 

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

 Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía la lista de colaboradores. 

#### Parámetros:
<a name="parameters-20"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  collaborators  |  Array.<Object>  |  Lista de objetos que contiene información sobre los colaboradores. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  username  |  cadena  |  Nombre de usuario del colaborador.  | 
|  owner  |  booleano  |  Indica si el colaborador es el propietario de la sesión.  | 
|  connectionId  |  número  |  Indica el ID asignado por el servidor a la conexión.  | 

### licenseNotificationCallback(notificación)
<a name="licenseNotificationCallback"></a>

 Función de devolución de llamada que se invoca cuando el servidor Amazon DCV envía una notificación sobre el estado de licencia. 

#### Parámetros:
<a name="parameters-21"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  notification  |  Objeto  |  Notificación. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  product  |  cadena  |  Producto DCV.  | 
|  status  |  cadena  |  Estado de la licencia.  | 
|  message  |  cadena  |  Mensaje.  | 
|  leftDays  |  número  |  Número de días para que caduque la licencia.  | 
|  isDemo  |  booleano  |  Indica si la licencia es de demostración.  | 
|  numUnlicensed  |  número  |  Número de conexiones sin licencia.  | 
|  licensingMode  |  cadena  |  Modelo de licencia.  | 
|  documentationUrl  |  cadena  |  URL de la documentación.  | 

### list(path)
<a name="list"></a>

#### Parámetros:
<a name="parameters-22"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  path  |  cadena  |  Ruta absoluta del servidor cuyo contenido queremos enumerar.  | 

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

 Niveles de registro del SDK disponibles. 

#### Escriba:
<a name="type-24"></a>
+  TRACE \$1 DEBUG \$1 INFO \$1 WARN \$1 ERROR \$1 SILENT 

### Supervisión
<a name="Monitor"></a>

#### Escriba:
<a name="type-25"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  name  |  cadena  |  Nombre del cabezal de pantalla.  | 
|  rect  |  Objeto  |  Información sobre el cabezal de pantalla. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  primary  |  booleano  |  Indica si el cabezal de pantalla es el cabezal de la pantalla principal. Esto se determina desde el sistema operativo remoto, si está disponible.  | 
|  dpi  |  número  |  DPI del cabezal de pantalla.  | 
|  x  |  número  |  Coordenada x inicial del cabezal de pantalla.  | 
|  y  |  número  |  Coordenada y inicial del cabezal de pantalla.  | 
|  width  |  número  |  Ancho (en píxeles) del cabezal de pantalla.  | 
|  height  |  número  |  Alto (en píxeles) del cabezal de pantalla.  | 

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

 Las enumeraciones de MultiMonitorError códigos disponibles en el módulo DCV 
+  `NO_DISPLAY_CHANNEL` 
+  `MAX_DISPLAY_NUMBER_REACHED` 
+  `INVALID_ARGUMENT` 
+  `DISPLAY_NOT_OPENED_BY_SERVER` 
+  `REQUEST_TIMEOUT` 
+  `GENERIC_ERROR` 
+  `NO_ERROR` 

#### Escriba:
<a name="type-26"></a>
+  número 

### qualityIndicatorStateLlamada de vuelta (estado)
<a name="qualityIndicatorStateCallback"></a>

 Función de devolución de llamada que se invoca cuando el indicador de calidad de la conexión cambia de estado. 

#### Parámetros:
<a name="parameters-23"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  state  |  Array.<Object>  |  Información sobre la calidad de la conexión. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  cadena  |  Nombre del indicador.  | 
|  status  |  NORMAL \$1 WARNING \$1 CRITICAL  |  Descripción del estado.  | 
|  changed  |  booleano  |  Indica si el estado ha cambiado.  | 

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

#### Parámetros:
<a name="parameters-24"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  src  |  cadena  |  Ruta de origen absoluta en el servidor que identifica el directorio cuyo nombre queremos cambiar.  | 
|  dest  |  cadena  |  Ruta de destino absoluta en el servidor que especifica la ruta de destino y el nombre del directorio.  | 

### renameFile(src, dest)
<a name="renameFile"></a>

#### Parámetros:
<a name="parameters-25"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  src  |  cadena  |  Ruta de origen absoluta en el servidor que identifica el archivo cuyo nombre queremos cambiar.  | 
|  dest  |  cadena  |  Ruta de destino absoluta en el servidor que especifica la ruta de destino y el nombre del archivo.  | 

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

 Las enumeraciones ResolutionError de códigos disponibles en el módulo DCV 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `NOT_IMPLEMENTED` 

#### Escriba:
<a name="type-27"></a>
+  número 

### retrieveFile(path)
<a name="retrieveFile"></a>

#### Parámetros:
<a name="parameters-26"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  path  |  cadena  |  Ruta absoluta del servidor que identifica el archivo que queremos descargar localmente.  | 

### screenshotCallback(screenshot)
<a name="screenshotCallback"></a>

 Función de devolución de llamada que se invoca cuando a está disponible una captura de pantalla. 

#### Parámetros:
<a name="parameters-27"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  screenshot  |  byte[]  |  Búfer de captura de pantalla en formato PNG o null si la recuperación de la captura de pantalla ha fallado.  | 

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

 Las enumeraciones ScreenshotError de códigos disponibles en el módulo DCV 
+  `NO_CHANNEL` 
+  `GENERIC_ERROR` 

#### Escriba:
<a name="type-33"></a>
+  número 

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

#### Escriba:
<a name="type-28"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  name  |  cadena  |  Nombre del software.  | 
|  version  |  Objeto  |  Número de versión del software. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/dcv/latest/websdkguide/dcv-module.html)  | 
|  os  |  cadena  |  Sistema operativo.  | 
|  arch  |  cadena  |  Arquitectura.  | 
|  hostname  |  cadena  |  Nombre del host.  | 
|  major  |  número  |  Número de la versión principal.  | 
|  minor  |  número  |  Número de la versión secundaria.  | 
|  revision  |  número  |  Número de la versión de revisión.  | 

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

#### Escriba:
<a name="type-29"></a>
+  Objeto 

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


|  Name  |  Tipo  |  Descripción  | 
| --- | --- | --- | 
|  fps  |  número  |  Fotogramas actuales por segundo.  | 
|  traffic  |  número  |  Tráfico actual en bit/s.  | 
|  peakTraffic  |  número  |  El pico de tráfico registrado bit/s desde que se estableció la conexión.  | 
|  latency  |  número  |  Latencia actual en ms.  | 
|  currentChannels  |  número  |  Número de canales que se han abierto desde que se estableció la conexión.  | 
|  openedChannels  |  número  |  Número de canales abiertos actualmente.  | 
|  channelErrors  |  número  |  Número de canales que han informado de un error.  | 

### storeFile(file, dir)
<a name="storeFile"></a>

#### Parámetros:
<a name="parameters-28"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  file  |  Archivos  |  El objeto de archivo (para obtener más información, consulte https://developer.mozilla). org/en-US/docs/Web/API/File) que queremos subir al servidor.  | 
|  dir  |  cadena  |  Ruta absoluta en el servidor en el que queremos cargar el archivo.  | 

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

 Las enumeraciones de TimezoneRedirectionError códigos disponibles en el módulo DCV 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `USER_CANNOT_CHANGE` 

#### Escriba:
<a name="w2aac14b9c17d101b7"></a>
+  número 

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

 Las enumeraciones TimezoneRedirectionSetting de códigos disponibles en el módulo DCV 
+  `ALWAYS_OFF` 
+  `ALWAYS_ON` 
+  `CLIENT_DECIDES` 

#### Escriba:
<a name="w2aac14b9c17d103b7"></a>
+  número 

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

 Las enumeraciones TimezoneRedirectionStatus de códigos disponibles en el módulo DCV 
+  `SUCCESS` 
+  `PERMISSION_ERROR` 
+  `GENERIC_ERROR` 

#### Escriba:
<a name="w2aac14b9c17d105b7"></a>
+  número 

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

 Las enumeraciones WebcamError de códigos disponibles en el módulo DCV 
+  `SETTING_WEBCAM_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### Escriba:
<a name="type-30"></a>
+  número 

### httpExtraSearchParamsCallback(método, url, cuerpo)
<a name="httpExtraSearchParamsCallback"></a>

 La función de devolución de llamada a la que se debe llamar para inyectar parámetros de consulta personalizados URLs durante la autenticación y el establecimiento de la conexión. Esto permite escenarios de integración avanzados, incluida la posibilidad de añadir parámetros de consulta personalizados y valores firmados de la versión 4 de la AWS firma (SiGv4) para proteger y autorizar las conexiones a través de sistemas externos. 

Esta devolución de llamada también se utiliza para personalizar la URL que se utiliza al establecer una WebSocket conexión con el servidor Amazon DCV.

#### Parámetros:
<a name="parameters-29"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  method  |  cadena  |  El método HTTP que se utiliza en la solicitud.  | 
|  url  |  cadena  |  La URL que se utilizará para la solicitud.  | 
|  body  |  cadena  |  El contenido del cuerpo de la solicitud.  | 

#### Devuelve:
<a name="returns-30"></a>

 Objeto `URLSearchParams` que contiene los parámetros de consulta personalizados que se van a adjuntar a la URL. 

 Tipo   
 URLSearchParámetros 

### httpExtraHeadersRetrollamada (método, URL, cuerpo)
<a name="httpExtraHeadersCallback"></a>

 La función de devolución de llamada a la que se debe llamar para insertar encabezados personalizados (por ejemplo, `Authorization`) en la solicitud HTTP durante el establecimiento de la conexión. 

#### Parámetros:
<a name="parameters-31"></a>


|  Name  |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
|  method  |  cadena  |  El método HTTP que se utiliza en la solicitud.  | 
|  url  |  cadena  |  La URL que se utilizará para la solicitud.  | 
|  body  |  cadena  |  El contenido del cuerpo de la solicitud.  | 

#### Devuelve:
<a name="returns-32"></a>

 Objeto que contiene pares clave-valor que representan los encabezados personalizados que se van a añadir a la solicitud HTTP. 

 Tipo   
 Objeto