Costanti, funzioni ed eventi per sessioni di streaming Amazon AppStream 2.0 integrate - Amazon AppStream 2.0
Utilizzo di HIDDEN_ELEMENTSFunzioni per l'oggetto AppStream.EmbedEventi per sessioni di streaming Embedded AppStream 2.0Esempi per aggiungere listener di eventi e terminare una sessione di streaming Embedded AppStream 2.0

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

Costanti, funzioni ed eventi per sessioni di streaming Amazon AppStream 2.0 integrate

I seguenti argomenti forniscono informazioni di riferimento per costanti, funzioni ed eventi che è possibile utilizzare per configurare le sessioni di streaming embedded AppStream 2.0.

I seguenti elementi dell'interfaccia utente AppStream 2.0 possono essere passati all'opzione di HIDDEN_ELEMENTS configurazione quando viene inizializzata una sessione di streaming embedded AppStream 2.0.

Utilizzo di HIDDEN_ELEMENTS

I seguenti elementi dell'interfaccia utente AppStream 2.0 possono essere passati come costanti all'opzione di HIDDEN_ELEMENTS configurazione quando viene inizializzata una sessione di streaming AppStream 2.0 incorporata. 

AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON
AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.CATALOG_BUTTON
AppStream.Embed.Elements.WINDOW_SWITCHER_BUTTON
AppStream.Embed.Elements.FILES_BUTTON
AppStream.Embed.Elements.CLIPBOARD_BUTTON
AppStream.Embed.Elements.COPY_LOCAL_BUTTON
AppStream.Embed.Elements.PASTE_REMOTE_BUTTON
AppStream.Embed.Elements.SETTINGS_BUTTON
AppStream.Embed.Elements.STREAMING_MODE_BUTTON
AppStream.Embed.Elements.SCREEN_RESOLUTION_BUTTON
AppStream.Embed.Elements.REGIONAL_SETTINGS_BUTTON
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON

I tre elementi seguenti possono essere passati come stringhe in HIDDEN _ELEMENTS, anziché come costanti.

Stringa Descrizione
'adminCommandsButton' Quando si è connessi a un generatore di immagini AppStream 2.0, il pulsante Admin Commands viene visualizzato nell'angolo superiore destro della barra degli AppStream strumenti 2.0. Passando questa stringa in HIDDEN_ELEMENTS nasconde il pulsante Comandi di amministrazione.
'softKeyboardButton' Durante le sessioni di streaming AppStream 2.0 su dispositivi touch, gli utenti possono toccare l'icona della tastiera sulla barra degli strumenti AppStream 2.0 per visualizzare la tastiera su schermo. Passando questa stringa in HIDDEN_ELEMENTS nasconde l'icona della tastiera.
'keyboardShortcutsButton' Durante le sessioni di streaming AppStream 2.0 su dispositivi touch, gli utenti possono toccare l'icona Fn sulla barra degli strumenti 2.0 per visualizzare le scorciatoie da tastiera. AppStream Passando questa stringa in HIDDEN_ELEMENTS nasconde l'icona Fn.

Funzioni per l'oggetto AppStream.Embed

Nella tabella seguente sono elencate le funzioni che possono essere eseguite sull'oggetto AppStream.Embed.

Funzione Descrizione
AppStream.Embed(containerId:string, options:object) Il costruttore di oggetti AppStream.Embed. Questo costruttore inizializza e comunica con l'oggetto AppStream.Embed e utilizza un ID container div. L'ID viene utilizzato per inserire l'iframe. Inoltre, inietta un oggetto che include le opzioni di configurazione per (appstreamOptionssessionURL eHIDDEN_ELEMENTS).
endSession() Questa funzione termina la sessione di streaming, ma non distrugge l'iframe. Se si specifica un reindirizzamentoURL, l'iframe tenta di caricare il. URL A seconda delle CORS intestazioni della pagina, URL potrebbe non caricarsi.
launchApp(appId:string) Questa funzione avvia a livello di codice un'applicazione con l'ID dell'applicazione specificato durante la creazione dell'immagine.
launchAppSwitcher() Questa funzione invia il AppSwitcher comando al portale AppStream 2.0. Questo attiva il comando AppSwitcher sull'istanza.
getSessionState() Questa funzione restituisce un oggetto per sessionStatus. Per ulteriori informazioni, consulta Eventi per sessioni di streaming Embedded AppStream 2.0.
getUserInterfaceState()

Questa funzione restituisce un oggetto per UserInterfaceState. L'oggetto contiene le coppie chiave-valore per quanto segue:

sessionStatus: enumerazione dello stato

sessionTerminationReason: Stringa

sessionDisconnectionReason: Stringa

Per ulteriori informazioni, consulta Eventi per sessioni di streaming Embedded AppStream 2.0.
addEventListener(name, callback) Questa funzione aggiunge una funzione di callback per chiamare quando viene attivato l'evento specificato. Per un elenco degli eventi che possono essere attivati, consulta Eventi per sessioni di streaming Embedded AppStream 2.0.
removeEventListener(name, callback) Questa funzione rimuove il callback per gli eventi specificati.
destroy() Questa funzione elimina l'iframe e pulisce le risorse. Questa funzione non influisce sulle sessioni di streaming in corso.

Eventi per sessioni di streaming Embedded AppStream 2.0

La tabella seguente elenca gli eventi che possono essere attivati durante le sessioni di streaming embedded AppStream 2.0.

Evento Dati Descrizione
AppStream.Embed.Events.SESSION_STATE_CHANGE

sessionStatus: State enumeration

sessionTerminationReason: Stringa

sessionDisconnectionReason: Stringa

Questo evento viene attivato quando si verifica una modifica dello stato della sessione. L'evento include una mappa degli stati modificati. Per recuperare lo stato della sessione completa, utilizzare la funzione getSessionState().

Di seguito sono riportati gli stati di sessione:

AppStream.Embed.SessionStatus.Unknown: la sessione non è iniziata e non è riservata

AppStream.Embed.SessionStatus.Reserved: la sessione è riservata ma non è iniziata.

AppStream.Embed.SessionStatus.Started: l'utente si è collegato alla sessione e ha avviato lo streaming.

AppStream.Embed.SessionStatus Disconnected : l'utente si è disconnesso dalla sessione.

AppStream.Embed.SessionStatus.Ended: la sessione è stata contrassegnata come terminata o scaduta.
AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE

hiddenElements: array di stringhe

isFullscreen: Booleano

isSoftKeyboardVisible: Booleano

 Questo evento viene attivato quando si verifica una modifica dello stato della sessione. L'evento include una mappa degli stati modificati. Per recuperare lo stato della sessione completa, utilizzare la funzione getSessionState().
AppStream.Embed.Events.SESSION_ERROR

errorCode: numero

errorMessage: Stringa

 Questo evento viene attivato quando si verificano errori durante una sessione.

Esempi per aggiungere listener di eventi e terminare una sessione di streaming Embedded AppStream 2.0

Gli esempi in questa sezione mostrano come eseguire le operazioni seguenti:

  • Aggiungi listener di eventi per sessioni di streaming AppStream 2.0 integrate.

  • Termina in modo programmatico una sessione di streaming AppStream 2.0 integrata.

Esempio 1: aggiungere listener di eventi per sessioni di streaming 2.0 integrate AppStream

Per aggiungere listener di eventi per le modifiche dello stato della sessione, le modifiche dello stato dell'interfaccia della sessione e gli errori di sessione durante le sessioni di streaming incorporate, utilizzare il codice seguente:

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_STATE_CHANGE, updateSessionStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE, updateUserInterfaceStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_ERROR, errorCallback);

In questo esempio, AppStream.Embed.Events.SESSION_STATE_CHANGE, AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE e AppStream.Embed.Events.SESSION_ERROR sono nomi di eventi.

Le funzioni updateSessionStateCallback, updateUserInterfaceStateCallback e errorCallback sono quelle implementate. Queste funzioni passano nella funzione addEventListener e chiamate quando viene attivato un evento.

Esempio 2: terminare a livello di codice una sessione di streaming 2.0 incorporata AppStream

Per terminare una sessione di streaming AppStream 2.0 incorporata, utilizzate la seguente funzione:

appstreamEmbed.endSession();