DCVmódulo - 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.

DCVmódulo

Un módulo que implementa el lado cliente del DCV protocolo.

Métodos

authenticate(url, callbacks) → {Authentication}

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

Parámetros:

Nombre Tipo Descripción
url cadena El nombre de host y el puerto del DCV servidor Amazon en ejecución en el siguiente formato:https://dcv_host_address:port. Por ejemplo: https://my-dcv-server:8443.
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 final DCV del servidor Amazon 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:

Nombre Tipo 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:

Nombre Tipo Descripción
handler función La función de controlador de registros personalizada. La función de controlador contiene el nivel (número), levelName (cadena), el dominio (cadena) y el mensaje (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:

Nombre Tipo 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.

Tipo: 

(constante) AuthenticationError: AuthenticationErrorCode

La AuthenticationError enumeración de códigos.

Tipo: 

(constante) ChannelError: ChannelErrorCode

La ChannelError enumeración de códigos.

Tipo: 

(constante) ClosingReasonError: ClosingReasonErrorCode

La ClosingReasonError enumeración de códigos.

Tipo: 

(constante) ConnectionError: ConnectionErrorCode

La ConnectionError enumeración de códigos.

Tipo: 

(constante) CustomChannelError: CustomChannelErrorCode

La CustomChannelError enumeración de códigos.

Tipo: 

(constante) DisplayConfigError: DisplayConfigErrorCode

La DisplayConfigError enumeración de códigos.

Tipo: 

(constante) FileStorageError: FileStorageErrorCode

La FileStorageError enumeración de códigos.

Tipo: 

(constante) LogLevel: LogLevel

Los niveles de SDK registro disponibles.

Tipo: 

(constante) MultiMonitorError: MultiMonitorErrorCode

La MultiMonitorError enumeración de códigos.

Tipo: 

(constante) ResolutionError: ResolutionErrorCode

La ResolutionError enumeración de códigos.

Tipo: 

(constante) TimezoneRedirectionError: TimezoneRedirectionErrorCode

La TimezoneRedirectionError enumeración de códigos.

Tipo: 

(constante) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

La TimezoneRedirectionSetting enumeración de códigos.

Tipo: 

(constante) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

La TimezoneRedirectionStatus enumeración de códigos.

Tipo: 

(constant) version

La DCV versión de Amazon con mayor, menor, parche, revisión, extensión yversionStr.

Propiedades:

Nombre Tipo Descripción
major integer Número de la versión principal.
minor integer Número de la versión secundaria.
patch integer Número de versión del parche.
revision integer 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.

Tipo: 

(constante) WebcamError: WebcamErrorCode

La WebcamError enumeración de códigos.

Tipo: 

Definiciones de tipo y devolución de llamada

AudioErrorCode

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

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Tipo: 

  • number

authenticationCallbacks

Devoluciones de llamada de autenticación

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo 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.

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

Tipo: 

  • number

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:

Nombre Tipo Descripción
authentication Autenticación El objeto de autenticación.
error Objeto Objeto de error generado por el proceso de autenticación.
Nombre Tipo 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:

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

authSuccessCallback(autenticación,authenticationData)

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

Parámetros:

Nombre Tipo Descripción
authentication Autenticación El objeto de autenticación.
authenticationData Array.<Object> Conjunto de objetos que incluyen los tokens de DCV sesión IDs y autenticación de Amazon.
Nombre Tipo Descripción
sessionId cadena El identificador de DCV sesión de Amazon.
authToken cadena El token de autenticación de la DCV sesión de Amazon.

Canal

Canales disponibles que se pueden especificar.

Tipo: 

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

ChannelErrorCode

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

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Tipo: 

  • number

clipboardEventCallback(evento)

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

Parámetros:

Nombre Tipo Descripción
event Objeto Información sobre el evento del portapapeles.
Nombre Tipo Atributos 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 boolean <optional> Indica si está habilitada la copia automática del portapapeles de la sesión en el portapapeles del cliente local.
maxDataSize number <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 de ClosingReasonError código 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

Tipo: 

  • number

Colorspace

Espacios de color disponibles que se pueden especificar.

Tipo: 

  • «RGB" | "YUV_ REC6 01" |" _ 09" YUV REC7

connectionCallbacks

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

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo 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 La función de devolución de llamada que se invocará cuando se reciba el primer fotograma del DCV servidor de Amazon.
filePrinted filePrintedCallback La función callback que se invoca cuando se imprime un archivo en el DCV servidor de Amazon.
fileDownload fileDownloadCallback La función de devolución de llamada que se invoca cuando un archivo está listo para descargarse del DCV servidor de Amazon.
dataChannel dataChannelCallback La función de devolución de llamada que se invoca cuando el DCV servidor de Amazon envía una notificación sobre la disponibilidad de un canal de datos.
licenseNotification licenseNotificationCallback La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe una notificación sobre el estado de la licencia.
idleWarningNotification idleWarningNotificationDevolución de llamada La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe una advertencia de tiempo de espera de inactividad.
collaboratorList collaboratorListCallback La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe la lista de colaboradores (desde la SDK versión 1.1.0 de Amazon DCV Web Client).
qualityIndicatorState 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 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.

ConnectionConfig

La configuración de una DCV conexión a Amazon.

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo Descripción
url cadena El nombre de host y el puerto del DCV servidor Amazon en ejecución en el siguiente formato:https://dcv_host_address:port. Por ejemplo: https://my-dcv-server:8443.
sessionId cadena El identificador de DCV sesión de Amazon.
authToken cadena Token de autenticación que se utilizará al conectarse al servidor.
baseUrl cadena El absoluto o relativo URL desde el que se van a cargar SDK los archivos.
resourceBaseUrl cadena El absoluto o relativo URL desde el que se accede a DCV los recursos.
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, el valor predeterminado es "RGB».
divId cadena El ID del div objeto en el que HTML DOM se encuentra SDK debe crear el lienzo con la transmisión remota.
volumeLevel integer Nivel de volumen preferido. El intervalo válido es de 0 a 100.
clipboardAutoSync boolean Indica si la copia automática del portapapeles de la DCV sesión de Amazon al portapapeles del cliente local está habilitada para los navegadores web compatibles.
dynamicAudioTuning boolean Indica si se debe ajustar dinámicamente el audio en función de la configuración de audio DCV del servidor Amazon cuando se establece una conexión.
clientHiDpiScaling boolean Indica si se debe escalar el lienzo en función del clienteDPI.
highColorAccuracy boolean 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 usar 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

Tipo: 

  • number

createDirectory(ruta)

Parámetros:

Nombre Tipo 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 de CustomChannelError código disponibles en el módulo DCV

  • TRANSPORT_ERROR

Tipo: 

  • number

dataChannelCallback(información)

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

Parámetros:

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

deleteFile(ruta)

Parámetros:

Nombre Tipo 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(motivo)

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

Parámetros:

Nombre Tipo Descripción
reason Objeto Motivo de la desconexión.
Nombre Tipo Descripción
code number 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:

Nombre Tipo Descripción
status Objeto Estado de la pantalla.
Nombre Tipo Descripción
enabled booleano Indica si la pantalla está habilitada.
closed boolean Indica si la pantalla está habilitada.
displayId number Identificador de la pantalla.

DisplayConfigErrorCode

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

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Tipo: 

  • number

displayLayoutCallback(serverWidth,serverHeight, cabezas)

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

Parámetros:

Nombre Tipo Descripción
serverWidth number Ancho (en píxeles) de la pantalla principal.
serverHeight number Alto (en píxeles) de la pantalla principal.
heads Array.<Monitor> Los cabezales de pantalla son compatibles con el DCV servidor de Amazon.

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 la SDK versión 1.1.0 de Amazon DCV Web Client).

  • 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 SAS secuencia (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 DCV servidor de Amazon para el cliente.

  • clipboard-paste- Indica la disponibilidad de la función de pegar en el portapapeles desde el cliente hasta el DCV servidor de Amazon.

  • 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 de archivos desde el DCV servidor de Amazon para el cliente.

  • file-upload- Indica la disponibilidad de la funcionalidad de carga de archivos desde el cliente al DCV servidor de Amazon.

  • timezone-redirection- Indica la disponibilidad de la funcionalidad de redireccionamiento de zonas horarias (desde la SDK versión 1.3.0 de Amazon DCV Web Client).

Tipo: 

  • cadena

featuresUpdateCallback(featuresList)

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

Parámetros:

Nombre Tipo Descripción
featuresList Array.<feature> Matriz de características que han cambiado.

fileDownloadCallback(fileResource)

La función de devolución de llamada que se invoca cuando un archivo está listo para descargarse del DCV servidor de Amazon.

Parámetros:

Nombre Tipo Descripción
fileResource Objeto Información sobre el archivo que está listo para su descarga.
Nombre Tipo Descripción
id cadena Identificador del archivo.
url cadena La 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 enURL.

filePrintedCallback(printResource)

La función callback que se invoca cuando se imprime un archivo en el DCV servidor de Amazon.

Parámetros:

Nombre Tipo Descripción
printResource Objeto Información sobre el archivo impreso.
Nombre Tipo Descripción
id cadena Identificador del archivo impreso.
url cadena La 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 está incluido en elURL.

filestorage

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

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo 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(activado)

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:

Nombre 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

Tipo: 

  • number

firstFrameCallback(resizeEnabled, relativeMouseMode Habilitado,displayId)

La función de devolución de llamada que se invocará cuando se reciba el primer fotograma del DCV servidor de Amazon. Se emite para cada pantalla.

Parámetros:

Nombre Tipo Descripción
resizeEnabled booleano Indica si el servidor admite el cambio de tamaño del diseño de la pantalla del cliente.
relativeMouseModeEnabled boolean Indica si el servidor admite el modo de ratón relativo.
displayId number Identificador de la pantalla.

idleWarningNotificationCallback () disconnectionDateTime

La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe una advertencia de tiempo de espera de inactividad.

Parámetros:

Nombre Tipo Descripción
disconnectionDateTime Fecha Fecha y hora de la desconexión.

collaboratorListCallback(colaboradores)

La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe la lista de colaboradores.

Parámetros:

Nombre Tipo Descripción
collaborators Array.<Object> Lista de objetos que contiene información sobre los colaboradores.
Nombre Tipo Descripción
username cadena Nombre de usuario del colaborador.
owner boolean Indica si el colaborador es el propietario de la sesión.
connectionId number Indica el ID asignado por el servidor a la conexión.

licenseNotificationCallback(notificación)

La función de devolución de llamada que se invocará cuando el DCV servidor de Amazon envíe una notificación sobre el estado de la licencia.

Parámetros:

Nombre Tipo Descripción
notification Objeto Notificación.
Nombre Tipo Descripción
product cadena El DCV producto.
status cadena Estado de la licencia.
message cadena Mensaje.
leftDays number Número de días para que caduque la licencia.
isDemo boolean Indica si la licencia es de demostración.
numUnlicensed number Número de conexiones sin licencia.
licensingMode cadena Modelo de licencia.
documentationUrl cadena El URL para la documentación.

list(path)

Parámetros:

Nombre Tipo Descripción
path cadena Ruta absoluta del servidor cuyo contenido queremos enumerar.

LogLevel

Los niveles de SDK registro disponibles.

Tipo: 

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

Supervisar

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo Descripción
name cadena Nombre del cabezal de pantalla.
rect Objeto Información sobre el cabezal de pantalla.
Nombre Tipo Descripción
x number Coordenada x inicial del cabezal de pantalla.
y number Coordenada y inicial del cabezal de pantalla.
width number Ancho (en píxeles) del cabezal de pantalla.
height number Alto (en píxeles) del cabezal de pantalla.
primary boolean 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 number El DPI del cabezal de la 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

Tipo: 

  • number

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:

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

renameDirectory(src, rest)

Parámetros:

Nombre Tipo 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, rest)

Parámetros:

Nombre Tipo 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ódigo disponibles en el módulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Tipo: 

  • number

retrieveFile(ruta)

Parámetros:

Nombre Tipo Descripción
path cadena Ruta absoluta del servidor que identifica el archivo que queremos descargar localmente.

screenshotCallback(captura de pantalla)

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

Parámetros:

Nombre Tipo Descripción
screenshot byte[] El búfer de captura de pantalla está PNG formateado 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

Tipo: 

  • number

serverInfo

Tipo: 

  • Objeto

Propiedades:

Nombre Tipo Descripción
name cadena Nombre del software.
version Objeto Número de versión del software.
Nombre Tipo Descripción
major number Número de la versión principal.
minor number Número de la versión secundaria.
revision number Número de la versión de revisión.
os cadena Sistema operativo.
arch cadena Arquitectura.
hostname cadena Nombre del host.

stats

Tipo: 

  • Objeto

Propiedades:

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

storeFile(archivo, directorio)

Parámetros:

Nombre Tipo 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 cargar en el servidor.
dir cadena Ruta absoluta en el servidor en el que queremos cargar el archivo.

TimezoneRedirectionErrorCode

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

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Tipo: 

  • number

TimezoneRedirectionSettingCode

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

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Tipo: 

  • number

TimezoneRedirectionStatusCode

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

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Tipo: 

  • number

WebcamErrorCode

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

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Tipo: 

  • number