DCVmódulo - Amazon DCV
MétodosMembrosDefinições de tipo e retorno de chamada

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DCVmódulo

Um módulo que implementa o lado do cliente do DCV protocolo.

Métodos

authenticate(url, callbacks) → {Autenticação}

Inicia o processo de autenticação para o endpoint DCV do servidor Amazon especificado.

Parâmetros:

Nome Tipo Descrição
url string O nome do host e a porta do DCV servidor Amazon em execução no seguinte formato:https://dcv_host_address:port. Por exemplo: https://my-dcv-server:8443.
callbacks authenticationCallbacks Os retornos de chamada que estão disponíveis para serem chamados durante o processo de autenticação.

Retorna:

- O objeto Authentication.

Tipo

Autenticação

conectar (configuração) → {Promessa. < Conexão >|Promessa. < {código: ConnectionErrorCode, mensagem: string} >}

Conecta-se ao endpoint DCV do servidor Amazon especificado. Se a conexão for bem-sucedida, ela retornará um objeto Connection. Se a conexão falhar, ela retornará um objeto de erro.

Parâmetros:

Nome Tipo Descrição
config ConnectionConfig O ConnectionConfig objeto.

Retorna:

- Um objeto Connection ou um objeto de erro.

Tipo

Promessa. < Conexão > | Promessa. < {código: ConnectionErrorCode, mensagem: string} >

setLogHandler(manipulador) → {void}

Define uma função personalizada de manipulador de log. Ao substituir o manipulador de log padrão, a posição original da entrada do log será perdida durante a depuração usando o console do navegador.

Parâmetros:

Nome Tipo Descrição
handler função A função personalizada do manipulador de logs. A função do manipulador contém nível (número), levelName (string), domínio (string) e mensagem (string).

Retorna:

Tipo

nulo

setLogLevel(nível) → {vazio}

Define o nível do log. Isso será necessário apenas se o manipulador de logs padrão for usado.

Parâmetros:

Nome Tipo Descrição
level LogLevel O nível de log a ser usado.

Retorna:

Tipo

nulo

Membros

(constante) AudioError: AudioErrorCode

A enumeração dos AudioError códigos.

Tipo:

(constante) AuthenticationError: AuthenticationErrorCode

A enumeração dos AuthenticationError códigos.

Tipo:

(constante) ChannelError: ChannelErrorCode

A enumeração dos ChannelError códigos.

Tipo:

(constante) ClosingReasonError: ClosingReasonErrorCode

A enumeração dos ClosingReasonError códigos.

Tipo:

(constante) ConnectionError: ConnectionErrorCode

A enumeração dos ConnectionError códigos.

Tipo:

(constante) CustomChannelError: CustomChannelErrorCode

A enumeração dos CustomChannelError códigos.

Tipo:

(constante) DisplayConfigError: DisplayConfigErrorCode

A enumeração dos DisplayConfigError códigos.

Tipo:

(constante) FileStorageError: FileStorageErrorCode

A enumeração dos FileStorageError códigos.

Tipo:

(constante) LogLevel: LogLevel

Os níveis de SDK registro disponíveis.

Tipo:

(constante) MultiMonitorError: MultiMonitorErrorCode

A enumeração dos MultiMonitorError códigos.

Tipo:

(constante) ResolutionError: ResolutionErrorCode

A enumeração dos ResolutionError códigos.

Tipo:

(constante) TimezoneRedirectionError: TimezoneRedirectionErrorCode

A enumeração dos TimezoneRedirectionError códigos.

Tipo:

(constante) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

A enumeração dos TimezoneRedirectionSetting códigos.

Tipo:

(constante) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

A enumeração dos TimezoneRedirectionStatus códigos.

Tipo:

(constant) version

A DCV versão da Amazon com as versões principal, secundária, patch, revisão, estendida versionStr e.

Propriedades:

Nome Tipo Descrição
major inteiro O número da versão principal.
minor inteiro O número da versão secundária.
patch inteiro O número da versão de correção.
revision inteiro O número da revisão.
extended string A sequência estendida.
versionStr string Uma concatenação dos números principais, secundários, de correção e de revisão no formulário major.minor.patch+build.revision.

(constante) ScreenshotError: ScreenshotErrorCode

A enumeração dos ScreenshotError códigos.

Tipo:

(constante) WebcamError: WebcamErrorCode

A enumeração dos WebcamError códigos.

Tipo:

Definições de tipo e retorno de chamada

AudioErrorCode

As enumerações de AudioError código disponíveis no módulo DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Tipo:

  • número

authenticationCallbacks

Retornos de chamada de autenticação

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
promptCredentials authPromptCredentialsRetorno de chamada A função de retorno de chamada a ser chamada quando o usuário é desafiado a fornecer credenciais.
error authErrorCallback A função de retorno de chamada a ser chamada quando a autenticação falhar.
success authSuccessCallback A função de retorno de chamada a ser chamada quando a autenticação for bem-sucedida.

AuthenticationErrorCode

As enumerações de AuthenticationError código disponíveis no 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:

  • número

authErrorCallback(autenticação, erro)

A função de retorno de chamada a ser chamada quando a autenticação falhar.

Parâmetros:

Nome Tipo Descrição
authentication Autenticação O objeto Authentication.
error Objeto O objeto de erro gerado pelo processo de autenticação.
Nome Tipo Descrição
code AuthenticationErrorCode O código do erro.
message string A mensagem de erro.

authPromptCredentialsRetorno de chamada (autenticação, desafio)

A função de retorno de chamada a ser chamada quando o usuário é desafiado a fornecer credenciais. O usuário deve responder ao desafio fornecendo as credenciais solicitadas.

Parâmetros:

Nome Tipo Descrição
authentication Autenticação O objeto Authentication.
challenge Objeto O desafio.
Nome Tipo Descrição
requiredCredentials Array.<Object> Uma matriz de objetos de credenciais solicitados.
Nome Tipo Descrição
name string O nome da credencial solicitada.
type string O tipo da credencial solicitada.

authSuccessCallback(autenticação,authenticationData)

A função de retorno de chamada a ser chamada quando a autenticação for bem-sucedida.

Parâmetros:

Nome Tipo Descrição
authentication Autenticação O objeto Authentication.
authenticationData Array.<Object> Uma variedade de objetos que incluem tokens de DCV sessão IDs e autenticação da Amazon.
Nome Tipo Descrição
sessionId string O ID da DCV sessão da Amazon.
authToken string O token de autenticação para a DCV sessão da Amazon.

Channel (Canal)

Os canais disponíveis que podem ser especificados.

Tipo:

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

ChannelErrorCode

As enumerações de ChannelError código disponíveis no módulo DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Tipo:

  • número

clipboardEventCallback(evento)

A função de retorno de chamada a ser chamada quando a clipboardEvent é gerada.

Parâmetros:

Nome Tipo Descrição
event Objeto Informações sobre o evento da área de transferência.
Nome Tipo Atributos Descrição
name estabelecido | copiar | colar | dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData Sempre presente. O nome do evento.
clipboardData Object | string Os dados na área de transferência.
autoCopy boolean <opcional> Indica se a cópia automática da área de transferência da sessão para a área de transferência do cliente local está ativada.
maxDataSize número <opcional> A quantidade máxima de dados que podem ser colocados na área de transferência.
error string <opcional> Informações de erro, se aplicável.

ClosingReasonErrorCode

As enumerações de ClosingReasonError código disponíveis no 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:

  • número

Colorspace

Os espaços de cores disponíveis que podem ser especificados.

Tipo:

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

connectionCallbacks

Os retornos de chamada que estão disponíveis para serem chamados no caso de um erro de conexão.

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
disconnect disconnectCallback A função de retorno de chamada a ser chamada quando a conexão terminar.
displayLayout displayLayoutCallback A função de retorno de chamada a ser chamada quando o layout ou a resolução da tela são alterados.
displayAvailability displayAvailabilityCallback A função de retorno de chamada a ser chamada quando a disponibilidade de uma tela mudar.
firstFrame firstFrameCallback A função de retorno de chamada a ser chamada quando o primeiro quadro for recebido do DCV servidor Amazon.
filePrinted filePrintedCallback A função de retorno de chamada a ser chamada quando um arquivo é impresso no DCV servidor da Amazon.
fileDownload fileDownloadCallback A função de retorno de chamada a ser chamada quando um arquivo estiver pronto para ser baixado do DCV servidor da Amazon.
dataChannel dataChannelCallback A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia uma notificação sobre a disponibilidade de um canal de dados.
licenseNotification licenseNotificationCallback A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia uma notificação sobre o estado da licença.
idleWarningNotification idleWarningNotificationRetorno de chamada A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia um aviso de tempo limite de inatividade.
collaboratorList collaboratorListCallback A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia a lista de colaboradores (desde a SDK versão 1.1.0 do Amazon DCV Web Client).
qualityIndicatorState qualityIndicatorStateRetorno de chamada A função de retorno de chamada a ser chamada quando o indicador de qualidade da conexão mudar de estado.
filestorageEnabled filestorageEnabledCallback A função de retorno de chamada a ser chamada quando o armazenamento de arquivos estiver ativado ou desativado.
featuresUpdate featuresUpdateCallback A função de retorno de chamada a ser chamada quando o status de um atributo for alterado.
clipboardEvent clipboardEventCallback A função de retorno de chamada a ser chamada quando a clipboardEvent é gerada.
deviceChangeEvent deviceChangeEventRetorno de chamada A função de retorno de chamada a ser chamada quando um evento deviceChange for acionado.
screenshot screenshotCallback A função de retorno de chamada a ser chamada quando a screenshot for gerada.

ConnectionConfig

A configuração de uma DCV conexão com a Amazon.

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
url string O nome do host e a porta do DCV servidor Amazon em execução no seguinte formato:https://dcv_host_address:port. Por exemplo: https://my-dcv-server:8443.
sessionId string O ID da DCV sessão da Amazon.
authToken string O token de autenticação a ser usado ao se conectar ao servidor.
baseUrl string O absoluto ou relativo URL a partir do qual carregar SDK arquivos.
resourceBaseUrl string O absoluto ou relativo URL a partir do qual acessar DCV os recursos.
enabledChannels Array.<Channel> Indica a lista de canais que podem ser ativados. Se não for especificado ou se uma matriz vazia for fornecida, o padrão será todos os canais disponíveis.
losslessColorspace Colorspace Indica o espaço de cores que será usado. Se não for especificado, o padrão é "”RGB.
divId string O ID do div objeto no HTML DOM local SDK deve criar a tela com o fluxo remoto.
volumeLevel inteiro O nível de volume preferido. O intervalo válido é de 0 a 100.
clipboardAutoSync boolean Indica se a cópia automática da área de transferência da DCV sessão da Amazon para a área de transferência do cliente local está habilitada para navegadores da web compatíveis.
dynamicAudioTuning boolean Indica se o áudio deve ser ajustado dinamicamente com base nas configurações de áudio DCV do servidor Amazon quando uma conexão é estabelecida.
clientHiDpiScaling boolean Indica se a tela deve ser dimensionada com base na do clienteDPI.
highColorAccuracy boolean Indica se deve ser usada a alta precisão de cores, se disponível. O padrão é false, se não for especificado.
enableWebCodecs Booleano Indica se WebCodecs deve ser usado, se disponível. O padrão é false, se não for especificado.
observers connectionCallbacks O retorno de chamada funciona para chamar eventos relacionados à conexão.
callbacks connectionCallbacks O mesmo que a propriedade observers, mas cada retorno de chamada inclui o objeto Conexão como primeiro parâmetro.

ConnectionErrorCode

As enumerações de ConnectionError código disponíveis no 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:

  • número

createDirectory(caminho)

Parâmetros:

Nome Tipo Descrição
path string O caminho absoluto no servidor no qual queremos criar um diretório. Também deve incluir o nome do diretório de destino.

CustomChannelErrorCode

As enumerações de CustomChannelError código disponíveis no módulo DCV

  • TRANSPORT_ERROR

Tipo:

  • número

dataChannelCallback(informações)

A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia uma notificação sobre a disponibilidade de um canal de dados.

Parâmetros:

Nome Tipo Descrição
info Objeto Informações sobre o canal de dados.
Nome Tipo Descrição
name string O nome do canal de dados.
token string O token de autenticação do canal de dados.

deleteFile(caminho)

Parâmetros:

Nome Tipo Descrição
path string O caminho absoluto no servidor que identifica o arquivo que queremos excluir.

deviceChangeEventRetorno de chamada ()

A função de retorno de chamada a ser chamada quando um evento deviceChange for acionado.

disconnectCallback(razão)

A função de retorno de chamada a ser chamada quando a conexão terminar.

Parâmetros:

Nome Tipo Descrição
reason Objeto O motivo da desconexão.
Nome Tipo Descrição
code número O código do motivo.
message string A mensagem do motivo.

displayAvailabilityCallback(status,displayId)

A função de retorno de chamada a ser chamada quando a disponibilidade de uma tela mudar.

Parâmetros:

Nome Tipo Descrição
status Objeto O status do monitor.
Nome Tipo Descrição
enabled boolean Indica se o monitor está ativado.
closed boolean Indica se o monitor está fechado.
displayId número O identificador do monitor.

DisplayConfigErrorCode

As enumerações de DisplayConfigError código disponíveis no módulo DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Tipo:

  • número

displayLayoutCallback(serverWidth,serverHeight, cabeças)

A função de retorno de chamada a ser chamada quando o layout ou a resolução da tela são alterados.

Parâmetros:

Nome Tipo Descrição
serverWidth número A largura (em pixels) do monitor principal.
serverHeight número A altura (em pixels) do monitor principal.
heads Array.<Monitor> As cabeças de exibição são suportadas pelo DCV servidor Amazon.

feature

Os valores do atributo.

  • display - Indica a disponibilidade de um streaming de vídeo com um único monitor.

  • display-multi - Indica a disponibilidade de um streaming de vídeo com vários monitores.

  • high-color-accuracy- Indica a disponibilidade de alta precisão de cores (desde a SDK versão 1.1.0 do Amazon DCV Web Client).

  • mouse - Indica a disponibilidade da funcionalidade do mouse.

  • keyboard - Indica a disponibilidade da funcionalidade do teclado.

  • keyboard-sas- Indica a disponibilidade da funcionalidade de SAS sequência (Control + Alt + Delete).

  • relative-mouse - Indica a disponibilidade do modo relativo do mouse.

  • clipboard-copy- Indica a disponibilidade da funcionalidade de cópia da prancheta DCV do servidor Amazon para o cliente.

  • clipboard-paste- Indica a disponibilidade da funcionalidade de colar na área de transferência do cliente para o servidor da AmazonDCV.

  • audio-in - Indica a disponibilidade da funcionalidade de entrada de áudio usando o microfone.

  • audio-out - Indica a disponibilidade da funcionalidade de reprodução de áudio.

  • webcam - Indica a disponibilidade da funcionalidade de streaming da webcam.

  • file-download- Indica a disponibilidade da funcionalidade de download de arquivos do DCV servidor Amazon para o cliente.

  • file-upload- Indica a disponibilidade da funcionalidade de upload de arquivos do cliente para o DCV servidor da Amazon.

  • timezone-redirection- Indica a disponibilidade da funcionalidade de redirecionamento de fuso horário (desde a SDK versão 1.3.0 do Amazon DCV Web Client).

Tipo:

  • string

featuresUpdateCallback(featuresList)

A função de retorno de chamada a ser chamada quando o status de um atributo for alterado.

Parâmetros:

Nome Tipo Descrição
featuresList Matriz.<feature> Uma série de atributos que foram alterados.

fileDownloadCallback(fileResource)

A função de retorno de chamada a ser chamada quando um arquivo estiver pronto para ser baixado do DCV servidor da Amazon.

Parâmetros:

Nome Tipo Descrição
fileResource Objeto Informações sobre o arquivo que está pronto para ser baixado.
Nome Tipo Descrição
id string O identificador do arquivo.
url string O URL a ser usado para baixar o arquivo.
domain string O domínio do recurso.
token string O token de autenticação a ser usado para baixar o arquivo. O token também está incluído noURL.

filePrintedCallback(printResource)

A função de retorno de chamada a ser chamada quando um arquivo é impresso no DCV servidor da Amazon.

Parâmetros:

Nome Tipo Descrição
printResource Objeto Informações sobre o arquivo impresso.
Nome Tipo Descrição
id string O identificador do arquivo impresso.
url string O URL a ser usado para baixar o arquivo impresso.
domain string O domínio do recurso. Nesse caso, printer.
token string O token de autenticação a ser usado para baixar o arquivo impresso. O token também está incluído noURL.

filestorage

Objeto que permite explorar e executar ações no sistema de arquivos.

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
list list Função que permite listar os itens (arquivos e diretórios) presentes no caminho fornecido no servidor.
createDirectory createDirectory Função que permite criar um diretório no caminho especificado no servidor.
retrieveFile retrieveFile Função que permite baixar localmente um arquivo no caminho especificado no servidor.
deleteFile deleteFile Função que permite excluir um arquivo no caminho especificado no servidor.
renameFile renameFile Função que permite renomear um arquivo do caminho de origem especificado para o caminho de destino especificado.
renameDirectory renameDirectory Função que permite renomear um diretório do caminho de origem especificado para o caminho de destino especificado.
storeFile storeFile Função que permite fazer o upload de um arquivo local para o caminho fornecido no servidor.

filestorageEnabledCallback(ativado)

A função de retorno de chamada a ser chamada quando o armazenamento de arquivos estiver ativado. Canal lento somente no Internet Explorer 11.

Parâmetros:

Nome Tipo Descrição
enabled boolean Indica se o armazenamento de arquivos está habilitado.

FileStorageErrorCode

As enumerações de FileStorageError código disponíveis no módulo DCV

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Tipo:

  • número

firstFrameCallback(resizeEnabled, relativeMouseMode Ativado,displayId)

A função de retorno de chamada a ser chamada quando o primeiro quadro for recebido do DCV servidor Amazon. Emitido para cada monitor.

Parâmetros:

Nome Tipo Descrição
resizeEnabled boolean Indica se o servidor é compatível com o redimensionamento do layout de exibição do cliente.
relativeMouseModeEnabled boolean Indica se o servidor é compatível com o modo relativo do mouse.
displayId número O identificador do monitor.

idleWarningNotificationRetorno de chamada () disconnectionDateTime

A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia um aviso de tempo limite de inatividade.

Parâmetros:

Nome Tipo Descrição
disconnectionDateTime Data A data e a hora da desconexão.

collaboratorListCallback(colaboradores)

A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia a lista de colaboradores.

Parâmetros:

Nome Tipo Descrição
collaborators Array.<Object> Uma lista de objetos contendo informações sobre colaboradores.
Nome Tipo Descrição
username string O nome de usuário do colaborador.
owner boolean Indica se o colaborador é o proprietário da sessão.
connectionId número Indica o ID atribuído pelo servidor à conexão.

licenseNotificationCallback(notificação)

A função de retorno de chamada a ser chamada quando o DCV servidor da Amazon envia uma notificação sobre o estado da licença.

Parâmetros:

Nome Tipo Descrição
notification Objeto A notificação.
Nome Tipo Descrição
product string O DCV produto.
status string O status da licença.
message string Uma mensagem.
leftDays número O número de dias antes que a licença expire.
isDemo boolean Indica se a licença é uma licença de demonstração.
numUnlicensed número O número de conexões não licenciadas.
licensingMode string O modelo de licença.
documentationUrl string O URL para a documentação.

list(path)

Parâmetros:

Nome Tipo Descrição
path string O caminho absoluto no servidor do qual queremos listar o conteúdo.

LogLevel

Os níveis de SDK registro disponíveis.

Tipo:

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

Monitor

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
name string O nome do título da exibição.
rect Objeto Informações sobre o título da exibição.
Nome Tipo Descrição
x número A coordenada inicial x do título da exibição.
y número A coordenada inicial y do título da exibição.
width número A largura (em pixels) do título da exibição.
height número A altura (em pixels) do título da exibição.
primary boolean Indica se o título da exibição é o título da exibição principal. Isso é determinado pelo sistema operacional remoto, se disponível.
dpi número O DPI do cabeçote de exibição.

MultiMonitorErrorCode

As enumerações de MultiMonitorError código disponíveis no módulo DCV

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

Tipo:

  • número

qualityIndicatorStateRetorno de chamada (estado)

A função de retorno de chamada a ser chamada quando o indicador de qualidade da conexão mudar de estado.

Parâmetros:

Nome Tipo Descrição
state Array.<Object> Informações sobre a qualidade da conexão.
Nome Tipo Descrição
name string O nome do indicador.
status NORMAL | WARNING | CRITICAL Uma descrição do status.
changed boolean Indica se o status foi alterado.

renameDirectory(src, dest)

Parâmetros:

Nome Tipo Descrição
src string O caminho de origem absoluto no servidor que identifica o diretório que queremos renomear.
dest string O caminho de destino absoluto no servidor que especifica o caminho de destino e o nome do diretório.

renameFile(src, dest)

Parâmetros:

Nome Tipo Descrição
src string O caminho de origem absoluto no servidor que identifica o arquivo que queremos renomear.
dest string O caminho de destino absoluto no servidor que especifica o caminho de destino e o nome do arquivo.

ResolutionErrorCode

As enumerações de ResolutionError código disponíveis no módulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Tipo:

  • número

retrieveFile(caminho)

Parâmetros:

Nome Tipo Descrição
path string O caminho absoluto no servidor que identifica o arquivo que queremos baixar localmente.

screenshotCallback(captura de tela)

A função de retorno de chamada a ser chamada quando a screenshot for gerada.

Parâmetros:

Nome Tipo Descrição
screenshot byte[] Buffer de captura de tela em PNG formato ou null se a recuperação da captura de tela falhar.

ScreenshotErrorCode

As enumerações de ScreenshotError código disponíveis no módulo DCV

  • NO_CHANNEL

  • GENERIC_ERROR

Tipo:

  • número

serverInfo

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
name string O nome do software.
version Objeto O número da versão do software.
Nome Tipo Descrição
major número O número da versão principal.
minor número O número da versão secundária.
revision número O número da versão da revisão.
os string O sistema operacional.
arch string A arquitetura.
hostname string O nome do host.

stats

Tipo:

  • Objeto

Propriedades:

Nome Tipo Descrição
fps número Os quadros atuais por segundo.
traffic número O tráfego atual em bit/s.
peakTraffic número O pico de tráfego em bit/s desde que a conexão foi estabelecida.
latency número A latência atual em ms.
currentChannels número O número de canais que foram abertos desde que a conexão foi estabelecida.
openedChannels número O número de canais abertos atualmente.
channelErrors número O número de canais que relataram um erro.

storeFile(arquivo, diretório)

Parâmetros:

Nome Tipo Descrição
file Arquivo O objeto de arquivo (para obter mais informações, consulte https://developer.mozilla.org/en-US/docs/Web/ API /File) que queremos carregar no servidor.
dir string O caminho absoluto no servidor no qual queremos fazer o upload do arquivo.

TimezoneRedirectionErrorCode

As enumerações de TimezoneRedirectionError código disponíveis no módulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Tipo:

  • número

TimezoneRedirectionSettingCode

As enumerações de TimezoneRedirectionSetting código disponíveis no módulo DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Tipo:

  • número

TimezoneRedirectionStatusCode

As enumerações de TimezoneRedirectionStatus código disponíveis no módulo DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Tipo:

  • número

WebcamErrorCode

As enumerações de WebcamError código disponíveis no módulo DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Tipo:

  • número