Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # Module DCV Module qui implémente le côté client du protocole DCV. **Topics** + [Méthodes](#methods) + [Members](#members) + [Définitions de type et de rappel](#type-definitions) ## Méthodes **Topics** + [[authentifier (AuthParams) → \$1Authentification\$1](authentication-class.md)](#authenticate) + [connect (config) → \$1Promesse. < [Connexion](connection-class.md) >\$1Promesse. < \$1code : [ConnectionErrorCode](#ConnectionErrorCode), message : chaîne\$1 >\$1](#connect) + [setLogHandler(gestionnaire) → \$1void\$1](#setLogHandler) + [setLogLevel(niveau) → \$1void\$1](#setLogLevel) ### [authentifier (AuthParams) → \$1Authentification\$1](authentication-class.md) Démarre le processus d'authentification pour le point de terminaison du serveur Amazon DCV spécifié. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | url | chaîne | Le nom d'hôte et le port du serveur Amazon DCV en cours d'exécution au format suivant :https://dcv\$1host\$1address:port. Par exemple : https://my-dcv-server:8443. | | authenticationToken | chaîne | Le jeton d'authentification à utiliser pour l'authentification. | | callbacks | [Rappels d'authentification](#authenticationCallbacks) | Les rappels disponibles pour être appelés pendant le processus d'authentification. | #### Renvoie: - L'objet d'authentification. Type [Authentification](authentication-class.md) ### connect (config) → \$1Promesse. < [Connexion](connection-class.md) >\$1Promesse. < \$1code : [ConnectionErrorCode](#ConnectionErrorCode), message : chaîne\$1 >\$1 Se connecte au point de terminaison du serveur Amazon DCV spécifié. Si la connexion réussit, elle renvoie un objet Connection. Si la connexion échoue, elle renvoie un objet d'erreur. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | config | [ConnectionConfig](#ConnectionConfig) | L' ConnectionConfig objet. | #### Renvoie: - Un objet Connection ou un objet d'erreur. Type Promesse. < [Connexion](connection-class.md) > \$1 Promesse. < \$1code : [ConnectionErrorCode](#ConnectionErrorCode), message : chaîne\$1 > ### setLogHandler(gestionnaire) → \$1void\$1 Définit une fonction de gestionnaire de journal personnalisée. Lorsque vous remplacez le gestionnaire de journal par défaut, la position d'entrée d'origine du journal sera perdue lors du débogage avec la console du navigateur. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | handler | fonction | La fonction de gestion de journal personnalisée. La fonction de gestion contient le niveau (nombre), le nom du niveau (chaîne), le domaine (chaîne) et le message (chaîne). | #### Renvoie: Type void ### setLogLevel(niveau) → \$1void\$1 Définit le niveau de journalisation. Cela n'est obligatoire que si le gestionnaire de journal par défaut est utilisé. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | level | [LogLevel](#LogLevel) | Le niveau de journalisation à utiliser. | #### Renvoie: Type void ## Members **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) + [version (constante)](#version) + [(constante) ScreenshotError  : [ScreenshotErrorCode](#ScreenshotErrorCode)](#ScreenshotError) + [(constante) WebcamError  : [WebcamErrorCode](#WebcamErrorCode)](#WebcamError) ### (constante) AudioError  : [AudioErrorCode](#AudioErrorCode) Les AudioError codes énumèrent. #### Type : + [AudioErrorCode](#AudioErrorCode) ### (constante) AuthenticationError  : [AuthenticationErrorCode](#AuthenticationErrorCode) Les AuthenticationError codes énumèrent. #### Type : + [AuthenticationErrorCode](#AuthenticationErrorCode) ### (constante) ChannelError  : [ChannelErrorCode](#ChannelErrorCode) Les ChannelError codes énumèrent. #### Type : + [ChannelErrorCode](#ChannelErrorCode) ### (constante) ClosingReasonError  : [ClosingReasonErrorCode](#ClosingReasonErrorCode) Les ClosingReasonError codes énumèrent. #### Type : + [ClosingReasonErrorCode](#ClosingReasonErrorCode) ### (constante) ConnectionError  : [ConnectionErrorCode](#ConnectionErrorCode) Les ConnectionError codes énumèrent. #### Type : + [ConnectionErrorCode](#ConnectionErrorCode) ### (constante) CustomChannelError  : [CustomChannelErrorCode](#CustomChannelErrorCode) Les CustomChannelError codes énumèrent. #### Type : + [CustomChannelErrorCode](#CustomChannelErrorCode) ### (constante) DisplayConfigError  : [DisplayConfigErrorCode](#DisplayConfigErrorCode) Les DisplayConfigError codes énumèrent. #### Type : + [DisplayConfigErrorCode](#DisplayConfigErrorCode) ### (constante) FileStorageError  : [FileStorageErrorCode](#FileStorageErrorCode) Les FileStorageError codes énumèrent. #### Type : + [FileStorageErrorCode](#FileStorageErrorCode) ### (constante) LogLevel  : [LogLevel](#LogLevel) Les niveaux de journalisation du SDK disponibles. #### Type : + [LogLevel](#LogLevel) ### (constante) MultiMonitorError  : [MultiMonitorErrorCode](#MultiMonitorErrorCode) Les MultiMonitorError codes énumèrent. #### Type : + [MultiMonitorErrorCode](#MultiMonitorErrorCode) ### (constante) ResolutionError  : [ResolutionErrorCode](#ResolutionErrorCode) Les ResolutionError codes énumèrent. #### Type : + [ResolutionErrorCode](#ResolutionErrorCode) ### (constante) TimezoneRedirectionError  : [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) Les TimezoneRedirectionError codes énumèrent. #### Type : + [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) ### (constante) TimezoneRedirectionSetting  : [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) Les TimezoneRedirectionSetting codes énumèrent. #### Type : + [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) ### (constante) TimezoneRedirectionStatus  : [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) Les TimezoneRedirectionStatus codes énumèrent. #### Type : + [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) ### version (constante) La version Amazon DCV avec version majeure, mineure, correctif, révision, étendue et versionStr. #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | major | integer | Le numéro de version principal. | | minor | entier | Le numéro de version mineure. | | patch | entier | Le numéro de version du correctif. | | revision | entier | Le numéro de révision. | | extended | chaîne | La chaîne étendue. | | versionStr | chaîne | Concaténation des numéros majeurs, mineurs, de correctifs et de révisions du formulaire. major.minor.patch\$1build.revision | ### (constante) ScreenshotError  : [ScreenshotErrorCode](#ScreenshotErrorCode) Les ScreenshotError codes énumèrent. #### Type : + [ScreenshotErrorCode](#ScreenshotErrorCode) ### (constante) WebcamError  : [WebcamErrorCode](#WebcamErrorCode) Les WebcamError codes énumèrent. #### Type : + [WebcamErrorCode](#WebcamErrorCode) ## Définitions de type et de rappel **Topics** + [AudioErrorCode](#AudioErrorCode) + [Rappels d'authentification](#authenticationCallbacks) + [AuthenticationErrorCode](#AuthenticationErrorCode) + [authErrorCallback(authentification, erreur)](#authErrorCallback) + [authPromptCredentialsRappel (authentification, défi)](#authPromptCredentialsCallback) + [authSuccessCallback(authentification, données d'authentification)](#authSuccessCallback) + [Channel](#Channel) + [ChannelErrorCode](#ChannelErrorCode) + [clipboardEventCallback(événement)](#clipboardEventCallback) + [ClosingReasonErrorCode](#ClosingReasonErrorCode) + [Espace colorimétrique](#Colorspace) + [Rappels de connexion](#connectionCallbacks) + [ConnectionConfig](#ConnectionConfig) + [ConnectionErrorCode](#ConnectionErrorCode) + [CreateDirectory (chemin)](#createDirectory) + [CustomChannelErrorCode](#CustomChannelErrorCode) + [dataChannelCallback(informations)](#dataChannelCallback) + [Supprimer le fichier (chemin)](#deleteFile) + [deviceChangeEventRappel ()](#deviceChangeEventCallback) + [DisconnectCallback (raison)](#disconnectCallback) + [displayAvailabilityCallback(statut, DisplayID)](#displayAvailabilityCallback) + [DisplayConfigErrorCode](#DisplayConfigErrorCode) + [displayLayoutCallback(largeur du serveur, hauteur du serveur, têtes)](#displayLayoutCallback) + [fonctionnalité](#feature) + [featuresUpdateCallback(Liste des fonctionnalités)](#featuresUpdateCallback) + [fileDownloadCallback(Ressource de fichiers)](#fileDownloadCallback) + [filePrintedCallback(Ressource d'impression)](#filePrintedCallback) + [stockage de fichiers](#filestorage) + [filestorageEnabledCallback(activé)](#filestorageEnabledCallback) + [FileStorageErrorCode](#FileStorageErrorCode) + [firstFrameCallback(Redimensionné activé, relativeMouseMode activé, DisplayID)](#firstFrameCallback) + [idleWarningNotificationRappel () disconnectionDateTime](#idleWarningNotificationCallback) + [collaboratorListCallback(collaborateurs)](#collaboratorListCallback) + [licenseNotificationCallback(notification)](#licenseNotificationCallback) + [liste (chemin)](#list) + [LogLevel](#LogLevel) + [Surveillance](#Monitor) + [MultiMonitorErrorCode](#MultiMonitorErrorCode) + [qualityIndicatorStateRappel (état)](#qualityIndicatorStateCallback) + [Renommer le répertoire (src, dest)](#renameDirectory) + [Renommer le fichier (src, dest)](#renameFile) + [ResolutionErrorCode](#ResolutionErrorCode) + [RetrieveFile (chemin)](#retrieveFile) + [ScreenshotCallback (capture d'écran)](#screenshotCallback) + [ScreenshotErrorCode](#ScreenshotErrorCode) + [Informations sur le serveur](#serverInfo) + [stats](#stats) + [StoreFile (fichier, répertoire)](#storeFile) + [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) + [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) + [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) + [WebcamErrorCode](#WebcamErrorCode) + [httpExtraSearchParamsCallback(méthode, URL, corps)](#httpExtraSearchParamsCallback) + [httpExtraHeadersRappel (méthode, URL, corps)](#httpExtraHeadersCallback) ### AudioErrorCode Les AudioError énumérations de code disponibles dans le module DCV + `SETTING_AUDIO_FAILED` + `CHANNEL_NOT_AVAILABLE` #### Type : + number ### Rappels d'authentification Rappels d'authentification #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | promptCredentials | [authPromptCredentialsRappel](#authPromptCredentialsCallback) | La fonction de rappel à appeler lorsque l'utilisateur est invité à fournir des informations d'identification. | | error | [authErrorCallback](#authErrorCallback) | La fonction de rappel à appeler en cas d'échec de l'authentification. | | success | [authSuccessCallback](#authSuccessCallback) | La fonction de rappel à appeler en cas de réussite de l'authentification. | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | Fonction de rappel à appeler dans la authenticate méthode pour injecter des paramètres de requête personnalisés dans l'URL d'authentification avant de lancer la demande. Il peut également être utilisé dans la connect méthode pour personnaliser l'URL utilisée lors de l'établissement d'une WebSocket connexion au serveur DCV. | ### AuthenticationErrorCode Les AuthenticationError énumérations de code disponibles dans le module 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` #### Type : + number ### authErrorCallback(authentification, erreur) La fonction de rappel à appeler en cas d'échec de l'authentification. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | authentication | [Authentification](authentication-class.md) | L'objet Authentication. | | error | Objet | L'objet d'erreur généré par le processus d'authentification. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | code | [AuthenticationErrorCode](#AuthenticationErrorCode) | Code de l’erreur. | | message | chaîne | Message d’erreur. | ### authPromptCredentialsRappel (authentification, défi) La fonction de rappel à appeler lorsque l'utilisateur est invité à fournir des informations d'identification. L'utilisateur doit répondre au défi en fournissant les informations d'identification demandées. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | authentication | [Authentification](authentication-class.md) | L'objet Authentication. | | challenge | Objet | Le défi. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | requiredCredentials | Matrice. | Un tableau d'objets d'identification demandés. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | name | chaîne | Le nom de l'identifiant demandé. | | type | chaîne | Type de l'identifiant demandé. | ### authSuccessCallback(authentification, données d'authentification) La fonction de rappel à appeler en cas de réussite de l'authentification. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | authentication | [Authentification](authentication-class.md) | L'objet Authentication. | | authenticationData | Matrice. | Un ensemble d'objets qui incluent des jetons de session IDs et d'authentification Amazon DCV. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | sessionId | chaîne | L'identifiant de session Amazon DCV. | | authToken | chaîne | Le jeton d'authentification pour la session Amazon DCV. | ### Channel Les canaux disponibles qui peuvent être spécifiés. #### Type : + « presse-papiers » \$1 « affichage » \$1 « entrée » \$1 « audio » \$1 « stockage de fichiers » ### ChannelErrorCode Les ChannelError énumérations de code disponibles dans le module DCV + `ALREADY_OPEN` + `INITIALIZATION_FAILED` + `REJECTED` #### Type : + number ### clipboardEventCallback(événement) La fonction de rappel à appeler lorsqu'un `clipboardEvent` est généré. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Attributes | Description | | --- | --- | --- | --- | | event | Objet | Informations sur l'événement Clipboard. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | name | établi \$1 copier \$1 coller \$1 \$1 \$1 dataSizeAlert \$1 autoCopyDone newDataAvailable \$1 autoPasteDone RemoteError \$1 pasteAvailableData | | Toujours présent. Nom de l’événement. | | clipboardData | Objet \$1 chaîne | | Les données du presse-papiers. | | autoCopy | boolean | | Indique si la copie automatique du presse-papiers de session vers le presse-papiers du client local est activée. | | maxDataSize | number | | La quantité maximale de données pouvant être placées dans le presse-papiers. | | error | chaîne | | Informations sur les erreurs, le cas échéant. | ### ClosingReasonErrorCode Les ClosingReasonError énumérations de code disponibles dans le module 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` #### Type : + number ### Espace colorimétrique Les espaces colorimétriques disponibles qui peuvent être spécifiés. #### Type : + « RGB » \$1 « YUV\$1 » \$1 REC601 « YUV\$1 » REC709 ### Rappels de connexion Les rappels disponibles pour être appelés en cas d'erreur de connexion. #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | disconnect | [Déconnecter le rappel](#disconnectCallback) | La fonction de rappel à appeler à la fin de la connexion. | | displayLayout | [displayLayoutCallback](#displayLayoutCallback) | La fonction de rappel à appeler lorsque la disposition ou la résolution de l'affichage est modifiée. | | displayAvailability | [displayAvailabilityCallback](#displayAvailabilityCallback) | La fonction de rappel à appeler lorsque la disponibilité d'un écran change. | | firstFrame | [firstFrameCallback](#firstFrameCallback) | La fonction de rappel à appeler lorsque la première trame est reçue du serveur Amazon DCV. | | filePrinted | [filePrintedCallback](#filePrintedCallback) | La fonction de rappel à appeler lorsqu'un fichier est imprimé sur le serveur Amazon DCV. | | fileDownload | [fileDownloadCallback](#fileDownloadCallback) | Fonction de rappel à appeler lorsqu'un fichier est prêt à être téléchargé depuis le serveur Amazon DCV. | | dataChannel | [dataChannelCallback](#dataChannelCallback) | Fonction de rappel à appeler lorsque le serveur Amazon DCV envoie une notification concernant la disponibilité d'un canal de données. | | licenseNotification | [licenseNotificationCallback](#licenseNotificationCallback) | La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie une notification concernant l'état de la licence. | | idleWarningNotification | [idleWarningNotificationRappel](#idleWarningNotificationCallback) | La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie un avertissement de délai d'inactivité. | | collaboratorList | [collaboratorListCallback](#collaboratorListCallback) | La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie la liste des collaborateurs (depuis la version 1.1.0 du SDK Amazon DCV Web Client). | | qualityIndicatorState | [qualityIndicatorStateRappel](#qualityIndicatorStateCallback) | La fonction de rappel à appeler lorsque l'indicateur de qualité de connexion change d'état. | | filestorageEnabled | [filestorageEnabledCallback](#filestorageEnabledCallback) | La fonction de rappel à appeler lorsque le stockage de fichiers est activé ou désactivé. | | featuresUpdate | [featuresUpdateCallback](#featuresUpdateCallback) | La fonction de rappel à appeler lorsque le statut d'une fonctionnalité change. | | clipboardEvent | [clipboardEventCallback](#clipboardEventCallback) | La fonction de rappel à appeler lorsqu'un clipboardEvent est généré. | | deviceChangeEvent | [deviceChangeEventRappel](#deviceChangeEventCallback) | La fonction de rappel à appeler lorsqu'un deviceChange événement est déclenché. | | screenshot | [Rappel de capture d'écran](#screenshotCallback) | La fonction de rappel à appeler lorsqu'un screenshot est disponible. | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | La fonction de rappel à appeler pour personnaliser l'URL lors de l'établissement d'une WebSocket connexion au serveur Amazon DCV. Notez que ce rappel peut également être utilisé avec la authenticate méthode pour ajouter dynamiquement des paramètres de requête à l'URL d'authentification avant que le SDK n'envoie la demande. | | httpExtraHeadersCallback | [httpExtraHeadersRappel](#httpExtraHeadersCallback) | La fonction de rappel à appeler pour ajouter des en-têtes personnalisés à la requête HTTP lors de l'établissement de la connexion. | ### ConnectionConfig Configuration pour une connexion Amazon DCV. #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | url | chaîne | Le nom d'hôte et le port du serveur Amazon DCV en cours d'exécution au format suivant :https://dcv\$1host\$1address:port. Par exemple : https://my-dcv-server:8443. | | sessionId | chaîne | L'identifiant de session Amazon DCV. | | authToken | chaîne | Le jeton d'authentification à utiliser lors de la connexion au serveur. | | baseUrl | chaîne | URL absolue ou relative à partir de laquelle charger les fichiers du SDK. | | resourceBaseUrl | chaîne | URL absolue ou relative à partir de laquelle accéder aux ressources DCV. | | enabledChannels | Matrice. < [Chaîne](#Channel) > | Indique la liste des canaux qui peuvent être activés. S'il n'est pas spécifié ou si un tableau vide est fourni, tous les canaux disponibles sont utilisés par défaut. | | losslessColorspace | [Espace colorimétrique](#Colorspace) | Indique l'espace colorimétrique qui sera utilisé. S'il n'est pas spécifié, la valeur par défaut est « RGB ». | | divId | chaîne | L'ID de l'divobjet dans le DOM HTML où le SDK doit créer le canevas avec le flux distant. | | volumeLevel | entier | Le niveau de volume préféré. La plage valide est comprise entre 0 et 100. | | clipboardAutoSync | boolean | Indique si la copie automatique depuis le presse-papiers de session Amazon DCV vers le presse-papiers du client local est activée pour les navigateurs Web compatibles. | | dynamicAudioTuning | boolean | Indique s'il faut régler dynamiquement le son en fonction des paramètres audio du serveur Amazon DCV lorsqu'une connexion est établie. | | clientHiDpiScaling | boolean | Indique s'il faut redimensionner le canevas en fonction du DPI du client. | | highColorAccuracy | boolean | Indique si une haute précision des couleurs doit être utilisée, le cas échéant. S'il n'est pas spécifié, la valeur par défaut est. false | | enableWebCodecs | Booléen | Indique s'il WebCodecs convient de l'utiliser si disponible. La valeur par défaut est false si elle n'est pas précisée. | | observers | [Rappels de connexion](#connectionCallbacks) | Les fonctions de rappel pour appeler les événements liés à la connexion. | | callbacks | [Rappels de connexion](#connectionCallbacks) | Identique à la observers propriété, mais chaque rappel inclut l'objet [Connection](connection-class.md) comme premier paramètre. | ### ConnectionErrorCode Les ConnectionError énumérations de code disponibles dans le module DCV + `ALREADY_OPEN` + `INVALID_CONFIG` + `INITIALIZATION_FAILED` + `REJECTED` + `MAIN_CHANNEL_ALREADY_OPEN` + `GENERIC_ERROR`(depuis DCV Server 2021.0) + `INTERNAL_SERVER_ERROR`(depuis DCV Server 2021.0) + `AUTHENTICATION_FAILED`(depuis DCV Server 2021.0) + `PROTOCOL_ERROR`(depuis DCV Server 2021.0) + `INVALID_SESSION_ID`(depuis DCV Server 2021.0) + `INVALID_CONNECTION_ID`(depuis DCV Server 2021.0) + `CONNECTION_LIMIT_REACHED`(depuis DCV Server 2021.0) + `SERVER_UNREACHABLE`(depuis DCV Server 2022.1) + `GATEWAY_BUSY` + `UNSUPPORTED_CREDENTIAL`(depuis DCV Server 2022.2) + `TRANSPORT_ERROR` #### Type : + number ### CreateDirectory (chemin) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | path | chaîne | Le chemin absolu sur le serveur où nous voulons créer un répertoire. Il doit également inclure le nom du répertoire cible. | ### CustomChannelErrorCode Les CustomChannelError énumérations de code disponibles dans le module DCV + `TRANSPORT_ERROR` #### Type : + number ### dataChannelCallback(informations) Fonction de rappel à appeler lorsque le serveur Amazon DCV envoie une notification concernant la disponibilité d'un canal de données. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | info | Objet | Informations sur le canal de données. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | name | chaîne | Nom du canal de données. | | token | chaîne | Le jeton d'authentification pour le canal de données. | ### Supprimer le fichier (chemin) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | path | chaîne | Le chemin absolu sur le serveur identifiant le fichier que nous voulons supprimer. | ### deviceChangeEventRappel () La fonction de rappel à appeler lorsqu'un `deviceChange` événement est déclenché. ### DisconnectCallback (raison) La fonction de rappel à appeler à la fin de la connexion. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | reason | Objet | La raison de la déconnexion. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | code | nombre | Le code de raison. | | message | chaîne | Le message du motif. | ### displayAvailabilityCallback(statut, DisplayID) La fonction de rappel à appeler lorsque la disponibilité d'un écran change. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | status | Objet | État de l'affichage. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | displayId | number | Identifiant de l'écran. | | enabled | booléen | Indique si l'affichage est activé. | | closed | boolean | Indique si l'écran est fermé. | ### DisplayConfigErrorCode Les DisplayConfigError énumérations de code disponibles dans le module DCV + `INVALID_ARGUMENT` + `UNSUPPORTED_OPERATION` + `NO_CHANNEL` #### Type : + number ### displayLayoutCallback(largeur du serveur, hauteur du serveur, têtes) La fonction de rappel à appeler lorsque la disposition ou la résolution de l'affichage est modifiée. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | serverWidth | nombre | Largeur (en pixels) de l'écran principal. | | serverHeight | number | Hauteur (en pixels) de l'écran principal. | | heads | Matrice. < [Moniteur](#Monitor) > | Les têtes d'affichage prises en charge par le serveur Amazon DCV. | ### fonctionnalité Les valeurs des fonctionnalités. + `display`- Indique la disponibilité d'un flux vidéo à affichage unique. + `display-multi`- Indique la disponibilité d'un flux vidéo multi-écrans. + `high-color-accuracy`- Indique la disponibilité d'une haute précision des couleurs (depuis la version 1.1.0 du SDK Amazon DCV Web Client). + `mouse`- Indique la disponibilité des fonctionnalités de la souris. + `keyboard`- Indique la disponibilité des fonctionnalités du clavier. + `keyboard-sas`- Indique la disponibilité de la fonctionnalité de séquence SAS (Control \$1 Alt \$1 Delete). + `relative-mouse`- Indique la disponibilité du mode souris relatif. + `clipboard-copy`- Indique la disponibilité de la fonctionnalité de copie du presse-papiers depuis le serveur Amazon DCV vers le client. + `clipboard-paste`- Indique la disponibilité de la fonctionnalité de collage dans le presse-papiers entre le client et le serveur Amazon DCV. + `audio-in`- Indique la disponibilité de la fonctionnalité d'entrée audio à l'aide du microphone. + `audio-out`- Indique la disponibilité de la fonctionnalité de lecture audio. + `webcam`- Indique la disponibilité de la fonctionnalité de streaming par webcam. + `file-download`- Indique la disponibilité de la fonctionnalité de téléchargement de fichiers depuis le serveur Amazon DCV vers le client. + `file-upload`- Indique la disponibilité de la fonctionnalité de téléchargement de fichiers depuis le client vers le serveur Amazon DCV. + `timezone-redirection`- Indique la disponibilité de la fonctionnalité de redirection de fuseau horaire (depuis la version 1.3.0 du SDK Amazon DCV Web Client). #### Type : + chaîne ### featuresUpdateCallback(Liste des fonctionnalités) La fonction de rappel à appeler lorsque le statut d'une fonctionnalité change. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | featuresList | Matrice. < [fonctionnalité](#feature) > | Un ensemble de fonctionnalités qui ont changé. | ### fileDownloadCallback(Ressource de fichiers) Fonction de rappel à appeler lorsqu'un fichier est prêt à être téléchargé depuis le serveur Amazon DCV. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | fileResource | Objet | Informations sur le fichier prêt à être téléchargé. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | id | chaîne | Identifiant du fichier. | | url | chaîne | URL à utiliser pour télécharger le fichier. | | domain | chaîne | Le domaine des ressources. | | token | chaîne | Le jeton d'authentification à utiliser pour télécharger le fichier. Le jeton est également inclus dans l'URL. | ### filePrintedCallback(Ressource d'impression) La fonction de rappel à appeler lorsqu'un fichier est imprimé sur le serveur Amazon DCV. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | printResource | Objet | Informations sur le fichier imprimé. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | id | chaîne | Identifiant du fichier imprimé. | | url | chaîne | URL à utiliser pour télécharger le fichier imprimé. | | domain | chaîne | Le domaine des ressources. Dans ce cas,printer. | | token | chaîne | Le jeton d'authentification à utiliser pour télécharger le fichier imprimé. Le jeton est également inclus dans l'URL. | ### stockage de fichiers Objet qui permet d'explorer et d'exécuter des actions sur le système de fichiers. #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | list | [liste](#list) | Fonction qui permet de répertorier les éléments (fichiers et répertoires) présents sur le chemin fourni sur le serveur. | | createDirectory | [Créer un répertoire](#createDirectory) | Fonction qui permet de créer un répertoire au chemin spécifié sur le serveur. | | retrieveFile | [Récupérer le fichier](#retrieveFile) | Fonction qui permet de télécharger localement un fichier au chemin spécifié sur le serveur. | | deleteFile | [Supprimer le fichier](#deleteFile) | Fonction qui permet de supprimer un fichier au chemin indiqué sur le serveur. | | renameFile | [Renommer le fichier](#renameFile) | Fonction qui permet de renommer un fichier du chemin source spécifié vers le chemin de destination spécifié. | | renameDirectory | [Renommer le répertoire](#renameDirectory) | Fonction qui permet de renommer un répertoire depuis le chemin source spécifié vers le chemin de destination absolu. | | storeFile | [Stocker le fichier](#storeFile) | Fonction qui permet de télécharger un fichier local sur le chemin fourni sur le serveur. | ### filestorageEnabledCallback(activé) La fonction de rappel à appeler lorsque le stockage de fichiers est activé. Lazy channel sur Internet Explorer 11 uniquement. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | enabled | booléen | Indique si le stockage de fichiers est activé. | ### FileStorageErrorCode Les FileStorageError énumérations de code disponibles dans le module DCV + `CANCELLED` + `ABORTED` + `INVALID_ARGUMENT` + `NOT_IMPLEMENTED` + `ERROR` + `ALREADY_EXIST` + `NOT_FOUND` #### Type : + number ### firstFrameCallback(Redimensionné activé, relativeMouseMode activé, DisplayID) La fonction de rappel à appeler lorsque la première trame est reçue du serveur Amazon DCV. Émis pour chaque écran. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | resizeEnabled | booléen | Indique si le serveur prend en charge le redimensionnement de la disposition d'affichage du client. | | relativeMouseModeEnabled | boolean | Indique si le serveur prend en charge le mode souris relatif. | | displayId | number | Identifiant de l'écran. | ### idleWarningNotificationRappel () disconnectionDateTime La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie un avertissement de délai d'inactivité. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | disconnectionDateTime | Date | Date et heure de la déconnexion. | ### collaboratorListCallback(collaborateurs) La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie la liste des collaborateurs. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | collaborators | Matrice. | Liste d'objets contenant des informations sur les collaborateurs. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | username | chaîne | Le nom d'utilisateur du collaborateur. | | owner | boolean | Indique si le collaborateur est le propriétaire de la session. | | connectionId | number | Indique l'ID attribué par le serveur à la connexion. | ### licenseNotificationCallback(notification) La fonction de rappel à appeler lorsque le serveur Amazon DCV envoie une notification concernant l'état de la licence. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | notification | Objet | La notification. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | product | chaîne | Le produit DCV. | | status | chaîne | État de la licence. | | message | chaîne | Un message. | | leftDays | number | Nombre de jours avant l'expiration de la licence. | | isDemo | boolean | Indique s'il s'agit d'une licence de démonstration. | | numUnlicensed | number | Le nombre de connexions sans licence. | | licensingMode | chaîne | Le mode de licence. | | documentationUrl | chaîne | URL de la documentation. | ### liste (chemin) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | path | chaîne | Le chemin absolu sur le serveur dont nous voulons répertorier le contenu. | ### LogLevel Les niveaux de journalisation du SDK disponibles. #### Type : + TRACE \$1 DEBUG \$1 INFO \$1 AVERTIR \$1 ERREUR \$1 SILENCIEUX ### Surveillance #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | name | chaîne | Nom de la tête d'affichage. | | rect | Objet | Informations sur la tête d'affichage. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | primary | boolean | Indique si la tête d'affichage est la tête d'affichage principale. Ceci est déterminé à partir du système d'exploitation distant s'il est disponible. | | dpi | number | Le DPI de la tête d'affichage. | | x | nombre | xCoordonnée initiale de la tête d'affichage. | | y | number | yCoordonnée initiale de la tête d'affichage. | | width | number | Largeur (en pixels) de la tête d'affichage. | | height | number | Hauteur (en pixels) de la tête d'affichage. | ### MultiMonitorErrorCode Les MultiMonitorError énumérations de code disponibles dans le module DCV + `NO_DISPLAY_CHANNEL` + `MAX_DISPLAY_NUMBER_REACHED` + `INVALID_ARGUMENT` + `DISPLAY_NOT_OPENED_BY_SERVER` + `REQUEST_TIMEOUT` + `GENERIC_ERROR` + `NO_ERROR` #### Type : + number ### qualityIndicatorStateRappel (état) La fonction de rappel à appeler lorsque l'indicateur de qualité de connexion change d'état. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | state | Matrice. | Informations sur la qualité de la connexion. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | name | chaîne | Le nom de l'indicateur. | | status | NORMAL \$1 AVERTISSEMENT \$1 CRITIQUE | Description du statut | | changed | boolean | Indique si le statut a changé. | ### Renommer le répertoire (src, dest) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | src | chaîne | Le chemin source absolu sur le serveur identifiant le répertoire que nous voulons renommer. | | dest | chaîne | Le chemin de destination absolu sur le serveur spécifiant le chemin cible et le nom du répertoire. | ### Renommer le fichier (src, dest) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | src | chaîne | Le chemin source absolu sur le serveur identifiant le fichier que nous voulons renommer. | | dest | chaîne | Le chemin de destination absolu sur le serveur spécifiant le chemin cible et le nom du fichier. | ### ResolutionErrorCode Les ResolutionError énumérations de code disponibles dans le module DCV + `INVALID_ARGUMENT` + `NO_CHANNEL` + `NOT_IMPLEMENTED` #### Type : + number ### RetrieveFile (chemin) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | path | chaîne | Le chemin absolu sur le serveur identifiant le fichier que nous voulons télécharger localement. | ### ScreenshotCallback (capture d'écran) La fonction de rappel à appeler lorsqu'une capture d'écran est disponible. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | screenshot | byte[] | Mémoire tampon de capture d'écran au format PNG, ou en null cas d'échec de la récupération de la capture d'écran. | ### ScreenshotErrorCode Les ScreenshotError énumérations de code disponibles dans le module DCV + `NO_CHANNEL` + `GENERIC_ERROR` #### Type : + number ### Informations sur le serveur #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | Nom | Type | Description | | --- | --- | --- | | name | chaîne | Le nom du logiciel. | | version | Objet | Le numéro de version du logiciel. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/dcv/latest/websdkguide/dcv-module.html) | | os | chaîne | Le système d'exploitation. | | arch | chaîne | L'architecture. | | hostname | chaîne | Le nom d'hôte. | | major | nombre | Le numéro de version principal. | | minor | number | Le numéro de version mineure. | | revision | number | Le numéro de version de la révision. | ### stats #### Type : + Objet #### Propriétés : | Nom | Type | Description | | --- | --- | --- | | fps | nombre | Le nombre actuel d'images par seconde. | | traffic | number | Trafic actuel en bits/s. | | peakTraffic | number | Le pic de trafic bit/s depuis l'établissement de la connexion. | | latency | number | La latence actuelle en ms. | | currentChannels | number | Le nombre de canaux ouverts depuis l'établissement de la connexion. | | openedChannels | number | Le nombre de chaînes actuellement ouvertes. | | channelErrors | number | Le nombre de chaînes qui ont signalé une erreur. | ### StoreFile (fichier, répertoire) #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | file | Fichier | L'objet du fichier (pour plus d'informations, voir https://developer.mozilla. org/en-US/docs/Web/API/File) que nous voulons télécharger sur le serveur. | | dir | chaîne | Le chemin absolu sur le serveur sur lequel nous voulons télécharger le fichier. | ### TimezoneRedirectionErrorCode Les TimezoneRedirectionError énumérations de code disponibles dans le module DCV + `INVALID_ARGUMENT` + `NO_CHANNEL` + `USER_CANNOT_CHANGE` #### Type : + number ### TimezoneRedirectionSettingCode Les TimezoneRedirectionSetting énumérations de code disponibles dans le module DCV + `ALWAYS_OFF` + `ALWAYS_ON` + `CLIENT_DECIDES` #### Type : + number ### TimezoneRedirectionStatusCode Les TimezoneRedirectionStatus énumérations de code disponibles dans le module DCV + `SUCCESS` + `PERMISSION_ERROR` + `GENERIC_ERROR` #### Type : + number ### WebcamErrorCode Les WebcamError énumérations de code disponibles dans le module DCV + `SETTING_WEBCAM_FAILED` + `CHANNEL_NOT_AVAILABLE` #### Type : + number ### httpExtraSearchParamsCallback(méthode, URL, corps) La fonction de rappel à appeler pour injecter des paramètres de requête personnalisés URLs lors de l'authentification et de l'établissement de la connexion. Cela permet des scénarios d'intégration avancés, notamment la possibilité d'ajouter des paramètres de requête personnalisés et d'ajouter des valeurs signées AWS Signature Version 4 (SigV4) pour sécuriser et autoriser les connexions via des systèmes externes. Ce rappel est également utilisé pour personnaliser l'URL utilisée lors de l'établissement d'une WebSocket connexion au serveur Amazon DCV. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | method | chaîne | Méthode HTTP utilisée pour la demande. | | url | chaîne | URL qui sera utilisée pour la demande. | | body | chaîne | Le contenu du corps de requête. | #### Renvoie: `URLSearchParams`objet contenant les paramètres de requête personnalisés à ajouter à l'URL. Type URLSearchParamètres ### httpExtraHeadersRappel (méthode, URL, corps) La fonction de rappel à appeler pour insérer des en-têtes personnalisés (tels que`Authorization`) dans la requête HTTP lors de l'établissement de la connexion. #### Paramètres : | Nom | Type | Description | | --- | --- | --- | | method | chaîne | Méthode HTTP utilisée pour la demande. | | url | chaîne | URL qui sera utilisée pour la demande. | | body | chaîne | Le contenu du corps de requête. | #### Renvoie: Objet contenant des paires clé-valeur représentant les en-têtes personnalisés à ajouter à la requête HTTP. Type Objet