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á.

Classe de conexão

A Classe de conexão obtida chamando o método connect do modulo dcv. Para ver um exemplo de como usá-lo, consulte a seção Introdução.

Métodos

attachDisplay(vencer,displayConf) → {Promessa. <number>|Promessa. < {código: MultiMonitorErrorCode, mensagem: string} >}

Anexa uma tela específica em uma janela. Você não pode anexar a tela principal. Se bem-sucedida, a função retornará displayId.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

captureClipboardEvents(ativado, vitória,displayId) → {void}

Inicia ou para de ouvir eventos de copiar e colar. No caso de áreas de transferências interativas (sempre no caso de colar), precisamos começar a ouvir os eventos de copiar/colar. Pode ser útil iniciar e parar de ouvir somente quando necessário, por exemplo, quando um modal é exibido.

Parâmetros:

Retorna:

detachDisplay(displayId) → {vazio}

Desconecta um monitor específico. O monitor principal não pode ser desconectado.

Parâmetros:

Retorna:

disconnect() → {void}

Desconecta-se do DCV servidor da Amazon e fecha a conexão.

Retorna:

disconnectCollaborator(connectionId) → {vazio}

Solicita a desconexão do colaborador conectado com o ID de conexão fornecido (desde a SDK versão 1.1.0 do Amazon DCV Web Client).

Parâmetros:

Retorna:

enableDisplayQualityAtualizações (ativar) → {void}

Ativa ou desativa as atualizações de qualidade de exibição para áreas de streaming que não recebem atualizações. Desativar as atualizações da qualidade de exibição reduz o uso da largura de banda, mas também diminui a qualidade da tela.

Parâmetros:

Retorna:

enableHighPixelDensidade (ativar) → {vazio}

Ativa ou desativa a alta densidade de pixels no cliente.

Parâmetros:

Retorna:

enableTimezoneRedirection(habilitar) → {Promise|Promessa. < {código: TimezoneRedirectionErrorCode, mensagem: string} >}

Ativa ou desativa o redirecionamento de fuso horário. Depois de ativado, o cliente solicita que o servidor faça com que o fuso horário da área de trabalho do servidor corresponda ao fuso horário do cliente.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

enterRelativeMouseModo () → {void}

Ativa o modo relativo do mouse.

Retorna:

getConnectedDevices() → {Promessa. <Matriz. < MediaDeviceInfo >>|Promessa. < {message: string} >}

Solicita uma lista dos dispositivos de mídia conectados ao computador cliente.

Retorna:

Se for bem-sucedido, ele retornará uma promessa que é resolvida em uma matriz de MediaDeviceInfo objetos. Para obter mais informações, consulte https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo. Se rejeitada, a promessa retornará um objeto de erro.

getFileExplorer() → {Promessa. < armazenamento de arquivos >|Promessa. < {código: ChannelErrorCode, mensagem: string} >}

Obtém um objeto para gerenciar o armazenamento de arquivos do DCV servidor Amazon.

Retorna:

Promise. Resolve para o objeto explorador de arquivos, se preenchido, ou para um objeto de erro, se rejeitado.

getServerInfo() → {serverInfo}

Obtém informações sobre o DCV servidor da Amazon.

Retorna:

Informações sobre o software do servidor.

getScreenshot() → {Promessa|Promessa. < {código: ScreenshotErrorCode, mensagem: string} >}

Recupera a captura de tela da área de trabalho remota em PNG formato. A captura de tela será retornada no screenshotCallbackobservador. nullem vez disso, será devolvido em caso de falhas.

Retorna:

Promessa que será resolvida se a solicitação for processada. Se rejeitado, recebemos um objeto de erro.

getStats() → {estatísticas}

Obtém estatísticas sobre o DCV servidor da Amazon.

Retorna:

Informações sobre as estatísticas de streaming.

latchModifierKey(chave, localização,isDown) → {boolean}

Envia um único evento keydown ou keyup do teclado para um modificador permitido.

Parâmetros:

Retorna:

Se a combinação solicitada for válida, a função retornará true, caso contrário, retornará false.

openChannel(nome, retornos de chamadaauthToken, namespace) → {Promise|Promise. < {código: ChannelErrorCode, mensagem: string} >}

Abre um canal de dados personalizado na conexão se ela tiver sido criada no Amazon DCV Server.

Parâmetros:

Retorna:

Promise. Se rejeitado, recebemos um objeto de erro.

queryFeature(featureName) → {Promessa. < {habilitado: booleano, remoto? : string,autoCopy? : booleano,autoPaste? : booleano,serviceStatus? : string, disponível? : boolean} >|Promessa. < {message: string} >}

Consulta o status de um recurso específico DCV do servidor Amazon.

Parâmetros:

Retorna:

Promise. Se resolvida, a função retorna um objeto status que sempre contém uma propriedade enabled e, possivelmente, também outras propriedades. Se rejeitada, a função retornará um objeto error.

registerKeyboardShortcuts(atalhos) → {void}

Registra os atalhos de teclado.

Parâmetros:

Retorna:

requestDisplayConfig(highColorAccuracy) → {Promessa|Promessa. < {código: DisplayConfigErrorCode, mensagem: string} >}

Solicita uma configuração de exibição atualizada do Amazon DCV Server. Disponível desde o Amazon DCV Web Client SDK 1.1.0 e o Amazon DCV Server 2022.0.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

requestDisplayLayout(layout) → {Promise|Promessa. < {código: ResolutionErrorCode, mensagem: string} >}

Solicita um layout de exibição atualizado para a conexão.

Parâmetros:

Retorna:

Promise. Se rejeitado, recebemos um objeto de erro.

requestResolution(largura, altura) → {Promise|Promise. < {código: ResolutionErrorCode, mensagem: string} >}

Solicita uma resolução de exibição atualizada do DCV servidor da Amazon.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

sendKeyboardEvent(evento) → {boolean}

Envia um evento de atalho de teclado. Para obter mais informações sobre eventos de teclado, consulte https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent. Os eventos de teclado válidos incluem: keydown, keypress e keyup. Para obter mais informações sobre esses eventos, consulte https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events.

Parâmetros:

Retorna:

Se o evento não for válido, a função retornará false. Se o evento for válido, a função retornará true.

sendKeyboardShortcut(atalho) → {void}

Envia um atalho de teclado. Use essa função para enviar uma sequência completa de keydown ou keyup. Por exemplo, enviar Ctrl + Alt + Del envia os eventos keydown para todas as teclas seguidas pelos eventos keyup. Use essa função mesmo se quiser enviar uma única chave.

Parâmetros:

Retorna:

setDisplayQuality(min, maxopt) → {vazio}

Define a qualidade da imagem a ser usada para a conexão. O intervalo válido é 0 a 100, sendo 1 a menor qualidade de imagem e 100 a mais alta qualidade de imagem. Especifique 0 para reter o valor atual.

Parâmetros:

Retorna:

setDisplayScale(scaleRatio,displayId) → {Promessa|Promessa. < {código: ResolutionErrorCode, mensagem: string} >} (DEPRECATED)

Obsoleto desde a versão 1.3.0. Não há mais necessidade de definir a escala de exibição. As coordenadas do mouse serão gerenciadas internamente de forma automática.

Notifica a Amazon de DCV que a tela é dimensionada no lado do cliente. Use isso para notificar o servidor de que ele precisa escalar os eventos do mouse para corresponder à proporção de exibição do cliente.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

setKeyboardQuirks(peculiaridades) → {vazio}

Define peculiaridades do teclado para o computador cliente.

Parâmetros:

Retorna:

setMaxDisplayResolução (maxWidth,maxHeight) → {void}

Define a resolução máxima da tela a ser usada para a conexão.

Parâmetros:

Retorna:

setMicrophone(habilitar) → {Promise|Promessa. < {código: AudioErrorCode, mensagem: string} >}

Ativa ou desativa o microfone.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

setMinDisplayResolução (minWidth,minHeight) → {void}

Define a resolução mínima da tela a ser usada para a conexão. Alguns aplicativos podem exigir uma resolução mínima da tela. Se a resolução mínima exigida for maior que a resolução máxima compatível com o cliente, será usada uma estratégia de redimensionamento. Use essa função com cuidado. A estratégia de redimensionamento pode fazer com que o sistema de entrada do mouse e do teclado fique menos preciso.

Parâmetros:

Retorna:

setUploadBandwidth(valor) → {número}

Define a largura de banda máxima a ser usada para fazer o upload de arquivos para o servidor da Amazon. DCV

Parâmetros:

Retorna:

- O limite de largura de banda definido. null se o atributo de armazenamento de arquivos estiver desativado no servidor.

setVolume(volume) → {vazio}

Define o nível de volume a ser usado para áudio. O intervalo válido é de 0 a 100, sendo 0 o volume mais baixo e 100 sendo o volume mais alto.

Parâmetros:

Retorna:

setMicrophone(habilitar,deviceId) → {Promise|Promessa. < {código: AudioErrorCode, mensagem: string} >}

[Experimental - pode mudar no futuro] Ativa ou desativa o microfone.

Parâmetros:

Retorna:

Promise. Se rejeitada, a promessa retornará um objeto de erro.

setWebcam(habilitar,deviceId) → {Promise|Promessa. < {código: WebcamErrorCode, mensagem: string} >}

Ativa ou desativa a webcam.

Parâmetros:

Retorna:

Prometa que, se for bem-sucedida, será resolvida para a webcam conectada/desconectada. deviceId Se rejeitada, a promessa retornará um objeto de erro.

syncClipboards() → {boolean}

Sincroniza a área de transferência do cliente local com a área de transferência remota do servidor AmazonDCV. A cópia automática deve ser compatível com o navegador.

Retorna:

Se as áreas de transferência tiverem sido sincronizadas, a função retornará true. Se as áreas de transferência não tiverem sido sincronizadas ou se o navegador não for compatível com a cópia automática, a função retornará false.