Constantes, fonctions et événements pour les sessions de streaming Amazon AppStream 2.0 intégrées - Amazon AppStream 2.0
Utilisation de l’option HIDDEN_ELEMENTSFonctions pour l'objet AppStream.EmbedÉvénements pour les sessions de streaming intégrées AppStream 2.0Exemples d'ajout d'écouteurs d'événements et de fin d'une session de streaming AppStream 2.0 intégrée

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Constantes, fonctions et événements pour les sessions de streaming Amazon AppStream 2.0 intégrées

Les rubriques suivantes fournissent des informations de référence sur les constantes, les fonctions et les événements que vous pouvez utiliser pour configurer des sessions de streaming AppStream 2.0 intégrées.

Les éléments d'interface utilisateur AppStream 2.0 suivants peuvent être transmis à l'option HIDDEN_ELEMENTS de configuration lorsqu'une session de streaming AppStream 2.0 intégrée est initialisée.

Utilisation de l’option HIDDEN_ELEMENTS

Les éléments d'interface utilisateur AppStream 2.0 suivants peuvent être transmis sous forme de constantes à l'option HIDDEN_ELEMENTS de configuration lorsqu'une session de streaming AppStream 2.0 intégrée est initialisée. 

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

Les trois éléments suivants peuvent être transmis sous forme de chaînes dans HIDDEN _ELEMENTS, plutôt que sous forme de constantes.

Chaîne Description
'adminCommandsButton' Lorsque vous êtes connecté à un générateur d'images AppStream 2.0, le bouton Commandes d'administration s'affiche dans le coin supérieur droit de la barre d'outils AppStream 2.0. La transmission de cette chaîne dans HIDDEN_ELEMENTS masque le bouton Commandes d’administration.
'softKeyboardButton' Pendant les sessions de streaming AppStream 2.0 sur des appareils tactiles, les utilisateurs peuvent appuyer sur l'icône du clavier dans la barre d'outils AppStream 2.0 pour afficher le clavier à l'écran. La transmission de cette chaîne dans HIDDEN_ELEMENTS masque l’icône du clavier.
'keyboardShortcutsButton' Pendant les sessions de streaming AppStream 2.0 sur des appareils tactiles, les utilisateurs peuvent appuyer sur l'icône Fn dans la barre d'outils AppStream 2.0 pour afficher les raccourcis clavier. La transmission de cette chaîne dans HIDDEN_ELEMENTS masque l’icône Fn.

Fonctions pour l'objet AppStream.Embed

Le tableau suivant répertorie les fonctions qui peuvent être exécutées sur l'objet AppStream.Embed.

Fonction Description
AppStream.Embed(containerId:string, options:object) Constructeur d'objet AppStream.Embed. Ce constructeur initialise et communique avec l'objet AppStream.Embed et il utilise un ID de conteneur div. L'ID est utilisé pour injecter l'iframe. Il injecte également un objet qui inclut les options de configuration pour appstreamOptions (sessionURL etHIDDEN_ELEMENTS).
endSession() Cette fonction met fin à la session de streaming, mais ne détruit pas l'iframe. Si vous spécifiez une redirectionURL, l'iframe tente de charger leURL. Selon les CORS en-têtes de la page, il est URL possible qu'elles ne se chargent pas.
launchApp(appId:string) Cette fonction lance par programmation une application ayant l’ID d’application spécifié lors de la création de l’image.
launchAppSwitcher() Cette fonction envoie la AppSwitcher commande au portail AppStream 2.0. Cela déclenche la commande AppSwitcher sur l'instance.
getSessionState() Cette fonction renvoie un objet pour sessionStatus. Pour plus d’informations, consultez Événements pour les sessions de streaming intégrées AppStream 2.0.
getUserInterfaceState()

Cette fonction renvoie un objet pour UserInterfaceState. L'objet contient les paires clé-valeur pour les éléments suivants :

sessionStatus : énumération d’état

sessionTerminationReason : chaîne

sessionDisconnectionReason : chaîne

Pour plus d’informations, consultez Événements pour les sessions de streaming intégrées AppStream 2.0.
addEventListener(name, callback) Cette fonction ajoute une fonction de rappel à appeler lorsque l'événement spécifié est déclenché. Pour obtenir la liste des événements pouvant être déclenchés, consultez Événements pour les sessions de streaming intégrées AppStream 2.0.
removeEventListener(name, callback) Cette fonction supprime le rappel pour les événements spécifiés.
destroy() Cette fonction supprime l'iframe et nettoie les ressources. Cette fonction n'affecte pas les sessions de streaming en cours.

Événements pour les sessions de streaming intégrées AppStream 2.0

Le tableau suivant répertorie les événements qui peuvent être déclenchés lors de sessions de streaming AppStream 2.0 intégrées.

Événement Données Description
AppStream.Embed.Events.SESSION_STATE_CHANGE

sessionStatus: State enumeration

sessionTerminationReason : chaîne

sessionDisconnectionReason : chaîne

Cet événement est déclenché lorsqu’un changement d’état de session se produit. L’événement inclut une carte des états qui ont changé. Pour récupérer l’état complet de la session, utilisez la fonction getSessionState().

Voici les états de session :

AppStream.Embed.SessionStatus.Unknown : la session n’a pas démarré et n’est pas réservée.

AppStream.Embed.SessionStatus.Reserved : la session est réservée mais n’a pas démarré.

AppStream.Embed.SessionStatus.Started : l’utilisateur s’est connecté à la session et a commencé le streaming.

AppStream.Embed.SessionStatus Disconnected  : l’utilisateur s’est déconnecté de la session.

AppStream.Embed.SessionStatus.Ended : la session a été marquée comme terminée ou expirée.
AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE

hiddenElements : tableau de chaînes

isFullscreen : valeur booléenne

isSoftKeyboardVisible : valeur booléenne

 Cet événement est déclenché lorsqu’un changement d’état de session se produit. L’événement inclut une carte des états qui ont changé. Pour récupérer l’état complet de la session, utilisez la fonction getSessionState().
AppStream.Embed.Events.SESSION_ERROR

errorCode : nombre

errorMessage : chaîne

 Cet événement est déclenché lorsque des erreurs se produisent au cours d'une session.

Exemples d'ajout d'écouteurs d'événements et de fin d'une session de streaming AppStream 2.0 intégrée

Les exemples de cette section montrent comment effectuer les opérations suivantes :

  • Ajoutez des écouteurs d'événements pour les sessions de streaming AppStream 2.0 intégrées.

  • Mettez fin par programmation à une session de streaming AppStream 2.0 intégrée.

Exemple 1 : ajouter des écouteurs d'événements pour les sessions de streaming AppStream 2.0 intégrées

Pour ajouter des écouteurs d'événements pour les modifications d'état de session, les modifications d'état de l'interface de session et les erreurs de session pendant les sessions de streaming intégrées, utilisez le code suivant :

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);

Dans cet exemple, AppStream.Embed.Events.SESSION_STATE_CHANGE, AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE et AppStream.Embed.Events.SESSION_ERROR sont des noms d’événements.

Les fonctions updateSessionStateCallback, updateUserInterfaceStateCallback et errorCallback sont celles que vous implémentez. Ces fonctions sont transmises à la fonction addEventListener et appelées lorsqu'un événement est déclenché.

Exemple 2 : Fin par programmation d'une session de streaming AppStream 2.0 intégrée

Pour mettre fin à une session de streaming AppStream 2.0 intégrée, utilisez la fonction suivante :

appstreamEmbed.endSession();