Módulo DCV - Amazon DCV
MétodosMiembrosDefiniciones de tipo y devolución de llamada

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

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

Métodos

authenticate(authParams) → {Authentication}

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

Parámetros:

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_host_address:port. Por ejemplo: https://my-dcv-server:8443.
authenticationToken cadena El token de autenticación para usar en la autenticación.
callbacks authenticationCallbacks Devoluciones de llamada que están disponibles para invocarse durante el proceso de autenticación.

Devuelve:

- El objeto de autenticación.

Tipo

Autenticación

connect (config) → {Promesa. < Conexión >|Promesa. < {código: ConnectionErrorCode, mensaje: cadena} >}

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:

Name Tipo Description (Descripción)
config ConnectionConfig El ConnectionConfig objeto.

Devuelve:

- Un objeto Connection o un objeto de error.

Tipo

Lo prometo. < Conexión > | Promesa. < {código: ConnectionErrorCode, mensaje: cadena} >

setLogHandler(controlador) → {vacío}

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:

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:

Tipo

void

setLogLevel(nivel) → {vacío}

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

Parámetros:

Name Tipo Description (Descripción)
level LogLevel Nivel de registro que se debe utilizar.

Devuelve:

Tipo

void

Miembros

(constante) AudioError: AudioErrorCode

La AudioError enumeración de códigos.

Escriba:

(constante) AuthenticationError: AuthenticationErrorCode

La AuthenticationError enumeración de códigos.

Escriba:

(constante) ChannelError: ChannelErrorCode

La ChannelError enumeración de códigos.

Escriba:

(constante) ClosingReasonError: ClosingReasonErrorCode

La ClosingReasonError enumeración de códigos.

Escriba:

(constante) ConnectionError: ConnectionErrorCode

La ConnectionError enumeración de códigos.

Escriba:

(constante) CustomChannelError: CustomChannelErrorCode

La CustomChannelError enumeración de códigos.

Escriba:

(constante) DisplayConfigError: DisplayConfigErrorCode

La DisplayConfigError enumeración de códigos.

Escriba:

(constante) FileStorageError: FileStorageErrorCode

La FileStorageError enumeración de códigos.

Escriba:

(constante) LogLevel: LogLevel

Niveles de registro del SDK disponibles.

Escriba:

(constante) MultiMonitorError: MultiMonitorErrorCode

La MultiMonitorError enumeración de códigos.

Escriba:

(constante) ResolutionError: ResolutionErrorCode

La ResolutionError enumeración de códigos.

Escriba:

(constante) TimezoneRedirectionError: TimezoneRedirectionErrorCode

La TimezoneRedirectionError enumeración de códigos.

Escriba:

(constante) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

La TimezoneRedirectionSetting enumeración de códigos.

Escriba:

(constante) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

La TimezoneRedirectionStatus enumeración de códigos.

Escriba:

(constant) version

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

Propiedades:

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+build.revision.

(constante) ScreenshotError: ScreenshotErrorCode

La ScreenshotError enumeración de códigos.

Escriba:

(constante) WebcamError: WebcamErrorCode

La WebcamError enumeración de códigos.

Escriba:

Definiciones de tipo y devolución de llamada

Enumeración

AudioErrorCode

Las enumeraciones AudioError de códigos disponibles en el módulo DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Escriba:

  • número

authenticationCallbacks

Devoluciones de llamada de autenticación

Escriba:

  • Objeto

Propiedades:

Name Tipo Description (Descripción)
promptCredentials authPromptCredentialsLlamada de vuelta Función de devolución de llamada que se invoca cuando se solicitan credenciales al usuario.
error authErrorCallback Función de devolución de llamada que se invoca cuando se produce un error en la autenticación.
success authSuccessCallback Función de devolución de llamada que se invoca cuando la autenticación es correcta.
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

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:

  • número

authErrorCallback(autenticación, error)

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

Parámetros:

Name Tipo Description (Descripción)
authentication Autenticación El objeto de autenticación.
error Objeto Objeto de error generado por el proceso de autenticación.
Name Tipo Description (Descripción)
code AuthenticationErrorCode Código de error.
message cadena Mensaje de error.

authPromptCredentialsDevolución de llamada (autenticación, impugnación)

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:

Name Tipo Description (Descripción)
authentication Autenticación El objeto de autenticación.
challenge Objeto La solicitud.
Name Tipo Description (Descripción)
requiredCredentials Array.<Object> Matriz de objetos de credenciales solicitados.
Name Tipo Description (Descripción)
name cadena Nombre de la credencial solicitada.
type cadena Tipo de la credencial solicitada.

authSuccessCallback(autenticación, datos de autenticación)

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

Parámetros:

Name Tipo Description (Descripción)
authentication Autenticación El objeto de autenticación.
authenticationData Array.<Object> Conjunto de objetos que incluyen tokens de sesión IDs y autenticación de Amazon DCV.
Name Tipo Description (Descripción)
sessionId cadena ID de la sesión de Amazon DCV.
authToken cadena Token de autenticación de la sesión de Amazon DCV.

Canal

Canales disponibles que se pueden especificar.

Escriba:

  • "clipboard" | "display" | "input" | "audio" | "filestorage"

ChannelErrorCode

Las enumeraciones ChannelError de códigos están disponibles en el módulo DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Escriba:

  • número

clipboardEventCallback(evento)

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

Parámetros:

Name Tipo Description (Descripción)
event Objeto Información sobre el evento del portapapeles.
Name Tipo Atributos Description (Descripción)
name establecido | copiar | pegar | | dataSizeAlert | autoCopyDone newDataAvailable autoPasteDone | RemoteError | pasteAvailableData Siempre están presentes. El nombre del evento.
clipboardData Objeto | 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

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:

  • número

Colorspace

Espacios de color disponibles que se pueden especificar.

Escriba:

  • «RGB» | «YUV_ REC6 01" | «YUV_ 09" REC7

connectionCallbacks

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

Escriba:

  • Objeto

Propiedades:

Name Tipo Description (Descripción)
disconnect disconnectCallback Función de devolución de llamada que se invoca cuando finaliza la conexión.
displayLayout displayLayoutCallback Función de devolución de llamada que se invoca cuando cambia el diseño o la resolución de pantalla.
displayAvailability displayAvailabilityCallback Función de devolución de llamada que se invoca cuando cambia la disponibilidad de una pantalla.
firstFrame firstFrameCallback Función de devolución de llamada que se invoca cuando se recibe el primer fotograma del servidor Amazon DCV.
filePrinted filePrintedCallback Función de devolución de llamada que se invoca cuando se imprime un archivo en el servidor Amazon DCV.
fileDownload 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 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 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 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 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 Función de devolución de llamada que se invoca cuando el indicador de calidad de la conexión cambia de estado.
filestorageEnabled filestorageEnabledCallback Función de devolución de llamada que se invoca cuando el almacenamiento de archivos está habilitado o deshabilitado.
featuresUpdate featuresUpdateCallback Función de devolución de llamada que se invoca cuando cambia el estado de una característica.
clipboardEvent clipboardEventCallback Función de devolución de llamada que se invoca cuando se genera un clipboardEvent.
deviceChangeEvent deviceChangeEventLlamada de vuelta Función de devolución de llamada que se invoca cuando se desencadena un evento deviceChange.
screenshot screenshotCallback Función de devolución de llamada que se invoca cuando a está disponible una screenshot.
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 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

Configuración de una conexión Amazon DCV.

Escriba:

  • Objeto

Propiedades:

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_host_address: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> 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 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 Funciones de devolución de llamada que se invocan para eventos relacionados con la conexión.
callbacks connectionCallbacks Igual que la propiedad observers, pero cada devolución de llamada incluye el objeto Connection como primer parámetro.

ConnectionErrorCode

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:

  • número

createDirectory(path)

Parámetros:

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

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

  • TRANSPORT_ERROR

Escriba:

  • número

dataChannelCallback(información)

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:

Name Tipo Description (Descripción)
info Objeto Información sobre el canal de datos.
Name Tipo Description (Descripción)
name cadena Nombre del canal de datos.
token cadena Token de autenticación del canal de datos.

deleteFile(path)

Parámetros:

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

deviceChangeEventLlamada ()

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

disconnectCallback(reason)

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

Parámetros:

Name Tipo Description (Descripción)
reason Objeto Motivo de la desconexión.
Name Tipo Descripción
code número Código de región.
message cadena Mensaje del motivo.

displayAvailabilityCallback(estado, displayID)

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

Parámetros:

Name Tipo Description (Descripción)
status Objeto Estado de la pantalla.
Name Tipo Descripción
enabled booleano Indica si la pantalla está habilitada.
closed booleano Indica si la pantalla está habilitada.
displayId número Identificador de la pantalla.

DisplayConfigErrorCode

Las enumeraciones DisplayConfigError de códigos disponibles en el módulo DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Escriba:

  • número

displayLayoutCallback(ServerWidth, ServerHeight, heads)

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

Parámetros:

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> Cabezales de pantalla compatibles con el servidor Amazon DCV.

característica

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 + Alt + 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:

  • cadena

featuresUpdateCallback(Lista de características)

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

Parámetros:

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

fileDownloadCallback(Recurso de archivo)

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

Parámetros:

Name Tipo Description (Descripción)
fileResource Objeto Información sobre el archivo que está listo para su descarga.
Name Tipo Description (Descripción)
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)

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

Parámetros:

Name Tipo Description (Descripción)
printResource Objeto Información sobre el archivo impreso.
Name Tipo Description (Descripción)
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

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

Escriba:

  • Objeto

Propiedades:

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

filestorageEnabledCallback(habilitado)

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:

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

FileStorageErrorCode

Las enumeraciones de FileStorageError códigos disponibles en el módulo DCV

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Escriba:

  • número

firstFrameCallback(Resize Enabled, Enabled, DisplayID relativeMouseMode)

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:

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

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:

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

collaboratorListCallback(colaboradores)

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

Parámetros:

Name Tipo Description (Descripción)
collaborators Array.<Object> Lista de objetos que contiene información sobre los colaboradores.
Name Tipo Description (Descripción)
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)

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:

Name Tipo Description (Descripción)
notification Objeto Notificación.
Name Tipo Description (Descripción)
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)

Parámetros:

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

LogLevel

Niveles de registro del SDK disponibles.

Escriba:

  • TRACE | DEBUG | INFO | WARN | ERROR | SILENT

Supervisión

Escriba:

  • Objeto

Propiedades:

Name Tipo Description (Descripción)
name cadena Nombre del cabezal de pantalla.
rect Objeto Información sobre el cabezal de pantalla.
Name Tipo Descripción
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.
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.

MultiMonitorErrorCode

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:

  • número

qualityIndicatorStateLlamada de vuelta (estado)

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

Parámetros:

Name Tipo Description (Descripción)
state Array.<Object> Información sobre la calidad de la conexión.
Name Tipo Description (Descripción)
name cadena Nombre del indicador.
status NORMAL | WARNING | CRITICAL Descripción del estado.
changed booleano Indica si el estado ha cambiado.

renameDirectory(src, dest)

Parámetros:

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)

Parámetros:

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

Las enumeraciones ResolutionError de códigos disponibles en el módulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Escriba:

  • número

retrieveFile(path)

Parámetros:

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

screenshotCallback(screenshot)

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

Parámetros:

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

Las enumeraciones ScreenshotError de códigos disponibles en el módulo DCV

  • NO_CHANNEL

  • GENERIC_ERROR

Escriba:

  • número

serverInfo

Escriba:

  • Objeto

Propiedades:

Name Tipo Description (Descripción)
name cadena Nombre del software.
version Objeto Número de versión del software.
Name Tipo Descripción
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.
os cadena Sistema operativo.
arch cadena Arquitectura.
hostname cadena Nombre del host.

stats

Escriba:

  • Objeto

Propiedades:

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)

Parámetros:

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

Las enumeraciones de TimezoneRedirectionError códigos disponibles en el módulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Escriba:

  • número

TimezoneRedirectionSettingCode

Las enumeraciones TimezoneRedirectionSetting de códigos disponibles en el módulo DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Escriba:

  • número

TimezoneRedirectionStatusCode

Las enumeraciones TimezoneRedirectionStatus de códigos disponibles en el módulo DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Escriba:

  • número

WebcamErrorCode

Las enumeraciones WebcamError de códigos disponibles en el módulo DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Escriba:

  • número

httpExtraSearchParamsCallback(método, url, cuerpo)

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:

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:

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)

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:

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:

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

Tipo

Objeto