DCVmodule - Amazon DCV
MéthodesMembersDéfinitions de type et de rappel

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.

DCVmodule

Module qui implémente le côté client du DCV protocole.

Méthodes

authentifier (URL, rappels) → {Authentification}

Démarre le processus d'authentification pour le point de terminaison DCV du serveur Amazon spécifié.

Paramètres :

Nom Type Description
url chaîne Le nom d'hôte et le port du DCV serveur Amazon en cours d'exécution au format suivant :https://dcv_host_address:port. olpPar exemple : https://my-dcv-server:8443.
callbacks authenticationCallbacks Les rappels disponibles pour être appelés pendant le processus d'authentification.

Renvoie:

- L'objet d'authentification.

Type

Authentification

connect (config) → {Promesse. < Connexion >|Promesse. < {code : ConnectionErrorCode, message : chaîne} >}

Se connecte au point de terminaison DCV du serveur Amazon 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 L' ConnectionConfig objet.

Renvoie:

- Un objet Connection ou un objet d'erreur.

Type

Promesse. < Connexion > | Promesse. < {code : ConnectionErrorCode, message : chaîne} >

setLogHandler(gestionnaire) → {void}

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), levelName (chaîne), le domaine (chaîne) et le message (chaîne).

Renvoie:

Type

void

setLogLevel(niveau) → {void}

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 Le niveau de journalisation à utiliser.

Renvoie:

Type

void

Members

(constante) AudioError : AudioErrorCode

Les AudioError codes énumèrent.

Type :

(constante) AuthenticationError : AuthenticationErrorCode

Les AuthenticationError codes énumèrent.

Type :

(constante) ChannelError : ChannelErrorCode

Les ChannelError codes énumèrent.

Type :

(constante) ClosingReasonError : ClosingReasonErrorCode

Les ClosingReasonError codes énumèrent.

Type :

(constante) ConnectionError : ConnectionErrorCode

Les ConnectionError codes énumèrent.

Type :

(constante) CustomChannelError : CustomChannelErrorCode

Les CustomChannelError codes énumèrent.

Type :

(constante) DisplayConfigError : DisplayConfigErrorCode

Les DisplayConfigError codes énumèrent.

Type :

(constante) FileStorageError : FileStorageErrorCode

Les FileStorageError codes énumèrent.

Type :

(constante) LogLevel : LogLevel

Les niveaux de SDK journalisation disponibles.

Type :

(constante) MultiMonitorError : MultiMonitorErrorCode

Les MultiMonitorError codes énumèrent.

Type :

(constante) ResolutionError : ResolutionErrorCode

Les ResolutionError codes énumèrent.

Type :

(constante) TimezoneRedirectionError : TimezoneRedirectionErrorCode

Les TimezoneRedirectionError codes énumèrent.

Type :

(constante) TimezoneRedirectionSetting : TimezoneRedirectionSettingCode

Les TimezoneRedirectionSetting codes énumèrent.

Type :

(constante) TimezoneRedirectionStatus : TimezoneRedirectionStatusCode

Les TimezoneRedirectionStatus codes énumèrent.

Type :

version (constante)

La DCV version Amazon avec version majeure, mineure, correctif, révision, étendue etversionStr.

Propriétés

Nom Type Description
major integer Numéro de version principale.
minor entier Numéro de version mineure.
patch entier 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+build.revision

(constante) ScreenshotError : ScreenshotErrorCode

Les ScreenshotError codes énumèrent.

Type :

(constante) WebcamError : WebcamErrorCode

Les WebcamError codes énumèrent.

Type :

Définitions de type et de rappel

AudioErrorCode

Les AudioError énumérations de code disponibles dans le module DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Type :

  • nombre

authenticationCallbacks

Rappels d'authentification

Type :

  • Objet

Propriétés

Nom Type Description
promptCredentials authPromptCredentialsRappel La fonction de rappel à appeler lorsque l'utilisateur est invité à fournir des informations d'identification.
error authErrorCallback La fonction de rappel à appeler en cas d'échec de l'authentification.
success authSuccessCallback La fonction de rappel à appeler en cas de réussite de l'authentification.

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 :

  • nombre

authErrorCallback(authentification, erreur)

La fonction de rappel à appeler en cas d'échec de l'authentification.

Paramètres :

Nom Type Description
authentication Authentification L'objet Authentication.
error Objet L'objet d'erreur généré par le processus d'authentification.
Nom Type Description
code 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
authentication Authentification L'objet Authentication.
challenge Objet Le défi.
Nom Type Description
requiredCredentials Matrice. <Object> Un tableau d'objets d'identification demandés.
Nom Type Description
name chaîne Le nom de l'identifiant demandé.
type chaîne Type de l'identifiant demandé.

authSuccessCallback(authentification,authenticationData)

La fonction de rappel à appeler en cas de réussite de l'authentification.

Paramètres :

Nom Type Description
authentication Authentification L'objet Authentication.
authenticationData Matrice. <Object> Un ensemble d'objets qui incluent des jetons de DCV session IDs et d'authentification Amazon.
Nom Type Description
sessionId chaîne L'identifiant de DCV session Amazon.
authToken chaîne Le jeton d'authentification pour la DCV session Amazon.

Canal

Les canaux disponibles qui peuvent être spécifiés.

Type :

  • « presse-papiers » | « affichage » | « entrée » | « audio » | « stockage de fichiers »

ChannelErrorCode

Les ChannelError énumérations de code disponibles dans le module DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Type :

  • nombre

clipboardEventCallback(événement)

La fonction de rappel à appeler lorsqu'un clipboardEvent est généré.

Paramètres :

Nom Type Description
event Objet Informations sur l'événement Clipboard.
Nom Type Attributs Description
name établi | copier | coller dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData Toujours présent. Nom de l’événement.
clipboardData Objet | chaîne Les données du presse-papiers.
autoCopy boolean <optional> Indique si la copie automatique du presse-papiers de session vers le presse-papiers du client local est activée.
maxDataSize nombre <optional> La quantité maximale de données pouvant être placées dans le presse-papiers.
error chaîne <optional> 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 :

  • nombre

Espace colorimétrique

Les espaces colorimétriques disponibles qui peuvent être spécifiés.

Type :

  • « RGB » | « YUV _ REC6 01" | « YUV _ REC7 09"

connectionCallbacks

Les rappels disponibles pour être appelés en cas d'erreur de connexion.

Type :

  • Objet

Propriétés

Nom Type Description
disconnect disconnectCallback La fonction de rappel à appeler à la fin de la connexion.
displayLayout displayLayoutCallback La fonction de rappel à appeler lorsque la disposition ou la résolution de l'affichage est modifiée.
displayAvailability displayAvailabilityCallback La fonction de rappel à appeler lorsque la disponibilité d'un écran change.
firstFrame firstFrameCallback La fonction de rappel à appeler lorsque la première trame est reçue du DCV serveur Amazon.
filePrinted filePrintedCallback La fonction de rappel à appeler lorsqu'un fichier est imprimé sur le DCV serveur Amazon.
fileDownload fileDownloadCallback La fonction de rappel à appeler lorsqu'un fichier est prêt à être téléchargé depuis le DCV serveur Amazon.
dataChannel dataChannelCallback La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie une notification concernant la disponibilité d'un canal de données.
licenseNotification licenseNotificationCallback La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie une notification concernant l'état de la licence.
idleWarningNotification idleWarningNotificationRappel La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie un avertissement d'expiration du délai d'inactivité.
collaboratorList collaboratorListCallback La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie la liste des collaborateurs (depuis Amazon DCV Web Client SDK version 1.1.0).
qualityIndicatorState qualityIndicatorStateRappel La fonction de rappel à appeler lorsque l'indicateur de qualité de connexion change d'état.
filestorageEnabled filestorageEnabledCallback La fonction de rappel à appeler lorsque le stockage de fichiers est activé ou désactivé.
featuresUpdate featuresUpdateCallback La fonction de rappel à appeler lorsque le statut d'une fonctionnalité change.
clipboardEvent clipboardEventCallback La fonction de rappel à appeler lorsqu'un clipboardEvent est généré.
deviceChangeEvent deviceChangeEventRappel La fonction de rappel à appeler lorsqu'un deviceChange événement est déclenché.
screenshot screenshotCallback La fonction de rappel à appeler lorsqu'un screenshot est disponible.

ConnectionConfig

La configuration d'une DCV connexion Amazon.

Type :

  • Objet

Propriétés

Nom Type Description
url chaîne Le nom d'hôte et le port du DCV serveur Amazon en cours d'exécution au format suivant :https://dcv_host_address:port. olpPar exemple : https://my-dcv-server:8443.
sessionId chaîne L'identifiant de DCV session Amazon.
authToken chaîne Le jeton d'authentification à utiliser lors de la connexion au serveur.
baseUrl chaîne Valeur absolue ou relative URL à partir de laquelle les SDK fichiers doivent être chargés.
resourceBaseUrl chaîne Valeur absolue ou relative URL à partir de laquelle accéder aux DCV ressources.
enabledChannels Matrice. < Chaîne > 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 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 champ HTML DOM where 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 DCV session Amazon 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 DCV du serveur Amazon lorsqu'une connexion est établie.
clientHiDpiScaling boolean Indique s'il faut redimensionner le canevas en fonction de celui du clientDPI.
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 connectionCallbacks Les fonctions de rappel pour appeler les événements liés à la connexion.
callbacks connectionCallbacks Identique à la observers propriété, mais chaque rappel inclut l'objet Connection 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 :

  • nombre

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 :

  • nombre

dataChannelCallback(informations)

La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie une notification concernant la disponibilité d'un canal de données.

Paramètres :

Nom Type Description
info Objet Informations sur le canal de données.
Nom Type Description
name chaîne Nom du canal de données.
token chaîne Le jeton d'authentification pour le canal de données.

deleteFile(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
reason Objet La raison de la déconnexion.
Nom Type Description
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
status Objet État de l'affichage.
Nom Type Description
enabled boolean Indique si l'affichage est activé.
closed boolean Indique si l'écran est fermé.
displayId nombre Identifiant de l'écran.

DisplayConfigErrorCode

Les DisplayConfigError énumérations de code disponibles dans le module DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Type :

  • nombre

displayLayoutCallback(serverWidthserverHeight, 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 nombre Hauteur (en pixels) de l'écran principal.
heads Matrice. < Moniteur > Les têtes d'affichage prises en charge par le DCV serveur Amazon.

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 SDK version 1.1.0 d'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 SAS séquence (Control + Alt + Delete).

  • relative-mouse- Indique la disponibilité du mode souris relatif.

  • clipboard-copy- Indique la disponibilité de la fonctionnalité de copie du presse-papiers entre le DCV serveur Amazon et le client.

  • clipboard-paste- Indique la disponibilité de la fonctionnalité de collage dans le presse-papiers entre le client et le DCV serveur Amazon.

  • 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 DCV serveur Amazon vers le client.

  • file-upload- Indique la disponibilité de la fonctionnalité de téléchargement de fichiers depuis le client vers le DCV serveur Amazon.

  • timezone-redirection- Indique la disponibilité de la fonctionnalité de redirection de fuseau horaire (depuis la SDK version 1.3.0 d'Amazon DCV Web Client).

Type :

  • chaîne

featuresUpdateCallback(featuresList)

La fonction de rappel à appeler lorsque le statut d'une fonctionnalité change.

Paramètres :

Nom Type Description
featuresList Matrice. < fonctionnalité > Un ensemble de fonctionnalités qui ont changé.

fileDownloadCallback(fileResource)

La fonction de rappel à appeler lorsqu'un fichier est prêt à être téléchargé depuis le DCV serveur Amazon.

Paramètres :

Nom Type Description
fileResource Objet Informations sur le fichier prêt à être téléchargé.
Nom Type Description
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 leURL.

filePrintedCallback(printResource)

La fonction de rappel à appeler lorsqu'un fichier est imprimé sur le DCV serveur Amazon.

Paramètres :

Nom Type Description
printResource Objet Informations sur le fichier imprimé.
Nom Type Description
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 leURL.

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 Fonction qui permet de répertorier les éléments (fichiers et répertoires) présents sur le chemin fourni sur le serveur.
createDirectory createDirectory Fonction qui permet de créer un répertoire au chemin spécifié sur le serveur.
retrieveFile retrieveFile Fonction qui permet de télécharger localement un fichier au chemin spécifié sur le serveur.
deleteFile deleteFile Fonction qui permet de supprimer un fichier au chemin indiqué sur le serveur.
renameFile renameFile Fonction qui permet de renommer un fichier du chemin source spécifié vers le chemin de destination spécifié.
renameDirectory renameDirectory Fonction qui permet de renommer un répertoire depuis le chemin source spécifié vers le chemin de destination absolu.
storeFile 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 boolean 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 :

  • nombre

firstFrameCallback(resizeEnabled, relativeMouseMode Activé,displayId)

La fonction de rappel à appeler lorsque la première trame est reçue du DCV serveur Amazon. Émis pour chaque écran.

Paramètres :

Nom Type Description
resizeEnabled boolean 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 nombre Identifiant de l'écran.

idleWarningNotificationRappel () disconnectionDateTime

La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie un avertissement d'expiration du 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 DCV serveur Amazon envoie la liste des collaborateurs.

Paramètres :

Nom Type Description
collaborators Matrice. <Object> Liste d'objets contenant des informations sur les collaborateurs.
Nom Type Description
username chaîne Le nom d'utilisateur du collaborateur.
owner boolean Indique si le collaborateur est le propriétaire de la session.
connectionId nombre Indique l'ID attribué par le serveur à la connexion.

licenseNotificationCallback(notification)

La fonction de rappel à appeler lorsque le DCV serveur Amazon envoie une notification concernant l'état de la licence.

Paramètres :

Nom Type Description
notification Objet La notification.
Nom Type Description
product chaîne Le DCV produit.
status chaîne État de la licence.
message chaîne Un message.
leftDays nombre Nombre de jours avant l'expiration de la licence.
isDemo boolean Indique s'il s'agit d'une licence de démonstration.
numUnlicensed nombre Le nombre de connexions sans licence.
licensingMode chaîne Le mode de licence.
documentationUrl chaîne Le URL pour 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 SDK journalisation disponibles.

Type :

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

Surveiller

Type :

  • Objet

Propriétés

Nom Type Description
name chaîne Nom de la tête d'affichage.
rect Objet Informations sur la tête d'affichage.
Nom Type Description
x nombre xCoordonnée initiale de la tête d'affichage.
y nombre yCoordonnée initiale de la tête d'affichage.
width nombre Largeur (en pixels) de la tête d'affichage.
height nombre Hauteur (en pixels) de la tête d'affichage.
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 nombre Celui DPI 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 :

  • nombre

qualityIndicatorStateRappel (état)

La fonction de rappel à appeler lorsque l'indicateur de qualité de connexion change d'état.

Paramètres :

Nom Type Description
state Matrice. <Object> Informations sur la qualité de la connexion.
Nom Type Description
name chaîne Nom de l'indicateur.
status NORMAL | WARNING | CRITICAL Description du statut.
changed boolean Indique si le statut a changé.

renameDirectory(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.

renameFile(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 :

  • nombre

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 PNG format, 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 :

  • nombre

serverInfo

Type :

  • Objet

Propriétés

Nom Type Description
name chaîne Le nom du logiciel.
version Objet Le numéro de version du logiciel.
Nom Type Description
major nombre Numéro de version principale.
minor nombre Numéro de version mineure.
revision nombre Le numéro de version de la révision.
os chaîne Le système d'exploitation.
arch chaîne L'architecture.
hostname chaîne Le nom d'hôte.

stats

Type :

  • Objet

Propriétés

Nom Type Description
fps nombre Le nombre actuel d'images par seconde.
traffic nombre Trafic actuel en bits/s.
peakTraffic nombre Pic de trafic en bits/s depuis l'établissement de la connexion.
latency nombre La latence actuelle en ms.
currentChannels nombre Le nombre de canaux ouverts depuis l'établissement de la connexion.
openedChannels nombre Le nombre de chaînes actuellement ouvertes.
channelErrors nombre Le nombre de chaînes qui ont signalé une erreur.

storeFile(fichier, répertoire)

Paramètres :

Nom Type Description
file Fichier L'objet 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 :

  • nombre

TimezoneRedirectionSettingCode

Les TimezoneRedirectionSetting énumérations de code disponibles dans le module DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Type :

  • nombre

TimezoneRedirectionStatusCode

Les TimezoneRedirectionStatus énumérations de code disponibles dans le module DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Type :

  • nombre

WebcamErrorCode

Les WebcamError énumérations de code disponibles dans le module DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Type :

  • nombre