Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Constantes, funciones y eventos para sesiones de streaming de WorkSpaces aplicaciones integradas de Amazon
<a name="constants-functions-events-embedded-sessions"></a>

Los siguientes temas proporcionan información de referencia sobre las constantes, las funciones y los eventos que puede utilizar para configurar las sesiones de streaming de WorkSpaces aplicaciones integradas.

**Topics**
+ [Uso de `HIDDEN_ELEMENTS`](#constants-hidden-elements)
+ [Funciones para el objeto `AppStream.Embed`](#functions-embed-object)
+ [Eventos para WorkSpaces aplicaciones integradas: sesiones de streaming](#events-embedded-streaming-sessions)
+ [Ejemplos para añadir detectores de eventos y finalizar una sesión de streaming de WorkSpaces aplicaciones integradas](#examples-add-event-listeners-end-embedded-streaming-session)

Los siguientes elementos de la interfaz de usuario de WorkSpaces las aplicaciones se pueden pasar a la opción de `HIDDEN_ELEMENTS` configuración cuando se inicializa una sesión de streaming de WorkSpaces aplicaciones integradas.

## Uso de `HIDDEN_ELEMENTS`
<a name="constants-hidden-elements"></a>

Los siguientes elementos de la interfaz de usuario de WorkSpaces las aplicaciones se pueden pasar como constantes a la opción de `HIDDEN_ELEMENTS` configuración cuando se inicializa una sesión de streaming de WorkSpaces aplicaciones integradas. 

```
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
```

Los tres elementos siguientes se pueden pasar como cadenas a HIDDEN\$1ELEMENTS, en lugar de hacerlo como constantes.


| Cadena | Description (Descripción) | 
| --- | --- | 
| 'adminCommandsButton' | Cuando está conectado a un generador de imágenes de WorkSpaces aplicaciones, el botón Comandos de administración aparece en la esquina superior derecha de la barra de herramientas de WorkSpaces aplicaciones. Al pasar esta cadena a HIDDEN\$1ELEMENTS, se oculta el botón Comandos de administración. | 
| 'softKeyboardButton' | Durante WorkSpaces las sesiones de streaming de aplicaciones en dispositivos táctiles, los usuarios pueden tocar el icono del teclado en la barra de herramientas de WorkSpaces aplicaciones para que aparezca el teclado en pantalla. Al pasar esta cadena a HIDDEN\$1ELEMENTS, se oculta el icono del teclado. | 
| 'keyboardShortcutsButton' | Durante WorkSpaces las sesiones de streaming de aplicaciones en dispositivos táctiles, los usuarios pueden pulsar el icono Fn de la barra de herramientas de WorkSpaces aplicaciones para ver los atajos de teclado. Al pasar esta cadena a HIDDEN\$1ELEMENTS, se oculta el icono Fn. | 

## Funciones para el objeto `AppStream.Embed`
<a name="functions-embed-object"></a>

En la tabla siguiente, se enumeran las funciones que se pueden ejecutar con el objeto `AppStream.Embed`. 


| Función | Description (Descripción) | 
| --- | --- | 
| AppStream.Embed(containerId:string, options:object) | El generador de objetos AppStream.Embed. Este generador inicializa el objeto AppStream.Embed y se comunica con él. Además, utiliza un ID de contenedor div. El ID se usa para inyectar el iframe. También inserta un objeto que incluye las opciones de configuración de (y). appstreamOptions sessionURL HIDDEN\$1ELEMENTS  | 
| endSession() | Esta función finaliza la sesión de streaming, pero no destruye el iframe. Si especifica una URL de redirección, el iframe intenta cargar la URL. Según los encabezados CORS de la página, es posible que la URL no se cargue.  | 
| launchApp(appId:string) | Esta función inicia mediante programación una aplicación con el ID de aplicación que se especificó al crear la imagen.  | 
| launchAppSwitcher() | Esta función envía el AppSwitcher comando al portal de WorkSpaces aplicaciones. Esto activa el comando AppSwitcher en la instancia.  | 
| getSessionState() | Esta función devuelve un objeto para sessionStatus. Para obtener más información, consulte [Eventos para WorkSpaces aplicaciones integradas: sesiones de streaming](#events-embedded-streaming-sessions).  | 
| getUserInterfaceState() | Esta función devuelve un objeto para `UserInterfaceState`. El objeto contiene los pares de clave-valor para lo siguiente:  `sessionStatus`: enumeración de estados `sessionTerminationReason`: cadena `sessionDisconnectionReason`: cadena  Para obtener más información, consulte [Eventos para WorkSpaces aplicaciones integradas: sesiones de streaming](#events-embedded-streaming-sessions).  | 
| addEventListener(name, callback) | Esta función agrega una función de devolución de llamada a la que llamar cuando se activa el evento especificado. Para obtener una lista de los eventos que se pueden activar, consulte [Eventos para WorkSpaces aplicaciones integradas: sesiones de streaming](#events-embedded-streaming-sessions).  | 
| removeEventListener(name, callback) | Esta función elimina la devolución de llamada para los eventos especificados.  | 
| destroy() | Esta función elimina el iframe y limpia los recursos. Esta función no afecta a las sesiones de streaming en curso.  | 

## Eventos para WorkSpaces aplicaciones integradas: sesiones de streaming
<a name="events-embedded-streaming-sessions"></a>

En la siguiente tabla se enumeran los eventos que se pueden activar durante las sesiones de streaming de WorkSpaces aplicaciones integradas.


| Event | Datos | Description (Descripción) | 
| --- | --- | --- | 
| AppStream.Embed.Events.SESSION\$1STATE\$1CHANGE |  `sessionStatus`: `State enumeration` `sessionTerminationReason`: cadena `sessionDisconnectionReason`: cadena  | Este evento se activa cuando se produce cualquier cambio en el estado de la sesión. El evento incluye un mapa de los estados que han cambiado. Para recuperar el estado de la sesión completa, utilice la función `getSessionState()`. A continuación se muestran los estados de sesión: `AppStream.Embed.SessionStatus.Unknown` - La sesión no se ha iniciado ni está reservada. `AppStream.Embed.SessionStatus.Reserved` - La sesión está reservada, pero no se ha iniciado.  `AppStream.Embed.SessionStatus.Started` - El usuario se ha conectado a la sesión y ha comenzado a transmitir en streaming. `AppStream.Embed.SessionStatus Disconnected ` - El usuario se ha desconectado de la sesión. `AppStream.Embed.SessionStatus.Ended` - La sesión se ha marcado como finalizada o expirada.  | 
| AppStream.Embed.Events.SESSION\$1INTERFACE\$1STATE\$1CHANGE | `hiddenElements`: matriz de cadenas  `isFullscreen`: booleano `isSoftKeyboardVisible`: booleano  | Este evento se activa cuando se produce cualquier cambio en el estado de la sesión. El evento incluye un mapa de los estados que han cambiado. Para recuperar el estado de la sesión completa, utilice la función getSessionState(). | 
| AppStream.Embed.Events.SESSION\$1ERROR | `errorCode`: número `errorMessage`: cadena  | Este evento se activa cuando se producen errores durante una sesión. | 

## Ejemplos para añadir detectores de eventos y finalizar una sesión de streaming de WorkSpaces aplicaciones integradas
<a name="examples-add-event-listeners-end-embedded-streaming-session"></a>

Los ejemplos de esta sección muestran cómo hacer lo siguiente:
+ Agregue detectores de eventos para las sesiones de streaming de WorkSpaces aplicaciones integradas.
+ Finalice mediante programación una sesión de streaming de WorkSpaces aplicaciones integradas.

### Ejemplo 1: añadir detectores de eventos para las sesiones de streaming de aplicaciones integradas WorkSpaces
<a name="example-add-event-listeners"></a>

Para agregar detectores de eventos para cambios de estado de sesión, cambios de estado de interfaz de sesión y errores de sesión durante sesiones de streaming integradas, utilice el código siguiente:

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

En este ejemplo, `AppStream.Embed.Events.SESSION_STATE_CHANGE`, `AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE` y `AppStream.Embed.Events.SESSION_ERROR` son nombres de eventos.

Las funciones `updateSessionStateCallback`, `updateUserInterfaceStateCallback` y `errorCallback` son las que se implementan. Estas funciones se pasan a la función `addEventListener` y se las llama cuando se activa un evento.

### Ejemplo 2: Finalizar mediante programación una sesión de streaming de aplicaciones integradas WorkSpaces
<a name="programmatically-end-embedded-streaming-session"></a>

Para finalizar una sesión de streaming de WorkSpaces aplicaciones integradas, utilice la siguiente función:

```
appstreamEmbed.endSession();
```