DCVmodulo - Amazon DCV
MetodiMembriDefinizioni di tipo 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à.

DCVmodulo

Un modulo che implementa il lato client del DCV protocollo.

Metodi

authenticate (url, callback) → {Authentication}

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

Parametri:

Nome Tipo Descrizione
url stringa Il nome host e la porta del DCV server Amazon in esecuzione nel seguente formato:https://dcv_host_address:port. Ad esempio: https://my-dcv-server:8443.
callbacks authenticationCallbacks I callback disponibili per essere richiamati durante il processo di autenticazione.

Valori restituiti:

- L'oggetto di autenticazione.

Tipo

Autenticazione

connect (config) → {Promessa. < Connessione >|Promessa. < {codice: ConnectionErrorCode, messaggio: stringa} >}

Si connette all'endpoint DCV del server Amazon specificato. Se la connessione riesce, restituisce un oggetto Connection. Se la connessione fallisce, restituisce un oggetto di errore.

Parametri:

Nome Tipo Descrizione
config ConnectionConfig L' ConnectionConfig oggetto.

Valori restituiti:

- Un oggetto Connection o un oggetto di errore.

Tipo

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

setLogHandler(gestore) → {void}

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

Parametri:

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

Valori restituiti:

Tipo

void

setLogLevel(livello) → {void}

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

Parametri:

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

Valori restituiti:

Tipo

void

Membri

(costante) AudioError: AudioErrorCode

I AudioError codici enumerano.

Type:

(costante) AuthenticationError: AuthenticationErrorCode

I AuthenticationError codici enumerano.

Type:

(costante) ChannelError: ChannelErrorCode

I ChannelError codici enumerano.

Type:

(costante) ClosingReasonError: ClosingReasonErrorCode

I ClosingReasonError codici enumerano.

Type:

(costante) ConnectionError: ConnectionErrorCode

I ConnectionError codici enumerano.

Type:

(costante) CustomChannelError: CustomChannelErrorCode

I CustomChannelError codici enumerano.

Type:

(costante) DisplayConfigError: DisplayConfigErrorCode

I DisplayConfigError codici enumerano.

Type:

(costante) FileStorageError: FileStorageErrorCode

I FileStorageError codici enumerano.

Type:

(costante) LogLevel: LogLevel

I livelli di SDK registro disponibili.

Type:

(costante) MultiMonitorError: MultiMonitorErrorCode

I MultiMonitorError codici enumerano.

Type:

(costante) ResolutionError: ResolutionErrorCode

I ResolutionError codici enumerano.

Type:

(costante) TimezoneRedirectionError: TimezoneRedirectionErrorCode

I TimezoneRedirectionError codici enumerano.

Type:

(costante) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

I TimezoneRedirectionSetting codici enumerano.

Type:

(costante) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

I TimezoneRedirectionStatus codici enumerano.

Type:

versione (costante)

La DCV versione di Amazon con patch principale, secondaria, patch, revisione, estesa eversionStr.

Proprietà:

Nome Tipo Descrizione
major integer Il numero della versione principale.
minor integer Il numero della versione secondaria.
patch integer Il numero della versione della 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 modulo. major.minor.patch+build.revision

(costante): ScreenshotError ScreenshotErrorCode

I ScreenshotError codici enumerano.

Type:

(costante) WebcamError: WebcamErrorCode

I WebcamError codici enumerano.

Type:

Definizioni di tipo e callback

AudioErrorCode

Le enumerazioni di AudioError codice disponibili nel modulo DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • number

authenticationCallbacks

Callback di autenticazione

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
promptCredentials authPromptCredentialsRichiamata La funzione di callback da chiamare quando all'utente vengono richieste le 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 esito positivo.

AuthenticationErrorCode

Le enumerazioni di AuthenticationError 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:

  • number

authErrorCallback(autenticazione, errore)

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

Parametri:

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

authPromptCredentialsCallback (autenticazione, sfida)

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

Parametri:

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

authSuccessCallback(autenticazione,authenticationData)

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

Parametri:

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

Canale

I canali disponibili che possono essere specificati.

Type:

  • «appunti» | «display» | «input» | «audio» | «filestorage»

ChannelErrorCode

Le enumerazioni di ChannelError codice disponibili nel modulo DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Type:

  • number

clipboardEventCallback(evento)

La funzione di callback da chiamare quando clipboardEvent viene generato un.

Parametri:

Nome Tipo Descrizione
event Oggetto Informazioni sull'evento clipboard.
Nome Tipo Attributes Descrizione
name stabilito | copia | incolla | dataSizeAlert | | autoCopyDone | newDataAvailable | autoPasteDone remoteError pasteAvailableData Sempre presente. Nome dell'evento.
clipboardData Oggetto | stringa I dati negli appunti.
autoCopy booleano <optional> Indica se è abilitata la copia automatica dagli appunti della sessione agli appunti del client locale.
maxDataSize number <optional> La quantità massima di dati che è possibile inserire negli appunti.
error string <optional> Informazioni sull'errore, se applicabili.

ClosingReasonErrorCode

Le enumerazioni di ClosingReasonError 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

  • EXTERNAL_PROTOCOL_CONNECTION_EVICTED

  • DISCONNECTION_REQUESTED

Type:

  • number

Spazio cromatico

Gli spazi cromatici disponibili che possono essere specificati.

Type:

  • "RGB" | "YUV_ REC6 01" |" _ 09" YUV REC7

connectionCallbacks

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

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
disconnect disconnectCallback La funzione di callback da chiamare al termine della connessione.
displayLayout displayLayoutCallback La funzione di callback da chiamare quando si modifica il layout o la risoluzione dello schermo.
displayAvailability displayAvailabilityCallback La funzione di callback da chiamare quando la disponibilità di uno schermo cambia.
firstFrame firstFrameCallback La funzione di callback da chiamare quando il primo frame viene ricevuto dal DCV server Amazon.
filePrinted filePrintedCallback La funzione di callback da chiamare quando un file viene stampato sul DCV server Amazon.
fileDownload fileDownloadCallback La funzione di callback da chiamare quando un file è pronto per essere scaricato dal DCV server Amazon.
dataChannel dataChannelCallback La funzione di callback da chiamare quando il DCV server Amazon invia una notifica sulla disponibilità di un canale dati.
licenseNotification licenseNotificationCallback La funzione di callback da chiamare quando il DCV server Amazon invia una notifica sullo stato della licenza.
idleWarningNotification idleWarningNotificationRichiamata La funzione di callback da chiamare quando il DCV server Amazon invia un avviso di timeout di inattività.
collaboratorList collaboratorListCallback La funzione di callback da chiamare quando il DCV server Amazon invia l'elenco dei collaboratori (a partire dalla SDK versione 1.1.0 di Amazon DCV Web Client).
qualityIndicatorState qualityIndicatorStateRichiamata La funzione di callback da chiamare 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 quando clipboardEvent viene generato un.
deviceChangeEvent deviceChangeEventCallback La funzione di callback da chiamare quando viene attivato un deviceChange evento.
screenshot screenshotCallback La funzione di callback da chiamare quando a screenshot è disponibile.

ConnectionConfig

La configurazione per una DCV connessione Amazon.

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
url stringa Il nome host e la porta del DCV server Amazon in esecuzione nel seguente formato:https://dcv_host_address:port. Ad esempio: https://my-dcv-server:8443.
sessionId string L'ID DCV della sessione Amazon.
authToken string Il token di autenticazione da utilizzare per la connessione al server.
baseUrl string L'assoluto o relativo URL da cui caricare SDK i file.
resourceBaseUrl string L'assoluto o relativo URL da cui accedere alle DCV risorse.
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 vengono utilizzati tutti i canali disponibili.
losslessColorspace Spazio cromatico Indica lo spazio cromatico che verrà utilizzato. Se non viene specificato, il valore predefinito è "». RGB
divId string L'ID dell'divoggetto nel HTML DOM where SDK dovrebbe creare la tela con lo stream 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 DCV sessione Amazon agli appunti del client locale è abilitata per i browser Web compatibili.
dynamicAudioTuning booleano Indica se ottimizzare dinamicamente l'audio in base alle impostazioni audio del DCV server Amazon quando viene stabilita una connessione.
clientHiDpiScaling booleano Indica se ridimensionare la tela in base a quella del DPI client.
highColorAccuracy booleano Indica se è necessario utilizzare un'elevata precisione del colore, se disponibile. Se non è specificato, il valore predefinito è. false
enableWebCodecs Booleano Indica se WebCodecs deve essere usato se disponibile. Se non specificato, viene usato il valore predefinito false.
observers connectionCallbacks Le funzioni di callback da richiamare per gli eventi correlati alla connessione.
callbacks connectionCallbacks Uguale alla observers proprietà, ma ogni callback include l'oggetto Connection come primo parametro.

ConnectionErrorCode

Le enumerazioni di ConnectionError codice disponibili nel modulo DCV

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR(dal DCV Server 2021.0)

  • INTERNAL_SERVER_ERROR(dal DCV Server 2021.0)

  • AUTHENTICATION_FAILED(dal DCV Server 2021.0)

  • PROTOCOL_ERROR(dal DCV Server 2021.0)

  • INVALID_SESSION_ID(dal DCV Server 2021.0)

  • INVALID_CONNECTION_ID(dal DCV Server 2021.0)

  • CONNECTION_LIMIT_REACHED(dal DCV Server 2021.0)

  • SERVER_UNREACHABLE(dal DCV Server 2022.1)

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL(dal DCV Server 2022.2)

  • TRANSPORT_ERROR

Type:

  • number

createDirectory(percorso)

Parametri:

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

CustomChannelErrorCode

Le enumerazioni di CustomChannelError codice disponibili nel modulo DCV

  • TRANSPORT_ERROR

Type:

  • number

dataChannelCallback(informazioni)

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

Parametri:

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

deleteFile(percorso)

Parametri:

Nome Tipo Descrizione
path stringa Il percorso assoluto sul server che identifica il file che vogliamo eliminare.

deviceChangeEventRichiamata ()

La funzione di callback da chiamare quando viene attivato un deviceChange evento.

disconnectCallback(motivo)

La funzione di callback da chiamare al termine della connessione.

Parametri:

Nome Tipo Descrizione
reason Oggetto Il motivo della disconnessione.
Nome Tipo Descrizione
code number Il codice del motivo.
message string Il messaggio del motivo.

displayAvailabilityCallback(stato,displayId)

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

Parametri:

Nome Tipo Descrizione
status Oggetto Lo stato del display.
Nome Tipo Descrizione
enabled booleano Indica se lo schermo è abilitato.
closed booleano Indica se lo schermo è chiuso.
displayId number L'identificatore del display.

DisplayConfigErrorCode

Le enumerazioni di DisplayConfigError codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Type:

  • number

displayLayoutCallback(serverWidthserverHeight, teste)

La funzione di callback da chiamare quando si modifica il layout o la risoluzione dello schermo.

Parametri:

Nome Tipo Descrizione
serverWidth number La larghezza (in pixel) dello schermo principale.
serverHeight number L'altezza (in pixel) dello schermo principale.
heads Array. < Monitoraggio > Le testine di visualizzazione supportate dal DCV server Amazon.

caratteristica

I valori delle caratteristiche.

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

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

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

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

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

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

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

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

  • clipboard-paste- Indica la disponibilità della funzionalità Clipboard Paste dal client al server AmazonDCV.

  • 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 tramite webcam.

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

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

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

Type:

  • string

featuresUpdateCallback(featuresList)

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

Parametri:

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

fileDownloadCallback(fileResource)

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

Parametri:

Nome Tipo Descrizione
fileResource Oggetto Informazioni sul file pronto per il download.
Nome Tipo Descrizione
id stringa L'identificatore del file.
url string URLDa 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 inURL.

filePrintedCallback(printResource)

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

Parametri:

Nome Tipo Descrizione
printResource Oggetto Informazioni sul file stampato.
Nome Tipo Descrizione
id stringa L'identificatore del file stampato.
url string URLDa 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 inURL.

archiviazione di file

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

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
list elenco Funzione che permette di elencare gli elementi (file e directory) presenti nel percorso fornito sul server.
createDirectory createDirectory Funzione che permette di creare una directory nel percorso specificato sul server.
retrieveFile retrieveFile Funzione che permette di scaricare localmente un file nel percorso specificato sul server.
deleteFile deleteFile Funzione che permette di eliminare un file nel percorso specificato sul server.
renameFile renameFile Funzione che permette di rinominare un file dal percorso di origine specificato al percorso di destinazione specificato.
renameDirectory renameDirectory Funzione che permette di rinominare una directory dal percorso di origine specificato al percorso di destinazione assoluto.
storeFile storeFile 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 Tipo Descrizione
enabled booleano Indica se l'archiviazione dei file è abilitata.

FileStorageErrorCode

Le enumerazioni di FileStorageError codice disponibili nel modulo DCV

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Type:

  • number

firstFrameCallback(resizeEnabled, relativeMouseMode Abilitato,displayId)

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

Parametri:

Nome 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 number L'identificatore per lo schermo.

idleWarningNotificationRichiamata () disconnectionDateTime

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

Parametri:

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

collaboratorListCallback(collaboratori)

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

Parametri:

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

licenseNotificationCallback(notifica)

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

Parametri:

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

elenco (percorso)

Parametri:

Nome Tipo Descrizione
path stringa Il percorso assoluto sul server di cui vogliamo elencare il contenuto.

LogLevel

I livelli di SDK registro disponibili.

Type:

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

Monitoraggio

Type:

  • Oggetto

Proprietà:

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

MultiMonitorErrorCode

Le enumerazioni di MultiMonitorError 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:

  • number

qualityIndicatorStateCallback (stato)

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

Parametri:

Nome Tipo Descrizione
state Array. <Object> Informazioni sulla qualità della connessione.
Nome Tipo Descrizione
name stringa Il nome dell'indicatore.
status NORMAL | WARNING | CRITICAL Descrizione dello stato.
changed booleano Indica se lo stato è cambiato.

renameDirectory(src, dest)

Parametri:

Nome Tipo Descrizione
src stringa 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.

renameFile(src, dest)

Parametri:

Nome Tipo Descrizione
src stringa 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 enumerazioni di ResolutionError codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Type:

  • number

retrieveFile(percorso)

Parametri:

Nome Tipo Descrizione
path stringa Il percorso assoluto sul server che identifica il file che vogliamo scaricare localmente.

screenshotCallback(schermata)

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

Parametri:

Nome Tipo Descrizione
screenshot byte[] PNGFormato del buffer degli screenshot o null se il recupero degli screenshot non è riuscito.

ScreenshotErrorCode

Le enumerazioni di ScreenshotError codice disponibili nel modulo DCV

  • NO_CHANNEL

  • GENERIC_ERROR

Type:

  • number

serverInfo

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
name stringa Il nome del software.
version Oggetto Il numero della versione del software.
Nome Tipo Descrizione
major number Il numero della versione principale.
minor number Il numero della versione secondaria.
revision number Il numero della versione della revisione.
os string Il sistema operativo.
arch string L'architettura.
hostname string Il nome host.

statistiche

Type:

  • Oggetto

Proprietà:

Nome Tipo Descrizione
fps number I fotogrammi correnti al secondo.
traffic number Il traffico attuale in bit/s.
peakTraffic number Il picco di traffico in bit/s dal momento in cui è stata stabilita la connessione.
latency number La latenza attuale in ms.
currentChannels number Il numero di canali che sono stati aperti da quando è stata stabilita la connessione.
openedChannels number Il numero di canali attualmente aperti.
channelErrors number Il numero di canali che hanno segnalato un errore.

storeFile(file, dir)

Parametri:

Nome Tipo Descrizione
file File L'oggetto 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 enumerazioni di TimezoneRedirectionError codice disponibili nel modulo DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Type:

  • number

TimezoneRedirectionSettingCode

Le enumerazioni di TimezoneRedirectionSetting codice disponibili nel modulo DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Type:

  • number

TimezoneRedirectionStatusCode

Le enumerazioni di TimezoneRedirectionStatus codice disponibili nel modulo DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Type:

  • number

WebcamErrorCode

Le enumerazioni di WebcamError codice disponibili nel modulo DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Type:

  • number