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á. # Módulo DCV Um módulo que implementa o lado do cliente do protocolo DCV. **Topics** + [Métodos](#methods) + [Membros](#members) + [Definições de tipo e retorno de chamada](#type-definitions) ## Métodos **Topics** + [authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1](#authenticate) + [conectar (configuração) → \$1Promessa. < [Conexão](connection-class.md) >\$1Promessa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensagem: string\$1 >\$1](#connect) + [setLogHandler(manipulador) → \$1void\$1](#setLogHandler) + [setLogLevel(nível) → \$1vazio\$1](#setLogLevel) ### authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1 Inicia o processo de autenticação para o endpoint do servidor Amazon DCV especificado. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | url | string | O nome do host e a porta do servidor Amazon DCV em execução no seguinte formato: https://dcv\$1host\$1address:port. Por exemplo: https://my-dcv-server:8443. | | authenticationToken | string | Token a ser usado para autenticação. | | callbacks | [authenticationCallbacks](#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](authentication-class.md) ### conectar (configuração) → \$1Promessa. < [Conexão](connection-class.md) >\$1Promessa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensagem: string\$1 >\$1 Conecta-se ao endpoint do servidor Amazon DCV 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 | Description | | --- | --- | --- | | config | [ConnectionConfig](#ConnectionConfig) | O ConnectionConfig objeto. | #### Retorna: - Um objeto Connection ou um objeto de erro. Tipo Promessa. < [Conexão](connection-class.md) > \$1 Promessa. < \$1código: [ConnectionErrorCode](#ConnectionErrorCode), mensagem: string\$1 > ### setLogHandler(manipulador) → \$1void\$1 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 | Description | | --- | --- | --- | | handler | função | A função personalizada do manipulador de logs. A função do manipulador contém level (número), levelName (string), domínio (string) e message (string). | #### Retorna: Tipo nulo ### setLogLevel(nível) → \$1vazio\$1 Define o nível do log. Isso será necessário apenas se o manipulador de logs padrão for usado. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | level | [LogLevel](#LogLevel) | O nível de log a ser usado. | #### Retorna: Tipo nulo ## Membros **Topics** + [(constante) AudioError : [AudioErrorCode](#AudioErrorCode)](#AudioError) + [(constante) AuthenticationError : [AuthenticationErrorCode](#AuthenticationErrorCode)](#AuthenticationError) + [(constante) ChannelError : [ChannelErrorCode](#ChannelErrorCode)](#ChannelError) + [(constante) ClosingReasonError : [ClosingReasonErrorCode](#ClosingReasonErrorCode)](#ClosingReasonError) + [(constante) ConnectionError : [ConnectionErrorCode](#ConnectionErrorCode)](#ConnectionError) + [(constante) CustomChannelError : [CustomChannelErrorCode](#CustomChannelErrorCode)](#CustomChannelError) + [(constante) DisplayConfigError : [DisplayConfigErrorCode](#DisplayConfigErrorCode)](#DisplayConfigError) + [(constante) FileStorageError : [FileStorageErrorCode](#FileStorageErrorCode)](#FileStorageError) + [(constante) LogLevel : [LogLevel](#LogLevel)](#LogLevel_) + [(constante) MultiMonitorError : [MultiMonitorErrorCode](#MultiMonitorErrorCode)](#MultiMonitorError) + [(constante) ResolutionError : [ResolutionErrorCode](#ResolutionErrorCode)](#ResolutionError) + [(constante) TimezoneRedirectionError : [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)](#TimezoneRedirectionError) + [(constante) TimezoneRedirectionSetting : [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)](#TimezoneRedirectionSetting) + [(constante) TimezoneRedirectionStatus : [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)](#TimezoneRedirectionStatus) + [versionamento (constante)](#version) + [(constante) ScreenshotError : [ScreenshotErrorCode](#ScreenshotErrorCode)](#ScreenshotError) + [(constante) WebcamError : [WebcamErrorCode](#WebcamErrorCode)](#WebcamError) ### (constante) AudioError : [AudioErrorCode](#AudioErrorCode) A enumeração dos AudioError códigos. #### Tipo: + [AudioErrorCode](#AudioErrorCode) ### (constante) AuthenticationError : [AuthenticationErrorCode](#AuthenticationErrorCode) A enumeração dos AuthenticationError códigos. #### Tipo: + [AuthenticationErrorCode](#AuthenticationErrorCode) ### (constante) ChannelError : [ChannelErrorCode](#ChannelErrorCode) A enumeração dos ChannelError códigos. #### Tipo: + [ChannelErrorCode](#ChannelErrorCode) ### (constante) ClosingReasonError : [ClosingReasonErrorCode](#ClosingReasonErrorCode) A enumeração dos ClosingReasonError códigos. #### Tipo: + [ClosingReasonErrorCode](#ClosingReasonErrorCode) ### (constante) ConnectionError : [ConnectionErrorCode](#ConnectionErrorCode) A enumeração dos ConnectionError códigos. #### Tipo: + [ConnectionErrorCode](#ConnectionErrorCode) ### (constante) CustomChannelError : [CustomChannelErrorCode](#CustomChannelErrorCode) A enumeração dos CustomChannelError códigos. #### Tipo: + [CustomChannelErrorCode](#CustomChannelErrorCode) ### (constante) DisplayConfigError : [DisplayConfigErrorCode](#DisplayConfigErrorCode) A enumeração dos DisplayConfigError códigos. #### Tipo: + [DisplayConfigErrorCode](#DisplayConfigErrorCode) ### (constante) FileStorageError : [FileStorageErrorCode](#FileStorageErrorCode) A enumeração dos FileStorageError códigos. #### Tipo: + [FileStorageErrorCode](#FileStorageErrorCode) ### (constante) LogLevel : [LogLevel](#LogLevel) Os níveis de log do SDK disponíveis. #### Tipo: + [LogLevel](#LogLevel) ### (constante) MultiMonitorError : [MultiMonitorErrorCode](#MultiMonitorErrorCode) A enumeração dos MultiMonitorError códigos. #### Tipo: + [MultiMonitorErrorCode](#MultiMonitorErrorCode) ### (constante) ResolutionError : [ResolutionErrorCode](#ResolutionErrorCode) A enumeração dos ResolutionError códigos. #### Tipo: + [ResolutionErrorCode](#ResolutionErrorCode) ### (constante) TimezoneRedirectionError : [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) A enumeração dos TimezoneRedirectionError códigos. #### Tipo: + [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) ### (constante) TimezoneRedirectionSetting : [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) A enumeração dos TimezoneRedirectionSetting códigos. #### Tipo: + [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) ### (constante) TimezoneRedirectionStatus : [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) A enumeração dos TimezoneRedirectionStatus códigos. #### Tipo: + [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) ### versionamento (constante) O versionamento do Amazon DCV com versões principais, secundária, de correção, revisão, estendida e versionStr. #### Propriedades: | Nome | Tipo | Description | | --- | --- | --- | | major | integer | O número da versão principal. | | minor | integer | O número da versão secundária. | | patch | integer | O número da versão de correção. | | revision | integer | 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\$1build.revision. | ### (constante) ScreenshotError : [ScreenshotErrorCode](#ScreenshotErrorCode) A enumeração dos ScreenshotError códigos. #### Tipo: + [ScreenshotErrorCode](#ScreenshotErrorCode) ### (constante) WebcamError : [WebcamErrorCode](#WebcamErrorCode) A enumeração dos WebcamError códigos. #### Tipo: + [WebcamErrorCode](#WebcamErrorCode) ## Definições de tipo e retorno de chamada **Topics** + [AudioErrorCode](#AudioErrorCode) + [authenticationCallbacks](#authenticationCallbacks) + [AuthenticationErrorCode](#AuthenticationErrorCode) + [authErrorCallback(autenticação, erro)](#authErrorCallback) + [authPromptCredentialsRetorno de chamada (autenticação, desafio)](#authPromptCredentialsCallback) + [authSuccessCallback(autenticação, dados de autenticação)](#authSuccessCallback) + [Canal](#Channel) + [ChannelErrorCode](#ChannelErrorCode) + [clipboardEventCallback(evento)](#clipboardEventCallback) + [ClosingReasonErrorCode](#ClosingReasonErrorCode) + [Colorspace](#Colorspace) + [connectionCallbacks](#connectionCallbacks) + [ConnectionConfig](#ConnectionConfig) + [ConnectionErrorCode](#ConnectionErrorCode) + [createDirectory(path)](#createDirectory) + [CustomChannelErrorCode](#CustomChannelErrorCode) + [dataChannelCallback(informações)](#dataChannelCallback) + [deleteFile(path)](#deleteFile) + [deviceChangeEventRetorno de chamada ()](#deviceChangeEventCallback) + [disconnectCallback(reason)](#disconnectCallback) + [displayAvailabilityCallback(status, DisplayID)](#displayAvailabilityCallback) + [DisplayConfigErrorCode](#DisplayConfigErrorCode) + [displayLayoutCallback(largura do servidor, altura do servidor, cabeças)](#displayLayoutCallback) + [recurso](#feature) + [featuresUpdateCallback(Lista de recursos)](#featuresUpdateCallback) + [fileDownloadCallback(Recurso de arquivo)](#fileDownloadCallback) + [filePrintedCallback(Recurso de impressão)](#filePrintedCallback) + [filestorage](#filestorage) + [filestorageEnabledCallback(ativado)](#filestorageEnabledCallback) + [FileStorageErrorCode](#FileStorageErrorCode) + [firstFrameCallback(redimensionamento ativado, relativeMouseMode ativado, ID de exibição)](#firstFrameCallback) + [idleWarningNotificationRetorno de chamada () disconnectionDateTime](#idleWarningNotificationCallback) + [collaboratorListCallback(colaboradores)](#collaboratorListCallback) + [licenseNotificationCallback(notificação)](#licenseNotificationCallback) + [list(path)](#list) + [LogLevel](#LogLevel) + [Monitorar](#Monitor) + [MultiMonitorErrorCode](#MultiMonitorErrorCode) + [qualityIndicatorStateRetorno de chamada (estado)](#qualityIndicatorStateCallback) + [renameDirectory(src, dest)](#renameDirectory) + [renameFile(src, dest)](#renameFile) + [ResolutionErrorCode](#ResolutionErrorCode) + [retrieveFile(path)](#retrieveFile) + [screenshotCallback(screenshot)](#screenshotCallback) + [ScreenshotErrorCode](#ScreenshotErrorCode) + [serverInfo](#serverInfo) + [stats](#stats) + [storeFile(file, dir)](#storeFile) + [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) + [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) + [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) + [WebcamErrorCode](#WebcamErrorCode) + [httpExtraSearchParamsCallback(método, url, corpo)](#httpExtraSearchParamsCallback) + [httpExtraHeadersRetorno de chamada (método, url, corpo)](#httpExtraHeadersCallback) ### AudioErrorCode Os enums 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 | Description | | --- | --- | --- | | promptCredentials | [authPromptCredentialsRetorno de chamada](#authPromptCredentialsCallback) | A função de retorno de chamada a ser chamada quando o usuário é desafiado a fornecer credenciais. | | error | [authErrorCallback](#authErrorCallback) | A função de retorno de chamada a ser chamada quando a autenticação falhar. | | success | [authSuccessCallback](#authSuccessCallback) | A função de retorno de chamada a ser chamada quando a autenticação for bem-sucedida. | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | Função de retorno de chamada a ser chamada no método authenticate para injetar parâmetros de consulta personalizados no URL de autenticação antes de iniciar a solicitação. Também pode ser usado no connect método para personalizar a URL usada ao estabelecer uma WebSocket conexão com o servidor DCV. | ### AuthenticationErrorCode Os enums 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 | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | authentication | [Autenticação](authentication-class.md) | O objeto Authentication. | | error | Objeto | O objeto de erro gerado pelo processo de autenticação. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | code | [AuthenticationErrorCode](#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 | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | authentication | [Autenticação](authentication-class.md) | O objeto Authentication. | | challenge | Objeto | O desafio. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | requiredCredentials | Array. | Uma matriz de objetos de credenciais solicitados. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | name | string | O nome da credencial solicitada. | | type | string | O tipo da credencial solicitada. | ### authSuccessCallback(autenticação, dados de autenticação) A função de retorno de chamada a ser chamada quando a autenticação for bem-sucedida. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | authentication | [Autenticação](authentication-class.md) | O objeto Authentication. | | authenticationData | Array. | Uma variedade de objetos que incluem tokens de sessão IDs e autenticação do Amazon DCV. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | sessionId | string | O ID da sessão do Amazon DCV. | | authToken | string | O token de autenticação para a sessão do Amazon DCV. | ### Canal Os canais disponíveis que podem ser especificados. #### Tipo: + "clipboard" \$1 "display" \$1 "input" \$1 "audio" \$1 "filestorage" ### ChannelErrorCode Os enums 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 | Description | | --- | --- | --- | | Nome | Tipo | Atributos | Description | | --- | --- | --- | --- | | event | Objeto | Informações sobre o evento da área de transferência. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | name | estabelecido \$1 copiar \$1 colar \$1 \$1 \$1 dataSizeAlert \$1 \$1 autoCopyDone newDataAvailable autoPasteDone \$1 RemoteError \$1 pasteAvailableData | | Sempre presente. O nome do evento. | | clipboardData | Object \$1 string | | Os dados na área de transferência. | | autoCopy | boolean | | 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 | | A quantidade máxima de dados que podem ser colocados na área de transferência. | | error | string | | Informações de erro, se aplicável. | ### ClosingReasonErrorCode Os enums 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” \$1 “YUV\$1REC601" \$1 “YUV\$1” REC709 ### 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 | Description | | --- | --- | --- | | disconnect | [disconnectCallback](#disconnectCallback) | A função de retorno de chamada a ser chamada quando a conexão terminar. | | displayLayout | [displayLayoutCallback](#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](#displayAvailabilityCallback) | A função de retorno de chamada a ser chamada quando a disponibilidade de uma tela mudar. | | firstFrame | [firstFrameCallback](#firstFrameCallback) | A função de retorno de chamada a ser chamada quando o primeiro quadro for recebido do servidor Amazon DCV. | | filePrinted | [filePrintedCallback](#filePrintedCallback) | A função de retorno de chamada a ser chamada quando um arquivo for impresso no servidor Amazon DCV. | | fileDownload | [fileDownloadCallback](#fileDownloadCallback) | A função de retorno de chamada a ser chamada quando um arquivo baixado no servidor Amazon DCV. | | dataChannel | [dataChannelCallback](#dataChannelCallback) | A função de retorno de chamada a ser chamada quando o servidor Amazon DCV enviar uma notificação sobre a disponibilidade de um canal de dados. | | licenseNotification | [licenseNotificationCallback](#licenseNotificationCallback) | A função de retorno de chamada a ser chamada quando o servidor Amazon DCV enviar uma notificação sobre o estado da licença. | | idleWarningNotification | [idleWarningNotificationRetorno de chamada](#idleWarningNotificationCallback) | A função de retorno de chamada a ser chamada quando o servidor Amazon DCV envia um aviso de tempo limite de inatividade. | | collaboratorList | [collaboratorListCallback](#collaboratorListCallback) | A função de retorno de chamada a ser chamada quando o servidor Amazon DCV envia a lista de colaboradores (desde o SDK do Cliente Web do Amazon DCV versão 1.1.0). | | qualityIndicatorState | [qualityIndicatorStateRetorno de chamada](#qualityIndicatorStateCallback) | A função de retorno de chamada a ser chamada quando o indicador de qualidade da conexão mudar de estado. | | filestorageEnabled | [filestorageEnabledCallback](#filestorageEnabledCallback) | A função de retorno de chamada a ser chamada quando o armazenamento de arquivos estiver ativado ou desativado. | | featuresUpdate | [featuresUpdateCallback](#featuresUpdateCallback) | A função de retorno de chamada a ser chamada quando o status de um atributo for alterado. | | clipboardEvent | [clipboardEventCallback](#clipboardEventCallback) | A função de retorno de chamada a ser chamada quando a clipboardEvent é gerada. | | deviceChangeEvent | [deviceChangeEventRetorno de chamada](#deviceChangeEventCallback) | A função de retorno de chamada a ser chamada quando um evento deviceChange for acionado. | | screenshot | [screenshotCallback](#screenshotCallback) | A função de retorno de chamada a ser chamada quando a screenshot for gerada. | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | A função de retorno de chamada a ser chamada para personalizar a URL ao estabelecer uma WebSocket conexão com o servidor Amazon DCV. Esse retorno de chamada também pode ser usado com o método authenticate para anexar dinamicamente os parâmetros de consulta ao URL de autenticação antes que o SDK envie a solicitação. | | httpExtraHeadersCallback | [httpExtraHeadersRetorno de chamada](#httpExtraHeadersCallback) | Função de retorno de chamada a ser chamada para adicionar cabeçalhos personalizados à solicitação HTTP durante o estabelecimento da conexão. | ### ConnectionConfig A configuração para uma conexão do Amazon DCV. #### Tipo: + Objeto #### Propriedades: | Nome | Tipo | Description | | --- | --- | --- | | url | string | O nome do host e a porta do servidor Amazon DCV em execução no seguinte formato: https://dcv\$1host\$1address:port. Por exemplo: https://my-dcv-server:8443. | | sessionId | string | O ID da sessão do Amazon DCV. | | authToken | string | O token de autenticação a ser usado ao se conectar ao servidor. | | baseUrl | string | O URL absoluto ou relativo do qual carregar arquivos do SDK. | | resourceBaseUrl | string | O URL absoluto ou relativo a partir do qual acessar os recursos do DCV. | | enabledChannels | Array.<[Channel](#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](#Colorspace) | Indica o espaço de cores que será usado. Se não for especificado, o padrão será “RGB”. | | divId | string | O ID do objeto div no HTML DOM em que o SDK deve criar a tela com o fluxo remoto. | | volumeLevel | integer | O nível de volume preferido. O intervalo válido é de 0 a 100. | | clipboardAutoSync | booleano | Indica se a cópia automática da área de transferência da sessão do Amazon DCV para a área de transferência do cliente local está ativada para navegadores da web compatíveis. | | dynamicAudioTuning | booleano | Indica se o áudio deve ser ajustado dinamicamente com base nas configurações de áudio do servidor Amazon DCV quando uma conexão é estabelecida. | | clientHiDpiScaling | booleano | Indica se a tela deve ser escalada com base no DPI do cliente. | | 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](#connectionCallbacks) | O retorno de chamada funciona para chamar eventos relacionados à conexão. | | callbacks | [connectionCallbacks](#connectionCallbacks) | O mesmo que a propriedade observers, mas cada retorno de chamada inclui o objeto [Conexão](connection-class.md) como primeiro parâmetro. | ### ConnectionErrorCode Os enums de ConnectionError código disponíveis no módulo DCV + `ALREADY_OPEN` + `INVALID_CONFIG` + `INITIALIZATION_FAILED` + `REJECTED` + `MAIN_CHANNEL_ALREADY_OPEN` + `GENERIC_ERROR` (desde o DCV Server 2021.0) + `INTERNAL_SERVER_ERROR` (desde o DCV Server 2021.0) + `AUTHENTICATION_FAILED` (desde o DCV Server 2021.0) + `PROTOCOL_ERROR` (desde o DCV Server 2021.0) + `INVALID_SESSION_ID` (desde o DCV Server 2021.0) + `INVALID_CONNECTION_ID` (desde o DCV Server 2021.0) + `CONNECTION_LIMIT_REACHED` (desde o DCV Server 2021.0) + `SERVER_UNREACHABLE` (desde o DCV Server 2022.1) + `GATEWAY_BUSY` + `UNSUPPORTED_CREDENTIAL` (desde o DCV Server 2022.2) + `TRANSPORT_ERROR` #### Tipo: + número ### createDirectory(path) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | 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 Os enums 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 servidor Amazon DCV enviar uma notificação sobre a disponibilidade de um canal de dados. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | info | Objeto | Informações sobre o canal de dados. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | name | string | O nome do canal de dados. | | token | string | O token de autenticação do canal de dados. | ### deleteFile(path) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | 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(reason) A função de retorno de chamada a ser chamada quando a conexão terminar. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Descrição | | --- | --- | --- | | reason | Objeto | O motivo da desconexão. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | 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 | Description | | --- | --- | --- | | Nome | Tipo | Descrição | | --- | --- | --- | | status | Objeto | O status do monitor. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | displayId | número | O identificador do monitor. | | enabled | boolean | Indica se o monitor está ativado. | | closed | boolean | Indica se o monitor está fechado. | ### DisplayConfigErrorCode Os enums de DisplayConfigError código disponíveis no módulo DCV + `INVALID_ARGUMENT` + `UNSUPPORTED_OPERATION` + `NO_CHANNEL` #### Tipo: + número ### displayLayoutCallback(largura do servidor, altura do servidor, 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](#Monitor)> | Os títulos da exibição compatíveis com o servidor Amazon DCV. | ### recurso 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 o SDK do cliente web do Amazon DCV versão 1.1.0). + `mouse` - Indica a disponibilidade da funcionalidade do mouse. + `keyboard` - Indica a disponibilidade da funcionalidade do teclado. + `keyboard-sas` - Indica a disponibilidade da funcionalidade de sequência SAS (Control \$1 Alt \$1 Delete). + `relative-mouse` - Indica a disponibilidade do modo relativo do mouse. + `clipboard-copy` - Indica a disponibilidade da funcionalidade de cópia da área de transferência do servidor Amazon DCV para o cliente. + `clipboard-paste` - Indica a disponibilidade da funcionalidade de colagem da área de transferência do servidor Amazon DCV para o cliente. + `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 do arquivo do servidor Amazon DCV para o cliente. + `file-upload` - Indica a disponibilidade da funcionalidade de upload do arquivo do servidor Amazon DCV para o cliente. + `timezone-redirection` - Indica a disponibilidade da funcionalidade de redirecionamento de fuso horário (desde o SDK do cliente web do Amazon DCV versão 1.3.0). #### Tipo: + string ### featuresUpdateCallback(Lista de recursos) A função de retorno de chamada a ser chamada quando o status de um atributo for alterado. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | featuresList | Matriz.<[feature](#feature)> | Uma série de atributos que foram alterados. | ### fileDownloadCallback(Recurso de arquivo) A função de retorno de chamada a ser chamada quando um arquivo baixado no servidor Amazon DCV. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | fileResource | Objeto | Informações sobre o arquivo que está pronto para ser baixado. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | 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 no URL. | ### filePrintedCallback(Recurso de impressão) A função de retorno de chamada a ser chamada quando um arquivo for impresso no servidor Amazon DCV. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | printResource | Objeto | Informações sobre o arquivo impresso. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | 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 no URL. | ### filestorage Objeto que permite explorar e executar ações no sistema de arquivos. #### Tipo: + Objeto #### Propriedades: | Nome | Tipo | Description | | --- | --- | --- | | list | [list](#list) | Função que permite listar os itens (arquivos e diretórios) presentes no caminho fornecido no servidor. | | createDirectory | [createDirectory](#createDirectory) | Função que permite criar um diretório no caminho especificado no servidor. | | retrieveFile | [retrieveFile](#retrieveFile) | Função que permite baixar localmente um arquivo no caminho especificado no servidor. | | deleteFile | [deleteFile](#deleteFile) | Função que permite excluir um arquivo no caminho especificado no servidor. | | renameFile | [renameFile](#renameFile) | Função que permite renomear um arquivo do caminho de origem especificado para o caminho de destino especificado. | | renameDirectory | [renameDirectory](#renameDirectory) | Função que permite renomear um diretório do caminho de origem especificado para o caminho de destino especificado. | | storeFile | [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 Os enums 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(redimensionamento ativado, relativeMouseMode ativado, ID de exibição) A função de retorno de chamada a ser chamada quando o primeiro quadro for recebido do servidor Amazon DCV. 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 servidor Amazon DCV envia um aviso de tempo limite de inatividade. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | disconnectionDateTime | Data | A data e a hora da desconexão. | ### collaboratorListCallback(colaboradores) A função de retorno de chamada a ser chamada quando o servidor Amazon DCV envia a lista de colaboradores. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | collaborators | Array. | Uma lista de objetos contendo informações sobre colaboradores. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | 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 servidor Amazon DCV enviar uma notificação sobre o estado da licença. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | notification | Objeto | A notificação. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | product | string | O produto do DCV. | | 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 da documentação. | ### list(path) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | path | string | O caminho absoluto no servidor do qual queremos listar o conteúdo. | ### LogLevel Os níveis de log do SDK disponíveis. #### Tipo: + TRACE \$1 DEBUG \$1 INFO \$1 WARN \$1 ERROR \$1 SILENT ### Monitorar #### Tipo: + Objeto #### Propriedades: | Nome | Tipo | Description | | --- | --- | --- | | 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. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | 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 título da exibiçã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. | ### MultiMonitorErrorCode Os enums 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 | Description | | --- | --- | --- | | Nome | Tipo | Description | | --- | --- | --- | | state | Array. | Informações sobre a qualidade da conexão. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | name | string | O nome do indicador. | | status | NORMAL \$1 WARNING \$1 CRITICAL | Uma descrição do status. | | changed | boolean | Indica se o status foi alterado. | ### renameDirectory(src, dest) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | 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 | Description | | --- | --- | --- | | 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 Os enums de ResolutionError código disponíveis no módulo DCV + `INVALID_ARGUMENT` + `NO_CHANNEL` + `NOT_IMPLEMENTED` #### Tipo: + número ### retrieveFile(path) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | path | string | O caminho absoluto no servidor que identifica o arquivo que queremos baixar localmente. | ### screenshotCallback(screenshot) A função de retorno de chamada a ser chamada quando a screenshot for gerada. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | screenshot | byte[] | Buffer da captura de tela no formato PNG ou null se a recuperação da captura de tela falhar. | ### ScreenshotErrorCode Os enums de ScreenshotError código disponíveis no módulo DCV + `NO_CHANNEL` + `GENERIC_ERROR` #### Tipo: + número ### serverInfo #### Tipo: + Objeto #### Propriedades: | Nome | Tipo | Description | | --- | --- | --- | | Nome | Tipo | Descrição | | --- | --- | --- | | name | string | O nome do software. | | version | Objeto | O número da versão do software. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/dcv/latest/websdkguide/dcv-module.html) | | os | string | O sistema operacional. | | arch | string | A arquitetura. | | hostname | string | O nome do host. | | 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. | ### 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 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(file, dir) #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | file | Arquivo | O objeto do arquivo (para obter mais informações, consulte https://developer.mozilla). org/en-US/docs/Web/API/File) queremos fazer o upload para o servidor. | | dir | string | O caminho absoluto no servidor no qual queremos fazer o upload do arquivo. | ### TimezoneRedirectionErrorCode Os enums de TimezoneRedirectionError código disponíveis no módulo DCV + `INVALID_ARGUMENT` + `NO_CHANNEL` + `USER_CANNOT_CHANGE` #### Tipo: + número ### TimezoneRedirectionSettingCode Os enums de TimezoneRedirectionSetting código disponíveis no módulo DCV + `ALWAYS_OFF` + `ALWAYS_ON` + `CLIENT_DECIDES` #### Tipo: + número ### TimezoneRedirectionStatusCode Os enums de TimezoneRedirectionStatus código disponíveis no módulo DCV + `SUCCESS` + `PERMISSION_ERROR` + `GENERIC_ERROR` #### Tipo: + número ### WebcamErrorCode Os enums de WebcamError código disponíveis no módulo DCV + `SETTING_WEBCAM_FAILED` + `CHANNEL_NOT_AVAILABLE` #### Tipo: + número ### httpExtraSearchParamsCallback(método, url, corpo) A função de retorno de chamada a ser chamada para injetar parâmetros de consulta personalizados URLs durante a autenticação e o estabelecimento da conexão. Isso permite cenários avançados de integração, incluindo a capacidade de acrescentar parâmetros de consulta personalizados e adicionar valores assinados do AWS Signature Version 4 (SigV4) para proteger e autorizar conexões por meio de sistemas externos. Esse retorno de chamada também é usado para personalizar a URL usada ao estabelecer uma WebSocket conexão com o servidor Amazon DCV. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | method | string | O método HTTP que está sendo usado para a solicitação. | | url | string | O URL que será usado para a solicitação. | | body | string | O conteúdo do corpo da solicitação. | #### Retorna: Objeto `URLSearchParams` que contém os parâmetros de consulta personalizados a serem anexados ao URL. Tipo URLSearchParâmetros ### httpExtraHeadersRetorno de chamada (método, url, corpo) Função de retorno de chamada a ser chamada para inserir cabeçalhos personalizados (como `Authorization`) na solicitação HTTP durante o estabelecimento da conexão. #### Parâmetros: | Nome | Tipo | Description | | --- | --- | --- | | method | string | O método HTTP que está sendo usado para a solicitação. | | url | string | O URL que será usado para a solicitação. | | body | string | O conteúdo do corpo da solicitação. | #### Retorna: Objeto que contém pares de valor-chave que representam os cabeçalhos personalizados a serem adicionados à solicitação HTTP. Tipo Objeto