Modulo DCV - NICE DCV
MetodiMembriDefinizioni di tipi e callback

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Modulo DCV

Un modulo che implementa il lato client del protocollo DCV.

Metodi

authenticate (url, callback) → {Autenticazione}

Avvia il processo di autenticazione per l'endpoint del server NICE DCV specificato.

Parametri:

Nome Type (Tipo) Descrizione
url string Il nome host e la porta del server NICE DCV in esecuzione nel seguente formato:https://dcv_host_address:port. Ad esempio: https://my-dcv-server:8443.
callbacks Richiamate di autenticazione I callback disponibili per essere chiamati durante il processo di autenticazione.

Valori restituiti:

- L'oggetto di autenticazione.

Type (Tipo)

Autenticazione

connect (configurazione) → {Promessa. < Connessione >|Promessa. < {code: ConnectionErrorCode, messaggio: string} >}

Si connette all'endpoint del server NICE DCV specificato. Se la connessione viene eseguita correttamente, restituisce un oggetto Connection. Se la connessione fallisce, restituisce un oggetto di errore.

Parametri:

Nome Type (Tipo) Descrizione
config ConnectionConfig L' ConnectionConfig oggetto.

Valori restituiti:

- Un oggetto Connection o un oggetto di errore.

Type (Tipo)

Promessa. < Connessione > | Promessa. < {code: ConnectionErrorCode, messaggio: stringa} >

setLogHandler(gestore) → {void}

Imposta una funzione di gestione dei log personalizzata. Quando si sovrascrive il gestore di registro predefinito, la posizione di immissione del registro originale verrà persa durante il debug con la console del browser.

Parametri:

Nome Type (Tipo) Descrizione
handler funzione La funzione di gestione dei log personalizzata. La funzione handler contiene level (numero), levelName (string), domain (string) e message (string).

Valori restituiti:

Type (Tipo)

void

setLogLevel(livello) → {void}

Imposta il livello di registro. Ciò è necessario solo se viene utilizzato il gestore di log predefinito.

Parametri:

Nome Type (Tipo) Descrizione
level LogLevel Il livello di log da usare.

Valori restituiti:

Type (Tipo)

void

Membri

(costante) AudioError: AudioErrorCode

I AudioError codici enum.

Type:

(costante) AuthenticationError: AuthenticationErrorCode

I AuthenticationError codici enum.

Type:

(costante) ChannelError: ChannelErrorCode

I ChannelError codici enum.

Type:

(costante) ClosingReasonError: ClosingReasonErrorCode

I ClosingReasonError codici enum.

Type:

(costante) ConnectionError: ConnectionErrorCode

I ConnectionError codici enum.

Type:

(costante) CustomChannelError: CustomChannelErrorCode

I CustomChannelError codici enum.

Type:

(costante) DisplayConfigError: DisplayConfigErrorCode

I DisplayConfigError codici enum.

Type:

(costante) FileStorageError: FileStorageErrorCode

I FileStorageError codici enum.

Type:

(costante) LogLevel: LogLevel

I livelli di registro SDK disponibili.

Type:

(costante) MultiMonitorError: MultiMonitorErrorCode

I MultiMonitorError codici enum.

Type:

(costante) ResolutionError: ResolutionErrorCode

I ResolutionError codici enum.

Type:

(costante) TimezoneRedirectionError: TimezoneRedirectionErrorCode

I TimezoneRedirectionError codici enum.

Type:

(costante) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

I TimezoneRedirectionSetting codici enum.

Type:

(costante) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

I TimezoneRedirectionStatus codici enum.

Type:

versione (costante)

La versione NICE DCV con versione principale, secondaria, patch, revisione, estesa e versionSTR.

Proprietà:

Nome Type (Tipo) Descrizione
major integer Il numero di versione principale.
minor integer Il numero di versione minore.
patch integer Il numero di versione patch.
revision integer Il numero di revisione.
extended string La stringa estesa.
versionStr string Una concatenazione dei numeri principali, secondari, di patch e di revisione nel modulomajor.minor.patch+build.revision.

(costante) ScreenshotError: ScreenshotErrorCode

I ScreenshotError codici enum.

Type:

(costante) WebcamError: WebcamErrorCode

I WebcamError codici enum.

Type:

Definizioni di tipi e callback

Elenco

AudioErrorCode

Le AudioError enumerazioni di codice disponibili nel modulo DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • numero

Richiamate di autenticazione

Richiamate di autenticazione

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
promptCredentials authPromptCredentialsRichiamata La funzione di callback da chiamare quando l'utente riceve richieste di credenziali.
error authErrorCallback La funzione di callback da chiamare quando l'autenticazione fallisce.
success authSuccessCallback La funzione di callback da chiamare quando l'autenticazione ha successo.

AuthenticationErrorCode

Le AuthenticationError enumerazioni di codice disponibili nel modulo 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:

  • numero

authErrorCallback(autenticazione, errore)

La funzione di callback da chiamare quando l'autenticazione fallisce.

Parametri:

Nome Type (Tipo) Descrizione
authentication Autenticazione L'oggetto di autenticazione.
error Oggetto L'oggetto di errore generato dal processo di autenticazione.
Nome Type (Tipo) Descrizione
code AuthenticationErrorCode Il codice di errore.
message string Messaggio di errore.

authPromptCredentialsRichiamata (autenticazione, sfida)

La funzione di callback da chiamare quando l'utente riceve richieste di credenziali. L'utente deve rispondere alla sfida fornendo le credenziali richieste.

Parametri:

Nome Type (Tipo) Descrizione
authentication Autenticazione L'oggetto di autenticazione.
challenge Oggetto La sfida.
Nome Type (Tipo) Descrizione
requiredCredentials Array. <Object> Matrice di oggetti credenziali richiesti.
Nome Type (Tipo) Descrizione
name string Il nome della credenziale richiesta.
type string Il tipo di credenziale richiesta.

authSuccessCallback(autenticazione, dati di autenticazione)

La funzione di callback da chiamare quando l'autenticazione ha successo.

Parametri:

Nome Type (Tipo) Descrizione
authentication Autenticazione L'oggetto di autenticazione.
authenticationData Array. <Object> Una serie di oggetti che includono ID di sessione NICE DCV e token di autenticazione.
Nome Type (Tipo) Descrizione
sessionId string L'ID della sessione NICE DCV.
authToken string Il token di autenticazione per la sessione NICE DCV.

Canale

I canali disponibili che possono essere specificati.

Type:

  • «appunti» | «visualizzazione» | «input» | «audio» | «archiviazione file»

ChannelErrorCode

Le ChannelError enumerazioni di codice disponibili nel modulo DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Type:

  • numero

clipboardEventCallback(evento)

La funzione di callback da chiamare quandoclipboardEvent viene generato un.

Parametri:

Nome Type (Tipo) Descrizione
event Oggetto Le informazioni sull'evento clipboard.
Nome Type (Tipo) Attributi Descrizione
name stabilito | copia | incolla | dataSizeAlert | autoCopyDone | newDataAvailable autoPasteDone | RemoteError | pasteAvailableData Sempre presenti. Nome dell'evento.
clipboardData Oggetto | stringa I dati negli appunti.
autoCopy booleano <optional> Indica se la copia automatica dagli appunti della sessione agli appunti del client locale è abilitata.
maxDataSize numero <optional> La quantità massima di dati che possono essere inseriti negli Appunti.
error string <optional> Informazioni sull'errore, se applicabile.

ClosingReasonErrorCode

Le ClosingReasonError enumerazioni di codice disponibili nel modulo 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

Type:

  • numero

Spazio cromatico

Gli spazi di colore disponibili che possono essere specificati.

Type:

  • «RGB» | «YUV_REC601" | «YUV_REC709"

Richiamate di connessione

I callback disponibili per essere chiamati in caso di errore di connessione.

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
disconnect Disconnetti Callback La funzione di callback da chiamare al termine della connessione.
displayLayout displayLayoutCallback La funzione di callback da richiamare quando si modifica il layout o la risoluzione del display.
displayAvailability displayAvailabilityCallback La funzione di callback da richiamare quando la disponibilità di un display cambia.
firstFrame firstFrameCallback La funzione di callback da chiamare quando il primo frame viene ricevuto dal server NICE DCV.
filePrinted filePrintedCallback La funzione di callback da chiamare quando un file viene stampato sul server NICE DCV.
fileDownload fileDownloadCallback La funzione di callback da chiamare quando un file è pronto per essere scaricato dal server NICE DCV.
dataChannel dataChannelCallback La funzione di callback da chiamare quando il server NICE DCV invia una notifica sulla disponibilità di un canale dati.
licenseNotification licenseNotificationCallback La funzione di callback da chiamare quando il server NICE DCV invia una notifica sullo stato della licenza.
idleWarningNotification idleWarningNotificationRichiamata La funzione di callback da chiamare quando il server NICE DCV invia un avviso di timeout di inattività.
collaboratorList collaboratorListCallback La funzione di callback da chiamare quando il server NICE DCV invia l'elenco dei collaboratori (a partire dalla versione 1.1.0 di NICE DCV Web Client SDK).
qualityIndicatorState qualityIndicatorStateRichiamata La funzione di callback da richiamare quando l'indicatore della qualità della connessione cambia stato.
filestorageEnabled filestorageEnabledCallback La funzione di callback da chiamare quando l'archiviazione dei file è abilitata o disabilitata.
featuresUpdate featuresUpdateCallback La funzione di callback da chiamare quando lo stato di una funzionalità cambia.
clipboardEvent clipboardEventCallback La funzione di callback da chiamare quandoclipboardEvent viene generato un.
deviceChangeEvent deviceChangeEventRichiamata La funzione di callback da chiamare quando viene attivato undeviceChange evento.
screenshot Screenshot Callback La funzione di callback da chiamare quando ascreenshot è disponibile.

ConnectionConfig

La configurazione per una connessione NICE DCV.

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
url string Il nome host e la porta del server NICE DCV in esecuzione nel seguente formato:https://dcv_host_address:port. Ad esempio: https://my-dcv-server:8443.
sessionId string L'ID della sessione NICE DCV.
authToken string Il token di autenticazione da utilizzare per la connessione al server.
baseUrl string L'URL assoluto o relativo da cui caricare i file SDK.
resourceBaseUrl string L'URL assoluto o relativo da cui accedere alle risorse DCV.
enabledChannels Array. < Canale > Indica l'elenco dei canali che possono essere abilitati. Se non viene specificato o viene fornito un array vuoto, per impostazione predefinita sono tutti i canali disponibili.
losslessColorspace Spazio cromatico Indica lo spazio cromatico che verrà utilizzato. Se non specificato, il valore predefinito viene, il valore predefinito viene, il valore predefinito viene, il valore predefinito viene.
divId string L'ID dell'divoggetto nel DOM HTML in cui SDK deve creare la tela con il flusso remoto.
volumeLevel integer Il livello di volume preferito. L'intervallo valido è compreso tra 0 e 100.
clipboardAutoSync booleano Indica se la copia automatica dagli appunti della sessione NICE DCV agli appunti del client locale è abilitata per i browser Web compatibili.
dynamicAudioTuning booleano Indica se sintonizzare dinamicamente l'audio in base alle impostazioni audio del server NICE DCV quando viene stabilita una connessione.
clientHiDpiScaling booleano Indica se ridimensionare la tela in base al DPI del client.
highColorAccuracy booleano Indica se deve essere utilizzata un'elevata precisione del colore, se disponibile. Se il valore non viene specificato, il valore impostato sufalse.
enableWebCodecs Boolean Indica se WebCodecs deve essere usato se disponibile. Se non specificato, viene usato il valore predefinito false.
observers Richiamate di connessione Le funzioni di callback per richiamare eventi correlati alla connessione.
callbacks Richiamate di connessione Uguale allaobservers proprietà, ma ogni callback include l'oggetto Connection come primo parametro.

ConnectionErrorCode

Le ConnectionError enumerazioni di codice disponibili nel modulo DCV

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR(a partire da DCV Server 2021.0)

  • INTERNAL_SERVER_ERROR(a partire da DCV Server 2021.0)

  • AUTHENTICATION_FAILED(a partire da DCV Server 2021.0)

  • PROTOCOL_ERROR(a partire da DCV Server 2021.0)

  • INVALID_SESSION_ID(a partire da DCV Server 2021.0)

  • INVALID_CONNECTION_ID(a partire da DCV Server 2021.0)

  • CONNECTION_LIMIT_REACHED(a partire da DCV Server 2021.0)

  • SERVER_UNREACHABLE(a partire da DCV Server 2022.1)

Type:

  • numero

CreateDirectory (percorso)

Parametri:

Nome Type (Tipo) Descrizione
path string Il percorso assoluto sul server in cui vogliamo creare una directory. Dovrebbe includere anche il nome della directory di destinazione.

CustomChannelErrorCode

Le CustomChannelError enumerazioni di codice disponibili nel modulo DCV

  • TRANSPORT_ERROR

Type:

  • numero

dataChannelCallback(informazioni)

La funzione di callback da chiamare quando il server NICE DCV invia una notifica sulla disponibilità di un canale dati.

Parametri:

Nome Type (Tipo) Descrizione
info Oggetto Informazioni sul canale dati.
Nome Type (Tipo) Descrizione
name string Il nome del canale dati.
token string Il token di autenticazione per il canale di dati.

deleteFile (percorso)

Parametri:

Nome Type (Tipo) Descrizione
path string Il percorso assoluto sul server che identifica il file che vogliamo eliminare.

deviceChangeEventRichiamata ()

La funzione di callback da chiamare quando viene attivato undeviceChange evento.

DisconnectCallback (motivo)

La funzione di callback da chiamare al termine della connessione.

Parametri:

Nome Type (Tipo) Descrizione
reason Oggetto Il motivo della disconnessione.
Nome Type (Tipo) Descrizione
code numero Il codice del motivo.
message string Il messaggio del motivo.

displayAvailabilityCallback(stato, DisplayID)

La funzione di callback da richiamare quando la disponibilità di un display cambia.

Parametri:

Nome Type (Tipo) Descrizione
status Oggetto Lo stato del display.
Nome Type (Tipo) Descrizione
enabled booleano Indica se il display è abilitato.
closed booleano Indica se il display è chiuso.
displayId numero L'identificatore del display.

DisplayConfigErrorCode

Le DisplayConfigError enumerazioni di codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Type:

  • numero

displayLayoutCallback(larghezza del server, altezza del server, testate)

La funzione di callback da richiamare quando si modifica il layout o la risoluzione del display.

Parametri:

Nome Type (Tipo) Descrizione
serverWidth numero La larghezza (in pixel) dello schermo principale.
serverHeight numero L'altezza (in pixel) del display principale.
heads Array. < Monitora > Le testine di visualizzazione sono supportate dal server NICE DCV.

caratteristica

I valori delle funzionalità.

  • display- Indica la disponibilità di un flusso video a schermo singolo.

  • display-multi- Indica la disponibilità di un flusso video con più display.

  • high-color-accuracy- Indica la disponibilità di un'elevata precisione del colore (a partire dalla versione NICE DCV Web Client SDK 1.1.0).

  • mouse- Indica la disponibilità della funzionalità del mouse.

  • keyboard- Indica la disponibilità della funzionalità della tastiera.

  • keyboard-sas- Indica la disponibilità della funzionalità della sequenza SAS (Control + Alt + Delete).

  • relative-mouse- Indica la disponibilità della modalità relativa del mouse.

  • clipboard-copy- Indica la disponibilità della funzionalità di copia degli appunti dal server NICE DCV al client.

  • clipboard-paste- Indica la disponibilità della funzionalità di incollaggio degli appunti dal client al server NICE DCV.

  • audio-in- Indica la disponibilità della funzionalità di ingresso audio tramite il microfono.

  • audio-out- Indica la disponibilità della funzionalità di riproduzione audio.

  • webcam- Indica la disponibilità della funzionalità di streaming della webcam.

  • file-download- Indica la disponibilità della funzionalità di download dei file dal server NICE DCV al client.

  • file-upload- Indica la disponibilità della funzionalità di caricamento dei file dal client al server NICE DCV.

  • timezone-redirection- Indica la disponibilità della funzionalità di reindirizzamento del fuso orario (a partire dalla versione 1.3.0 di NICE DCV Web Client SDK).

Type:

  • string

featuresUpdateCallback(Elenco delle caratteristiche)

La funzione di callback da chiamare quando lo stato di una funzionalità cambia.

Parametri:

Nome Type (Tipo) Descrizione
featuresList Array. < funzionalità > Una serie di funzionalità che sono state modificate.

fileDownloadCallback(Risorsa di file)

La funzione di callback da chiamare quando un file è pronto per essere scaricato dal server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
fileResource Oggetto Informazioni sul file pronto per il download.
Nome Type (Tipo) Descrizione
id string L'identificatore del file.
url string L'URL da utilizzare per scaricare il file.
domain string Il dominio delle risorse.
token string Il token di autenticazione da utilizzare per scaricare il file. Il token è incluso anche nell'URL.

filePrintedCallback(Risorsa di stampa)

La funzione di callback da chiamare quando un file viene stampato sul server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
printResource Oggetto Informazioni sul file stampato.
Nome Type (Tipo) Descrizione
id string L'identificatore del file stampato.
url string L'URL da utilizzare per scaricare il file stampato.
domain string Il dominio delle risorse. In questo caso,printer.
token string Il token di autenticazione da utilizzare per scaricare il file stampato. Il token è incluso anche nell'URL.

archiviazione di file

Oggetto che consente di esplorare ed eseguire azioni sul file system.

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
list elenco Funzione che permette di elencare gli elementi (file e directory) presenti nel percorso fornito sul server.
createDirectory Crea cartella Funzione che consente di creare una directory nel percorso specificato sul server.
retrieveFile Recupera file Funzione che consente di scaricare localmente un file nel percorso specificato sul server.
deleteFile Elimina file Funzione che consente di eliminare un file nel percorso specificato sul server.
renameFile Rinomina file Funzione che consente di rinominare un file dal percorso di origine specificato al percorso di destinazione specificato.
renameDirectory Rinomina cartella Funzione che consente di rinominare una directory dal percorso di origine specificato al percorso di destinazione assoluto.
storeFile Memorizza file Funzione che permette di caricare un file locale nel percorso fornito sul server.

filestorageEnabledCallback(abilitato)

La funzione di callback da chiamare quando l'archiviazione dei file è abilitata. Canale Lazy solo su Internet Explorer 11.

Parametri:

Nome Type (Tipo) Descrizione
enabled booleano Indica se la memorizzazione dei file è abilitata.

FileStorageErrorCode

Le FileStorageError enumerazioni di codice disponibili nel modulo DCV

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Type:

  • numero

firstFrameCallback(Ridimensiona relativeMouseMode abilitato, DisplayID)

La funzione di callback da chiamare quando il primo frame viene ricevuto dal server NICE DCV. Emesso per ogni display.

Parametri:

Nome Type (Tipo) Descrizione
resizeEnabled booleano Indica se il server supporta il ridimensionamento del layout di visualizzazione del client.
relativeMouseModeEnabled booleano Indica se il server supporta la modalità mouse relativa.
displayId numero L'identificatore del display.

idleWarningNotificationRichiamata (disconnectionDateTime)

La funzione di callback da chiamare quando il server NICE DCV invia un avviso di timeout di inattività.

Parametri:

Nome Type (Tipo) Descrizione
disconnectionDateTime Data La data e l'ora della disconnessione.

collaboratorListCallback(collaboratori)

La funzione di callback da chiamare quando il server NICE DCV invia l'elenco dei collaboratori.

Parametri:

Nome Type (Tipo) Descrizione
collaborators Array. <Object> Un elenco di oggetti contenenti informazioni sui collaboratori.
Nome Type (Tipo) Descrizione
username string Il nome utente del collaboratore.
owner booleano Indica se il collaboratore è il proprietario della sessione.
connectionId numero Indica l'ID assegnato dal server alla connessione.

licenseNotificationCallback(notifica)

La funzione di callback da chiamare quando il server NICE DCV invia una notifica sullo stato della licenza.

Parametri:

Nome Type (Tipo) Descrizione
notification Oggetto La notifica.
Nome Type (Tipo) Descrizione
product string Il prodotto DCV.
status string Lo stato della licenza.
message string Un messaggio.
leftDays numero Il numero di giorni prima della scadenza della licenza.
isDemo booleano Indica se la licenza è una licenza demo.
numUnlicensed numero Il numero di connessioni senza licenza.
licensingMode string La modalità di licenza.
documentationUrl string L'URL della documentazione.

elenco (percorso)

Parametri:

Nome Type (Tipo) Descrizione
path string Il percorso assoluto sul server di cui vogliamo elencare il contenuto.

LogLevel

I livelli di registro SDK disponibili.

Type:

  • TRACCIA | DEBUG | INFORMAZIONI | AVVISO | ERRORE | SILENZIOSO

Monitor (Monitoraggio)

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
name string Il nome della testina del display.
rect Oggetto Informazioni sulla testina del display.
Nome Type (Tipo) Descrizione
x numero Lax coordinata iniziale della testina del display.
y numero Lay coordinata iniziale della testina del display.
width numero La larghezza (in pixel) della testina del display.
height numero L'altezza (in pixel) della testina del display.
primary booleano Indica se la testina dello schermo è la testina di visualizzazione principale. Questo viene determinato dal sistema operativo remoto, se disponibile.
dpi numero Il DPI della testina del display.

MultiMonitorErrorCode

Le MultiMonitorError enumerazioni di codice disponibili nel modulo DCV

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

Type:

  • numero

qualityIndicatorStateCallback (stato)

La funzione di callback da richiamare quando l'indicatore della qualità della connessione cambia stato.

Parametri:

Nome Type (Tipo) Descrizione
state Array. <Object> Informazioni sulla qualità della connessione.
Nome Type (Tipo) Descrizione
name string Il nome dell'indicatore.
status NORMALE | AVVISO | CRITICO Descrizione dello stato.
changed booleano Indica se lo stato è cambiato.

Rinomina cartella (src, dest)

Parametri:

Nome Type (Tipo) Descrizione
src string Il percorso di origine assoluto sul server che identifica la directory che vogliamo rinominare.
dest string Il percorso di destinazione assoluto sul server che specifica il percorso di destinazione e il nome della directory.

Rinomina file (src, dest)

Parametri:

Nome Type (Tipo) Descrizione
src string Il percorso di origine assoluto sul server che identifica il file che vogliamo rinominare.
dest string Il percorso di destinazione assoluto sul server che specifica il percorso di destinazione e il nome del file.

ResolutionErrorCode

Le ResolutionError enumerazioni di codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Type:

  • numero

RetrieveFile (percorso)

Parametri:

Nome Type (Tipo) Descrizione
path string Il percorso assoluto sul server che identifica il file che vogliamo scaricare localmente.

ScreenshotCallback (immagine dello schermo)

La funzione di callback da chiamare quando è disponibile uno screenshot.

Parametri:

Nome Type (Tipo) Descrizione
screenshot byte[] Buffer di screenshot in formato PNG onull se il recupero dello screenshot non è riuscito.

ScreenshotErrorCode

Le ScreenshotError enumerazioni di codice disponibili nel modulo DCV

  • NO_CHANNEL

  • GENERIC_ERROR

Type:

  • numero

Informazioni sul server

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
name string Il nome del software.
version Oggetto Il numero di versione del software.
Nome Type (Tipo) Descrizione
major numero Il numero di versione principale.
minor numero Il numero di versione minore.
revision numero Il numero di versione della revisione.
os string Il sistema operativo.
arch string L'architettura.
hostname string Il nome host.

stats

Type:

  • Oggetto

Proprietà:

Nome Type (Tipo) Descrizione
fps numero I fotogrammi correnti al secondo.
traffic numero Il traffico corrente in bit/s.
peakTraffic numero Il picco di traffico in bit/s da quando è stata stabilita la connessione.
latency numero Latenza corrente in ms.
currentChannels numero Il numero di canali aperti da quando è stata stabilita la connessione.
openedChannels numero Il numero di canali attualmente aperti.
channelErrors numero Il numero di canali che hanno segnalato un errore.

StoreFile (file, directory)

Parametri:

Nome Type (Tipo) Descrizione
file File L'oggetto del file (per maggiori informazioni vedi https://developer.mozilla.org/en-US/docs/Web/API/File) che vogliamo caricare sul server.
dir string Il percorso assoluto sul server in cui vogliamo caricare il file.

TimezoneRedirectionErrorCode

Le TimezoneRedirectionError enumerazioni di codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Type:

  • numero

TimezoneRedirectionSettingCode

Le TimezoneRedirectionSetting enumerazioni di codice disponibili nel modulo DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Type:

  • numero

TimezoneRedirectionStatusCode

Le TimezoneRedirectionStatus enumerazioni di codice disponibili nel modulo DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Type:

  • numero

WebcamErrorCode

Le WebcamError enumerazioni di codice disponibili nel modulo DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • numero