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

Metodi

List

attachDisplay (win, displayConf) → {Promessa. <number>|Promessa. < {codice: MultiMonitorErrorCode, messaggio: stringa} >}
captureClipboardEvents(abilitato, win, displayID) → {void}
detachDisplay (displayID) → {void}
disconnetti () → {void}
DisconnectCollaborator (ConnectionId) → {void}
enableDisplayQualityAggiornamenti (abilita) → {void}
enableHighPixelDensità (abilita) → {void}
enableTimezoneRedirection(abilita) → {Promise|Promessa. < {codice: TimezoneRedirectionErrorCode, messaggio: stringa} >}
enterRelativeMouseModalità () → {void}
getConnectedDevices() → {Promessa. <Array. < MediaDeviceInfo >>|Promessa. < {message: string} >}
getFileExplorer() → {Promessa. < filestorage >|Promessa. < {codice: ChannelErrorCode, messaggio: stringa} >}
getServerInfo() → {Informazioni sul server}
getScreenshot () → {Promise|Promessa. < {codice: ScreenshotErrorCode, messaggio: stringa} >}
getStats () → {stats}
latchModifierKey(chiave, posizione, isDown) → {boolean}
openChannel (name, authToken, callback, namespace) → {Promise|Promise. < {codice:, messaggio: stringa} >} ChannelErrorCode
queryFeature (featureName) → {Promessa. < {abilitato: booleano, remoto? : stringa, copia automatica? : booleano, autoPaste? : booleano, ServiceStatus? : stringa, disponibile? : boolean} >|Promessa. < {message: string} >}
registerKeyboardShortcuts(scorciatoie) → {void}
requestDisplayConfig(highColorAccuracy) → {Promise|Promessa. < {codice: DisplayConfigErrorCode, messaggio: stringa} >}
requestDisplayLayout(layout) → {Promise|Promessa. < {codice: ResolutionErrorCode, messaggio: stringa} >}
RequestResolution (larghezza, altezza) → {Promise|Promessa. < {codice: ResolutionErrorCode, messaggio: stringa} >}
sendKeyboardEvent(evento) → {booleano}
sendKeyboardShortcut(scorciatoia) → {void}
setDisplayQuality(min, maxopt) → {void}
setDisplayScale(ScaleRatio, displayID) → {Promise|Promessa. < {code: ResolutionErrorCode, message: string} >} (OBSOLETO)
setKeyboardQuirks(stranezze) → {void}
setMaxDisplayRisoluzione (maxWidth, maxHeight) → {void}
setMicrophone (abilita) → {Promise|Promessa. < {codice: AudioErrorCode, messaggio: stringa} >}
setMinDisplayRisoluzione (minWidth, minHeight) → {void}
setUploadBandwidth(valore) → {numero}
setVolume (volume) → {void}
setMicrophone (enable, deviceID) → {Promise|Promise. < {codice: AudioErrorCode, messaggio: stringa} >}
setWebcam (abilita, deviceID) → {Promise|Promessa. < {codice: WebcamErrorCode, messaggio: stringa} >}
syncClipboards () → {booleano}

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:

Name Tipo Description

win Oggetto La finestra a cui deve essere collegato lo schermo.

displayConf

Oggetto

La configurazione dello schermo.

Name	Tipo	Attributes	Description
`displayId`	numero	<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. copy/paste Potrebbe essere utile avviare e interrompere l'ascolto solo quando è necessario, ad esempio quando viene mostrato un modale.

Parametri:

Name	Tipo	Attributes	Description
`enabled`	booleano		Per iniziare ad ascoltare gli eventi, specifica`true`. Per interrompere l'ascolto degli eventi, specificare`false`.
`win`	Oggetto	<optional>	La finestra in cui ascoltare gli eventi. Se omesso, viene utilizzata la finestra predefinita.
`displayId`	numero	<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 un display specifico. Lo schermo principale non può essere rimosso.

Parametri:

Name	Tipo	Descrizione
`displayId`	numero	L'ID dello schermo da scollegare.

Valori restituiti:

Tipo: void

disconnetti () → {void}

Si disconnette dal server Amazon DCV 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 versione 1.1.0 di Amazon DCV Web Client SDK).

Parametri:

Name	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:

Name	Tipo	Descrizione
`enable`	booleano	Per abilitare gli aggiornamenti della qualità dello schermo, specificare. `true` Per disabilitare gli aggiornamenti della qualità dello schermo, specificare`false`.

Valori restituiti:

Tipo: void

enableHighPixelDensità (abilita) → {void}

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

Parametri:

Name	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:

Name	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 server Amazon DCV.

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() → {Informazioni sul server}

Ottiene informazioni sul server Amazon DCV.

Valori restituiti:

Informazioni sul software del server.

Tipo: Informazioni sul server

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

Recupera lo screenshot del desktop remoto in formato PNG. 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 rifiutato, riceviamo un oggetto di errore.

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

getStats () → {stats}

Ottiene statistiche sul server Amazon DCV.

Valori restituiti:

Informazioni sulle statistiche di streaming.

Tipo: statistiche

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

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

Parametri:

Name	Tipo	Description
`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 (name, authToken, callback, namespace) → {Promise|Promise. < {codice:, messaggio: stringa} >} ChannelErrorCode

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

Parametri:

Name	Tipo	Description
`name`	stringa	Nome del canale.
`authToken`	stringa	Il token di autenticazione da utilizzare per connettersi al canale.
`callbacks`	Oggetto	Le funzioni di callback onMessage e onClose da chiamare.
`namespace`	stringa	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. < {abilitato: booleano, remoto? : stringa, copia automatica? : booleano, autoPaste? : booleano, ServiceStatus? : stringa, disponibile? : boolean} >|Promessa. < {message: string} >}

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

Parametri:

Name	Tipo	Description
`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, copia automatica? : booleano, autoPaste? : booleano, ServiceStatus? : stringa, disponibile? : boolean} > | Promessa. < {message: string} >

registerKeyboardShortcuts(scorciatoie) → {void}

Registra le scorciatoie da tastiera.

Parametri:

Name Tipo Description

shortcuts

Array. <Object>

L'array di chiavi e mappature da registrare.

Name Tipo Description

sequence

Array. <Object>

La scorciatoia da tastiera per la registrazione.

Name	Tipo	Description
`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.

Name	Tipo	Description
`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:

Name	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:

Name	Tipo	Description
`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 server Amazon DCV.

Parametri:

Name	Tipo	Descrizione
`width`	numero	La larghezza da richiedere in pixel. Il valore minimo consentito è`0`.
`height`	numero	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:

Name	Tipo	Description
`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:

Name Tipo Description

shortcut

Array. <Object>

L'array di chiavi da inviare.

Name	Tipo	Description
`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:

Name	Tipo	Attributes	Description
`min`	numero		La qualità minima dell'immagine.
`max`	numero	<optional>	La massima qualità dell'immagine.

Valori restituiti:

Tipo: void

setDisplayScale(ScaleRatio, displayID) → {Promise|Promessa. < {code: ResolutionErrorCode, message: string} >} (OBSOLETO)

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:

Name	Tipo	Description
`scaleRatio`	virgola mobile	Il rapporto di scala da utilizzare. Deve essere un numero strettamente positivo.
`displayId`	numero	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:

Name Tipo Description

quirks

Oggetto

La tastiera si attiva o disattiva.

Name	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:

Name	Tipo	Descrizione
`maxWidth`	numero	La larghezza massima dello schermo in pixel. Il valore minimo consentito è`0`.
`maxHeight`	numero	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:

Name	Tipo	Descrizione
`enable`	booleano	Per abilitare il microfono, specificare`true`. Per disattivare il microfono, specificate`false`.

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:

Name	Tipo	Descrizione
`minWidth`	numero	La larghezza minima dello schermo in pixel. Il valore minimo consentito è`0`.
`minHeight`	numero	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:

Name	Tipo	Descrizione
`value`	numero	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: numero

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:

Name	Tipo	Descrizione
`volume`	numero	Il livello di volume da utilizzare.

Valori restituiti:

Tipo: void

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

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

Parametri:

Name	Tipo	Descrizione
`enable`	booleano	Per abilitare il microfono, specificare`true`. Per disattivare il microfono, specificate`false`.
`deviceId`	stringa	L'ID del dispositivo del microfono. Se non viene fornito alcun DeviceID, viene utilizzato il `default` DeviceID.

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:

Name	Tipo	Descrizione
`enable`	booleano	Per abilitare la webcam, specificare`true`. Per disattivare la webcam, specificare`false`.
`deviceId`	stringa	L'ID del dispositivo della webcam.

Valori restituiti:

Prometti che, in caso di successo, si risolva nel DeviceID della attached/detached webcam. 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

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Modulo DCV

Classe di autenticazione