Classe di connessione - Amazon DCV
Metodi

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à.

Classe di connessione

La classe di connessione ottenuta chiamando il connectmetodo del dcv modulo. Per un esempio che mostra come usarlo, consulta la sezione Guida introduttiva.

Espone

Metodi

Elenco

attachDisplay(win,displayConf) → {Promessa. <number>|Promessa. < {codice: MultiMonitorErrorCode, messaggio: stringa} >}

Collega uno schermo specifico a una finestra. Non è possibile collegare lo schermo principale. In caso di successo, la funzione restituisce ildisplayId.

Parametri:

Nome Tipo Descrizione
win Oggetto La finestra a cui deve essere collegato lo schermo.
displayConf Oggetto La configurazione dello schermo.
Nome Tipo Attributes Descrizione
displayId number <optional> L'ID del display.
displayDivName Il nome del div di visualizzazione.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

Promessa. <number>| Promessa. < {codice: MultiMonitorErrorCode, messaggio: stringa} >

captureClipboardEvents(abilitato, win,displayId) → {void}

Avvia o interrompe l'ascolto degli eventi copia-incolla. Nel caso degli appunti interattivi (sempre nel caso di incolla) dobbiamo iniziare ad ascoltare gli eventi di copia/incolla. Potrebbe essere utile avviare e interrompere l'ascolto solo quando è necessario, ad esempio quando viene mostrato un modale.

Parametri:

Nome Tipo Attributes Descrizione
enabled booleano Per iniziare ad ascoltare gli eventi, specificatrue. Per interrompere l'ascolto degli eventi, specificarefalse.
win Oggetto <optional> La finestra in cui ascoltare gli eventi. Se omesso, viene utilizzata la finestra predefinita.
displayId number <optional> L'ID del display che dovrebbe ascoltare gli eventi. Se omesso, viene utilizzata la visualizzazione predefinita della finestra.

Valori restituiti:

Tipo

void

detachDisplay(displayId) → {void}

Scollega uno schermo specifico. Lo schermo principale non può essere rimosso.

Parametri:

Nome Tipo Descrizione
displayId number L'ID dello schermo da scollegare.

Valori restituiti:

Tipo

void

disconnetti () → {void}

Si disconnette dal DCV server Amazon e chiude la connessione.

Valori restituiti:

Tipo

void

disconnectCollaborator(connectionId) → {void}

Richiede la disconnessione del collaboratore connesso con l'ID di connessione fornito (a partire dalla SDK versione 1.1.0 di Amazon DCV Web Client).

Parametri:

Nome Tipo Descrizione
connectionId booleano L'id della connessione che verrà disconnessa.

Valori restituiti:

Tipo

void

enableDisplayQualityAggiornamenti (abilita) → {void}

Abilita o disabilita gli aggiornamenti della qualità di visualizzazione per le aree di streaming che non ricevono aggiornamenti. La disabilitazione degli aggiornamenti della qualità dello schermo riduce l'utilizzo della larghezza di banda, ma riduce anche la qualità dello schermo.

Parametri:

Nome Tipo Descrizione
enable booleano Per abilitare gli aggiornamenti della qualità dello schermo, specificare. true Per disabilitare gli aggiornamenti della qualità dello schermo, specificarefalse.

Valori restituiti:

Tipo

void

enableHighPixelDensità (abilita) → {void}

Abilita o disabilita l'alta densità di pixel sul client.

Parametri:

Nome Tipo Descrizione
enable booleano Se l'alta densità di pixel deve essere abilitata o meno.

Valori restituiti:

Tipo

void

enableTimezoneRedirection(abilita) → {Promise|Promessa. < {codice: TimezoneRedirectionErrorCode, messaggio: stringa} >}

Abilita o disabilita il reindirizzamento del fuso orario. Una volta abilitato, il client richiede al server di fare in modo che il fuso orario del desktop del server corrisponda al fuso orario del client.

Parametri:

Nome Tipo Descrizione
enable booleano Per abilitare il reindirizzamento del fuso orario, specificare. true Per disabilitare il reindirizzamento del fuso orario, specificare. false

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

Promessa. <number>| Promessa. < {codice: TimezoneRedirectionErrorCode, messaggio: stringa} >

enterRelativeMouseModalità () → {void}

Abilita la modalità relativa del mouse.

Valori restituiti:

Tipo

void

getConnectedDevices() → {Promessa. <Array. < MediaDeviceInfo >>|Promessa. < {message: string} >}

Richiede un elenco dei dispositivi multimediali collegati al computer client.

Valori restituiti:

In caso di successo, restituisce una Promise che si risolve in una matrice di MediaDeviceInfo oggetti. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/MediaDeviceInfo. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

Promessa. <Array. < MediaDeviceInfo >> | Promessa. < {message: string} >

getFileExplorer() → {Promessa. < filestorage >|Promessa. < {codice: ChannelErrorCode, messaggio: stringa} >}

Ottiene un oggetto per gestire lo storage di file del DCV server Amazon.

Valori restituiti:

Promessa. Risolve all'oggetto File Explorer se soddisfatto o a un oggetto di errore se rifiutato.

Tipo

Promessa. < filestorage > | Promessa. < {codice: ChannelErrorCode, messaggio: stringa} >

getServerInfo() → {serverInfo}

Ottiene informazioni sul DCV server Amazon.

Valori restituiti:

Informazioni sul software del server.

Tipo

serverInfo

getScreenshot() → {Promise|Promessa. < {codice: ScreenshotErrorCode, messaggio: stringa} >}

Recupera lo screenshot del desktop remoto in PNG formato. Lo screenshot verrà restituito nell'osservatore. screenshotCallback nullverrà restituito invece in caso di guasti.

Valori restituiti:

Promessa che si risolve se la richiesta viene elaborata. Se rifiutata, riceviamo un oggetto di errore.

Tipo

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

getStats() → {stats}

Ottiene statistiche sul DCV server Amazon.

Valori restituiti:

Informazioni sulle statistiche di streaming.

Tipo

statistiche

latchModifierKey(chiave, posizione,isDown) → {booleano}

Invia una singola tastiera keydown o keyup evento per un modificatore consentito.

Parametri:

Nome Tipo Descrizione
key Controllo | Alt | AltGraph | Meta | OS | Shift La chiave per inviare.
location KeyboardEvent.posizione La posizione della chiave. Per ulteriori informazioni, consulta https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.
isDown booleano Se l'evento chiave da iniettare è un keydown (true) o un keyup (). false

Valori restituiti:

Se la combinazione richiesta è valida, la funzione ritornatrue, altrimenti ritorna. false

Tipo

booleano

openChannel(nome, callbackauthToken, spazio dei nomi) → {Promise|Promessa. < {codice: ChannelErrorCode, messaggio: stringa} >}

Apre un canale dati personalizzato sulla connessione se è stata creata su Amazon DCV Server.

Parametri:

Nome Tipo Descrizione
name stringa Nome del canale.
authToken string Il token di autenticazione da utilizzare per connettersi al canale.
callbacks Oggetto Le funzioni onMessage e onClose i callback da chiamare.
namespace string Lo spazio dei nomi del canale. Disponibile a partire da Amazon DCV Web Client SDK 1.2.0 e Amazon DCV Server 2022.1.

Valori restituiti:

Promessa. Se rifiutato, riceviamo un oggetto di errore.

Tipo

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

queryFeature(featureName) → {Promessa. < {enabled: booleano, remoto? : stringa,? autoCopy : booleano,? autoPaste : booleano,? serviceStatus : stringa, disponibile? : boolean} >|Promessa. < {message: string} >}

Richiede lo stato di una specifica funzionalità del DCV server Amazon.

Parametri:

Nome Tipo Descrizione
featureName funzionalità Il nome della funzionalità da interrogare.

Valori restituiti:

Promessa. Se risolta, la funzione restituisce un status oggetto che contiene sempre una enabled proprietà e possibilmente anche altre proprietà. Se rifiutata, la funzione restituisce un error oggetto.

Tipo

{Promessa. < {enabled: booleano, remoto? : stringa,? autoCopy : booleano,? autoPaste : booleano,? serviceStatus : stringa, disponibile? : boolean} > | Promessa. < {message: string} >

registerKeyboardShortcuts(scorciatoie) → {void}

Registra le scorciatoie da tastiera.

Parametri:

Nome Tipo Descrizione
shortcuts Array. <Object> L'array di chiavi e mappature da registrare.
Nome Tipo Descrizione
sequence Array. <Object> La scorciatoia da tastiera per la registrazione.
Nome Tipo Descrizione
key KeyboardEvent.key Il valore del tasto premuto dall'utente. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.
output Matrice. <Object> L'azione prevista da eseguire con la scorciatoia.
Nome Tipo Descrizione
key KeyboardEvent.chiave Il valore del tasto premuto dall'utente. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.

Valori restituiti:

Tipo

void

requestDisplayConfig(highColorAccuracy) → {Promise|Promessa. < {codice: DisplayConfigErrorCode, messaggio: stringa} >}

Richiede una configurazione di visualizzazione aggiornata da Amazon DCV Server. Disponibile a partire da Amazon DCV Web Client SDK 1.1.0 e Amazon DCV Server 2022.0.

Parametri:

Nome Tipo Descrizione
highColorAccuracy booleano Se deve essere richiesta o meno un'elevata precisione del colore.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

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

requestDisplayLayout(layout) → {Promise|Promessa. < {codice: ResolutionErrorCode, messaggio: stringa} >}

Richiede un layout di visualizzazione aggiornato per la connessione.

Parametri:

Nome Tipo Descrizione
layout Array. < Monitoraggio > La richiesta viene visualizzata nel layout.

Valori restituiti:

Promessa. Se rifiutato, riceviamo un oggetto di errore.

Tipo

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

requestResolution(larghezza, altezza) → {Promise|Promessa. < {codice: ResolutionErrorCode, messaggio: stringa} >}

Richiede una risoluzione dello schermo aggiornata dal DCV server Amazon.

Parametri:

Nome Tipo Descrizione
width number La larghezza da richiedere in pixel. Il valore minimo consentito è0.
height number L'altezza da richiedere in pixel. Il valore minimo consentito è0.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

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

sendKeyboardEvent(evento) → {booleano}

Invia un evento di scorciatoia da tastiera. Per ulteriori informazioni sugli eventi da tastiera, consultate https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent. Gli eventi validi della tastiera includono: keydownkeypress, ekeyup. Per ulteriori informazioni su questi eventi, consulta https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent#events.

Parametri:

Nome Tipo Descrizione
event KeyboardEvent L'evento della tastiera da inviare.

Valori restituiti:

Se l'evento non è valido, la funzione ritornafalse. Se l'evento è valido, la funzione ritornatrue.

Tipo

booleano

sendKeyboardShortcut(scorciatoia) → {void}

Invia una scorciatoia da tastiera. Utilizzate questa funzione per inviare un intero keydown o una keyup sequenza. Ad esempio, l'invio di Ctrl + Alt + Del invia gli keydown eventi per tutti i tasti seguiti dagli keyup eventi. Utilizzate questa funzione anche se desiderate inviare una sola chiave.

Parametri:

Nome Tipo Descrizione
shortcut Array. <Object> L'array di chiavi da inviare.
Nome Tipo Descrizione
key KeyboardEvent.chiave Il valore del tasto premuto dall'utente. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni, vedere https://developer.mozilla. org/en-US/docs/Web/API/KeyboardEvent/location.

Valori restituiti:

Tipo

void

setDisplayQuality(min, maxopt) → {void}

Imposta la qualità dell'immagine da usare per la connessione. L'intervallo valido è 0 quello di 1001, tra la qualità dell'immagine più bassa e 100 la qualità dell'immagine più alta. 0Specificare per mantenere il valore corrente.

Parametri:

Nome Tipo Attributes Descrizione
min number La qualità minima dell'immagine.
max number <optional> La massima qualità dell'immagine.

Valori restituiti:

Tipo

void

setDisplayScale(scaleRatio,displayId) → {Promise|Promessa. < {codice: ResolutionErrorCode, messaggio: stringa} >} () DEPRECATED

Deprecato dalla versione 1.3.0. Non è più necessario impostare la scala di visualizzazione. Le coordinate del mouse verranno gestite automaticamente internamente.

Notifica ad Amazon DCV che lo schermo è ridimensionato sul lato client. Usalo per notificare al server che deve ridimensionare gli eventi del mouse in modo che corrispondano al rapporto di visualizzazione del client.

Parametri:

Nome Tipo Descrizione
scaleRatio float Il rapporto di scala da utilizzare. Deve essere un numero strettamente positivo.
displayId number L'ID del display da scalare.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

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

setKeyboardQuirks(stranezze) → {void}

Imposta le peculiarità della tastiera per il computer client.

Parametri:

Nome Tipo Descrizione
quirks Oggetto La tastiera si attiva o disattiva in modo strano.
Nome Tipo Descrizione
macOptionToAlt booleano Per mappare la chiave Option su Alt per macOS, specificare. true In caso contrario, specificare false.
macCommandToControl booleano Per mappare il tasto Comando su Ctrl per macOS, specificare. true In caso contrario, specificare false.

Valori restituiti:

Tipo

void

setMaxDisplayRisoluzione (maxWidth,maxHeight) → {void}

Imposta la risoluzione massima dello schermo da utilizzare per la connessione.

Parametri:

Nome Tipo Descrizione
maxWidth number La larghezza massima dello schermo in pixel. Il valore minimo consentito è0.
maxHeight number L'altezza massima dello schermo in pixel. Il valore minimo consentito è0.

Valori restituiti:

Tipo

void

setMicrophone(abilita) → {Promise|Promessa. < {codice: AudioErrorCode, messaggio: stringa} >}

Attiva o disattiva il microfono.

Parametri:

Nome Tipo Descrizione
enable booleano Per abilitare il microfono, specificaretrue. Per disattivare il microfono, specificatefalse.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

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

setMinDisplayRisoluzione (minWidth,minHeight) → {void}

Imposta la risoluzione minima dello schermo da utilizzare per la connessione. Alcune applicazioni potrebbero richiedere una risoluzione minima dello schermo. Se la risoluzione minima richiesta è maggiore della risoluzione massima supportata dal client, viene utilizzata una strategia di ridimensionamento. Utilizzate questa funzione con attenzione. La strategia di ridimensionamento potrebbe causare un sistema di input touch e mouse meno preciso.

Parametri:

Nome Tipo Descrizione
minWidth number La larghezza minima dello schermo in pixel. Il valore minimo consentito è0.
minHeight number L'altezza minima dello schermo in pixel. Il valore minimo consentito è0.

Valori restituiti:

Tipo

void

setUploadBandwidth(valore) → {numero}

Imposta la larghezza di banda massima da utilizzare per caricare file sul server Amazon. DCV

Parametri:

Nome Tipo Descrizione
value number Il limite massimo di larghezza di banda in kbps. L'intervallo valido è compreso tra 1024 kbps e 102400 kbps.

Valori restituiti:

- Il limite di larghezza di banda impostato. nullse la funzionalità di archiviazione dei file è disabilitata sul server.

Tipo

number

setVolume(volume) → {void}

Imposta il livello del volume da usare per l'audio. L'intervallo valido è compreso tra 0 e 100, dove 0 è il volume più basso e 100 è il volume più alto.

Parametri:

Nome Tipo Descrizione
volume number Il livello di volume da utilizzare.

Valori restituiti:

Tipo

void

setMicrophone(abilita,deviceId) → {Promise|Promessa. < {codice: AudioErrorCode, messaggio: stringa} >}

[Sperimentale: potrebbe cambiare in futuro] Attiva o disattiva il microfono.

Parametri:

Nome Tipo Descrizione
enable booleano Per abilitare il microfono, specificaretrue. Per disattivare il microfono, specificatefalse.
deviceId string L'ID del dispositivo del microfono. Se non deviceId viene fornito, default deviceId viene utilizzato.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

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

setWebcam(abilita,deviceId) → {Promise|Promessa. < {codice: WebcamErrorCode, messaggio: stringa} >}

Attiva o disattiva la webcam.

Parametri:

Nome Tipo Descrizione
enable booleano Per abilitare la webcam, specificaretrue. Per disattivare la webcam, specificarefalse.
deviceId string L'ID del dispositivo della webcam.

Valori restituiti:

Prometti che, in caso di successo, si risolva nella webcam collegata/staccata. deviceId Se rifiutata, la promessa restituisce un oggetto di errore.

Tipo

Promessa. <string>| Promessa. < {codice: WebcamErrorCode, messaggio: stringa} >

syncClipboards() → {booleano}

Sincronizza gli appunti del client locale con gli appunti del server Amazon DCV remoto. La copia automatica deve essere supportata dal browser.

Valori restituiti:

Se gli appunti sono stati sincronizzati, la funzione ritorna. true Se gli appunti non sono stati sincronizzati o se il browser non supporta la copia automatica, la funzione viene ripristinata. false

Tipo

booleano