

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 name="connection-class"></a>

A Classe de conexão obtida chamando o [método `connect`](dcv-module.md#connect) do modulo `dcv`. Para ver um exemplo de como usá-lo, consulte a seção [Introdução](establish-connection.md#auth-conn).

**Topics**
+ [Métodos](#methods)

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

**Topics**
+ [attachDisplay (win, displayConf) → {Promise. <number>\|Promessa. < {código: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), mensagem: string} >}](#attachDisplay)
+ [captureClipboardEvents(ativado, win, displayID) → {void}](#captureClipboardEvents)
+ [detachDisplay(displayId) → {void}](#detachDisplay)
+ [disconnect() → {void}](#disconnect)
+ [disconnectCollaborator(connectionId) → {void}](#disconnectCollaborator)
+ [enableDisplayQualityAtualizações (ativar) → {void}](#enableDisplayQualityUpdates)
+ [enableHighPixelDensidade (ativar) → {vazio}](#enableHighPixelDensity)
+ [enableTimezoneRedirection(habilitar) → {Promise\|Promessa. < {código: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), mensagem: string} >}](#enableTimezoneRedirection)
+ [enterRelativeMouseModo () → {void}](#enterRelativeMouseMode)
+ [getConnectedDevices() → {Promessa. <Matriz. < MediaDeviceInfo >>\|Promessa. < {message: string} >}](#getConnectedDevices)
+ [getFileExplorer() → {Promessa. < armazenamento de [arquivos >\|Promessa](dcv-module.md#filestorage). < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} >}](#getFileExplorer)
+ [getMaxAllowedMonitorDimensions() {[MaxDimensionLimits](dcv-module.md#MaxDimensionLimits)}](#getMaxAllowedMonitorDimensions)
+ [getServerInfo() → {Informações do [servidor](dcv-module.md#serverInfo)}](#getServerInfo)
+ [getScreenshot () → {Promise\|Promessa. < {código: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), mensagem: string} >}](#getScreenshot)
+ [getStats() → {[stats](dcv-module.md#stats)}](#getStats)
+ [latchModifierKey(chave, localização, isDown) → {boolean}](#latchModifierKey)
+ [OpenChannel (nome, authToken, retornos de chamada, namespace) → {Promise\|Promise. < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} >}](#openChannel)
+ [queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>\|Promise.<{message: string}>}](#queryFeature)
+ [registerKeyboardShortcuts(atalhos) → {void}](#registerKeyboardShortcuts)
+ [requestDisplayConfig(highColorAccuracy) → {Promessa\|Promessa. < {código: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), mensagem: string} >}](#requestDisplayConfig)
+ [requestDisplayLayout(layout) → {Promise\|Promessa. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >}](#requestDisplayLayout)
+ [Solicitar resolução (largura, altura) → {Promise\|Promise. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >}](#requestResolution)
+ [sendKeyboardEvent(evento) → {boolean}](#sendKeyboardEvent)
+ [sendKeyboardShortcut(atalho) → {void}](#sendKeyboardShortcut)
+ [setDisplayQuality(min, maxopt) → {vazio}](#setDisplayQuality)
+ [setDisplayScale(ScaleRatio, DisplayID) → {Promise\|Promise. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >} (OBSOLETO)](#setDisplayScale)
+ [setKeyboardQuirks(peculiaridades) → {vazio}](#setKeyboardQuirks)
+ [setMaxDisplayResolução (maxWidth, maxHeight) → {void}](#setMaxDisplayResolution)
+ [SetMicrophone (enable) → {Promise\|Promise. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} >}](#setMicrophone)
+ [setMinDisplayResolução (minWidth, minHeight) → {void}](#setMinDisplayResolution)
+ [setUploadBandwidth(valor) → {número}](#setUploadBandwidth)
+ [setVolume(volume) → {void}](#setVolume)
+ [setMicrophone (habilitar, ID do dispositivo) → {Promise\|Promise. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} >}](#setMicrophone)
+ [setWebcam (habilitar, ID do dispositivo) → {Promise\|Promise. < {código: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), mensagem: string} >}](#setWebcam)
+ [syncClipboards() → {boolean}](#syncClipboards)

### attachDisplay (win, displayConf) → {Promise. <number>\|Promessa. < {código: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), mensagem: string} >}
<a name="attachDisplay"></a>

 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:
<a name="parameters-1"></a>


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Atributos  |  Description  | 
| --- | --- | --- | --- | 
|  win  |  Objeto  |  A janela à qual a exibição deve ser anexada.  | 
|  displayConf  |  Objeto  |  A configuração da exibição. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  displayId  |  número  |  <opcional>  |  O ID da exibição.  | 
|  displayDivName  |   |   |  O nome do título da div. da exibição.  | 

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

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

 Tipo   
 Promessa. <number>\| Promessa. < {código: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), mensagem: string} > 

### captureClipboardEvents(ativado, win, displayID) → {void}
<a name="captureClipboardEvents"></a>

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

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


|  Nome  |  Tipo  |  Atributos  |  Description  | 
| --- | --- | --- | --- | 
|  enabled  |  boolean  |   |  Para começar a ouvir eventos, especifique true. Para parar de ouvir eventos, especifique false.  | 
|  win  |  Objeto  |  <opcional>  |  A janela na qual se deve ouvir os eventos. Se omitido, a janela padrão será usada.  | 
|  displayId  |  número  |  <opcional>  |  O ID do monitor que deve ouvir os eventos. Se omitido, o monitor padrão da janela será usada.  | 

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

 Tipo   
 nulo 

### detachDisplay(displayId) → {void}
<a name="detachDisplay"></a>

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

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  displayId  |  número  |  O ID da tela a ser desconectado.  | 

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

 Tipo   
 nulo 

### disconnect() → {void}
<a name="disconnect"></a>

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

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

 Tipo   
 nulo 

### disconnectCollaborator(connectionId) → {void}
<a name="disconnectCollaborator"></a>

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

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  connectionId  |  boolean  |  O ID da conexão que será desconectada.  | 

#### Retorna:
<a name="returns-4"></a>

 Tipo   
 nulo 

### enableDisplayQualityAtualizações (ativar) → {void}
<a name="enableDisplayQualityUpdates"></a>

 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:
<a name="parameters-5"></a>


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  boolean  |  Para ativar as atualizações da qualidade de exibição, especifique true. Para desativar as atualizações da qualidade de exibição, especifique false.  | 

#### Retorna:
<a name="returns-5"></a>

 Tipo   
 nulo 

### enableHighPixelDensidade (ativar) → {vazio}
<a name="enableHighPixelDensity"></a>

 Ativa ou desativa a alta densidade de pixels no cliente. 

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  booliano  |  Se a alta densidade de pixels deve ou não ser ativada.  | 

#### Retorna:
<a name="returns-5"></a>

 Tipo   
 nulo 

### enableTimezoneRedirection(habilitar) → {Promise\|Promessa. < {código: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), mensagem: string} >}
<a name="enableTimezoneRedirection"></a>

 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:
<a name="parameters-5"></a>


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  boolean  |  Para ativar o redirecionamento de fuso horário, especifique true. Para desativar o redirecionamento de fuso horário, especifique false.  | 

#### Retorna:
<a name="returns-5"></a>

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

 Tipo   
 Promessa. <number>\| Promessa. < {código: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), mensagem: string} > 

### enterRelativeMouseModo () → {void}
<a name="enterRelativeMouseMode"></a>

 Ativa o modo relativo do mouse. 

#### Retorna:
<a name="returns65"></a>

 Tipo   
 nulo 

### getConnectedDevices() → {Promessa. <Matriz. < MediaDeviceInfo >>\|Promessa. < {message: string} >}
<a name="getConnectedDevices"></a>

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

#### Retorna:
<a name="returns-7"></a>

 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. 

 Tipo   
 Promessa. <Matriz. < MediaDeviceInfo >> \| Promessa. < {message: string} > 

### getFileExplorer() → {Promessa. < armazenamento de [arquivos >\|Promessa](dcv-module.md#filestorage). < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} >}
<a name="getFileExplorer"></a>

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

#### Retorna:
<a name="returns-8"></a>

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

 Tipo   
 Promessa. < [filestorage](dcv-module.md#filestorage) > \| Promessa. < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} > 

### getMaxAllowedMonitorDimensions() {[MaxDimensionLimits](dcv-module.md#MaxDimensionLimits)}
<a name="getMaxAllowedMonitorDimensions"></a>

 Solicita os limites de dimensão de exibição suportados pelo servidor Amazon DCV. 

#### Retorna:
<a name="returns-35"></a>

 O objeto que contém maxLargestDimension e é maxSmallestDimension suportado no webclient pelo servidor. 

 Tipo   
 [MaxDimensionLimits](dcv-module.md#MaxDimensionLimits) 

### getServerInfo() → {Informações do [servidor](dcv-module.md#serverInfo)}
<a name="getServerInfo"></a>

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

#### Retorna:
<a name="returns-9"></a>

 Informações sobre o software do servidor. 

 Tipo   
 [serverInfo](dcv-module.md#serverInfo) 

### getScreenshot () → {Promise\|Promessa. < {código: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), mensagem: string} >}
<a name="getScreenshot"></a>

 Recupera a captura de tela da área de trabalho remota no formato PNG. A captura de tela será retornada no observador [screenshotCallback](dcv-module.md#screenshotCallback). Em vez disso, `null` será retornado em caso de falhas. 

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

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

 Tipo   
 Promessa \| Promessa. < {código: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), mensagem: string} > 

### getStats() → {[stats](dcv-module.md#stats)}
<a name="getStats"></a>

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

#### Retorna:
<a name="returns-10"></a>

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

 Tipo   
 [stats](dcv-module.md#stats) 

### latchModifierKey(chave, localização, isDown) → {boolean}
<a name="latchModifierKey"></a>

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

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  key  |  Controle \| Alt \| AltGraph \| Meta \| OS \| Shift  |  A tecla para enviar.  | 
|  location  |  KeyboardEvent.localização  |  O local da tecla. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.  | 
|  isDown  |  booleano  |  Se o evento chave a ser injetado for um keydown (true) ou um keyup (false).  | 

#### Retorna:
<a name="returns-11"></a>

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

 Tipo   
 boolean 

### OpenChannel (nome, authToken, retornos de chamada, namespace) → {Promise\|Promise. < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} >}
<a name="openChannel"></a>

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

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  name  |  string  |  O nome do canal.  | 
|  authToken  |  string  |  O token de autenticação a ser usado ao se conectar ao servidor.  | 
|  callbacks  |  Objeto  |  Os retornos de chamada onMessage e onClose funcionam para chamar.  | 
|  namespace  |  string  |  O namespace do modelo. Disponível desde o SDK do cliente web do Amazon DCV 1.2.0 e o Servidor Amazon DCV 2022.1.  | 

#### Retorna:
<a name="returns-12"></a>

 Promise. Se rejeitado, recebemos um objeto de erro. 

 Tipo   
 Promessa \| Promessa. < {código: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), mensagem: string} > 

### queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>\|Promise.<{message: string}>}
<a name="queryFeature"></a>

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

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  featureName  |  [feature](dcv-module.md#feature)  |  O nome do atributo a ser consultado.  | 

#### Retorna:
<a name="returns-13"></a>

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

 Tipo   
 {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> \| Promise.<{message: string}> 

### registerKeyboardShortcuts(atalhos) → {void}
<a name="registerKeyboardShortcuts"></a>

 Registra os atalhos de teclado. 

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  shortcuts  |  Array.<Object>  |  A matriz de chaves e mapeamentos a serem registrados. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  sequence  |  Array.<Object>  |  O atalho do teclado para se registrar. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  output  |  Array.<Object>  |  A ação que deve ser executada pelo atalho. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.chave  |  O valor da tecla pressionada pelo usuário. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.  | 
|  location  |  KeyboardEvent.localização  |  A matriz de chaves a serem enviadas. A localização da tecla no teclado. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.  | 
|  key  |  KeyboardEvent.chave  |  O valor da tecla pressionada pelo usuário. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.  | 
|  location  |  KeyboardEvent.localização  |  A matriz de chaves a serem enviadas. A localização da tecla no teclado. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.  | 

#### Retorna:
<a name="returns-14"></a>

 Tipo   
 nulo 

### requestDisplayConfig(highColorAccuracy) → {Promessa\|Promessa. < {código: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), mensagem: string} >}
<a name="requestDisplayConfig"></a>

 Solicita uma configuração de exibição atualizada do servidor Amazon DCV. Disponível desde o SDK do cliente web do Amazon DCV 1.1.0 e o Servidor Amazon DCV 2022.0. 

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  highColorAccuracy  |  boolean  |  Se a alta precisão de cores deve ou não ser solicitada.  | 

#### Retorna:
<a name="returns-15"></a>

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

 Tipo   
 Promessa \| Promessa. < {código: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), mensagem: string} > 

### requestDisplayLayout(layout) → {Promise\|Promessa. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >}
<a name="requestDisplayLayout"></a>

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

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  layout  |  Array.<[Monitor](dcv-module.md#Monitor)>  |  O solicitado é exibido no layout.  | 

#### Retorna:
<a name="returns-16"></a>

 Promise. Se rejeitado, recebemos um objeto de erro. 

 Tipo   
 Promessa \| Promessa. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} > 

### Solicitar resolução (largura, altura) → {Promise\|Promise. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >}
<a name="requestResolution"></a>

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

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  width  |  número  |  A largura a ser solicitada em pixels. O valor mínimo permitido é 0.  | 
|  height  |  número  |  A altura a ser solicitada em pixels. O valor mínimo permitido é 0.  | 

#### Retorna:
<a name="returns-17"></a>

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

 Tipo   
 Promessa \| Promessa. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} > 

### sendKeyboardEvent(evento) → {boolean}
<a name="sendKeyboardEvent"></a>

 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](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](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events)\#events. 

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  event  |  KeyboardEvent  |  O evento de teclado a ser enviado.  | 

#### Retorna:
<a name="returns-18"></a>

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

 Tipo   
 boolean 

### sendKeyboardShortcut(atalho) → {void}
<a name="sendKeyboardShortcut"></a>

 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:
<a name="parameters-14"></a>


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  shortcut  |  Array.<Object>  |  A matriz de chaves a serem enviadas. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.chave  |  O valor da tecla pressionada pelo usuário. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.  | 
|  location  |  KeyboardEvent.localização  |  A matriz de chaves a serem enviadas. A localização da tecla no teclado. Para obter mais informações, consulte https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.  | 

#### Retorna:
<a name="returns-19"></a>

 Tipo   
 nulo 

### setDisplayQuality(min, maxopt) → {vazio}
<a name="setDisplayQuality"></a>

 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:
<a name="parameters-15"></a>


|  Nome  |  Tipo  |  Atributos  |  Description  | 
| --- | --- | --- | --- | 
|  min  |  número  |   |  A qualidade mínima da imagem.  | 
|  max  |  número  |  <opcional>  |  A qualidade máxima da imagem.  | 

#### Retorna:
<a name="returns-20"></a>

 Tipo   
 nulo 

### setDisplayScale(ScaleRatio, DisplayID) → {Promise\|Promise. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} >} (OBSOLETO)
<a name="setDisplayScale"></a>

 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 o Amazon DCV de que a tela está escalada 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:
<a name="parameters-16"></a>


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  scaleRatio  |  flutuação  |  A taxa de escala a ser usada. Deve ser um número estritamente positivo.  | 
|  displayId  |  número  |  O ID da tela a ser escalada.  | 

#### Retorna:
<a name="returns-21"></a>

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

 Tipo   
 Promessa \| Promessa. < {código: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), mensagem: string} > 

### setKeyboardQuirks(peculiaridades) → {vazio}
<a name="setKeyboardQuirks"></a>

 Define peculiaridades do teclado para o computador cliente. 

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


|  Nome  |  Tipo  |  Description  | 
| --- | --- | --- | 
|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  quirks  |  Objeto  |  As peculiaridades do teclado a serem ativadas ou desativadas. [See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/connection-class.html)  | 
|  macOptionToAlt  |  boolean  |  Para mapear a tecla Option como Alt no macOS, especifique true. Caso contrário, especifique false.  | 
|  macCommandToControl  |  boolean  |  Para mapear a tecla Command como Ctrl no macOS, especifique true. Caso contrário, especifique false.  | 

#### Retorna:
<a name="returns-22"></a>

 Tipo   
 nulo 

### setMaxDisplayResolução (maxWidth, maxHeight) → {void}
<a name="setMaxDisplayResolution"></a>

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

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  maxWidth  |  número  |  A largura máxima da tela em pixels. O valor mínimo permitido é 0.  | 
|  maxHeight  |  número  |  A altura máxima da tela em pixels. O valor mínimo permitido é 0.  | 

#### Retorna:
<a name="returns-23"></a>

 Tipo   
 nulo 

### SetMicrophone (enable) → {Promise\|Promise. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} >}
<a name="setMicrophone"></a>

 Ativa ou desativa o microfone. 

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  boolean  |  Para ativar o microfone, especifique true. Para desativar o microfone, especifique false.  | 

#### Retorna:
<a name="returns-24"></a>

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

 Tipo   
 Promessa \| Promessa. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} > 

### setMinDisplayResolução (minWidth, minHeight) → {void}
<a name="setMinDisplayResolution"></a>

 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:
<a name="parameters-20"></a>


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  minWidth  |  número  |  A largura mínima da tela em pixels. O valor mínimo permitido é 0.  | 
|  minHeight  |  número  |  A largura mínima da tela em pixels. O valor mínimo permitido é 0.  | 

#### Retorna:
<a name="returns-25"></a>

 Tipo   
 nulo 

### setUploadBandwidth(valor) → {número}
<a name="setUploadBandwidth"></a>

 Define a largura de banda máxima a ser usada para carregar arquivos no servidor Amazon DCV. 

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  value  |  número  |  O limite máxima da largura de banda em Kbps. O intervalo válido é de 1.024 kbps a 102.400 kbps.  | 

#### Retorna:
<a name="returns-26"></a>

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

 Tipo   
 número 

### setVolume(volume) → {void}
<a name="setVolume"></a>

 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:
<a name="parameters-22"></a>


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  volume  |  número  |  O nível de volume a ser usado.  | 

#### Retorna:
<a name="returns-27"></a>

 Tipo   
 nulo 

### setMicrophone (habilitar, ID do dispositivo) → {Promise\|Promise. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} >}
<a name="setMicrophone"></a>

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

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  boolean  |  Para ativar o microfone, especifique true. Para desativar o microfone, especifique false.  | 
|  deviceId  |  string  |  O ID do dispositivo do microfone. Se nenhum deviceId for fornecido, o deviceId default será usado.  | 

#### Retorna:
<a name="returns-28"></a>

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

 Tipo   
 Promessa \| Promessa. < {código: [AudioErrorCode](dcv-module.md#AudioErrorCode), mensagem: string} > 

### setWebcam (habilitar, ID do dispositivo) → {Promise\|Promise. < {código: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), mensagem: string} >}
<a name="setWebcam"></a>

 Ativa ou desativa a webcam. 

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


|  Nome  |  Tipo  |  Descrição  | 
| --- | --- | --- | 
|  enable  |  boolean  |  Para ativar a webcam, especifique true. Para desativar a webcam, especifique false.  | 
|  deviceId  |  string  |  O ID do dispositivo da webcam.  | 

#### Retorna:
<a name="returns-28"></a>

 Prometa que, se for bem-sucedida, será resolvida para o ID do dispositivo da attached/detached webcam. Se rejeitada, a promessa retornará um objeto de erro. 

 Tipo   
 Promessa. <string>\| Promessa. < {código: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), mensagem: string} > 

### syncClipboards() → {boolean}
<a name="syncClipboards"></a>

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

#### Retorna:
<a name="returns-29"></a>

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

 Tipo   
 boolean 