Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Konstanta, Fungsi, dan Acara untuk Sesi Streaming WorkSpaces Aplikasi Amazon Tertanam
<a name="constants-functions-events-embedded-sessions"></a>

Topik berikut memberikan informasi referensi untuk konstanta, fungsi, dan peristiwa yang dapat Anda gunakan untuk mengonfigurasi sesi streaming WorkSpaces Aplikasi yang disematkan.

**Topics**
+ [Bekerja dengan `HIDDEN_ELEMENTS`](#constants-hidden-elements)
+ [Fungsi untuk `AppStream.Embed` Objek](#functions-embed-object)
+ [Acara untuk Sesi Streaming WorkSpaces Aplikasi Tertanam](#events-embedded-streaming-sessions)
+ [Contoh untuk Menambahkan Pendengar Acara dan Mengakhiri Sesi Streaming WorkSpaces Aplikasi Tertanam](#examples-add-event-listeners-end-embedded-streaming-session)

Elemen antarmuka pengguna WorkSpaces Aplikasi berikut dapat diteruskan ke opsi `HIDDEN_ELEMENTS` konfigurasi saat sesi streaming WorkSpaces Aplikasi tertanam diinisialisasi.

## Bekerja dengan `HIDDEN_ELEMENTS`
<a name="constants-hidden-elements"></a>

Elemen antarmuka pengguna WorkSpaces Aplikasi berikut dapat diteruskan sebagai konstanta ke dalam opsi `HIDDEN_ELEMENTS` konfigurasi saat sesi streaming WorkSpaces Aplikasi tertanam diinisialisasi. 

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

Tiga elemen berikut dapat diteruskan sebagai string ke HIDDEN\$1ELEMENTS, bukan sebagai konstanta.


| String | Deskripsi | 
| --- | --- | 
| 'adminCommandsButton' | Saat Anda terhubung ke pembuat gambar WorkSpaces Aplikasi, tombol Perintah Admin ditampilkan di sudut kanan atas toolbar WorkSpaces Aplikasi. Melewati string ini ke HIDDEN\$1ELEMENTS menyembunyikan tombol Perintah Admin. | 
| 'softKeyboardButton' | Selama sesi streaming WorkSpaces Aplikasi pada perangkat berkemampuan sentuh, pengguna dapat mengetuk ikon keyboard pada bilah alat WorkSpaces Aplikasi untuk menampilkan keyboard di layar. Melewati string ini ke HIDDEN\$1ELEMENTS menyembunyikan ikon keyboard. | 
| 'keyboardShortcutsButton' | Selama sesi streaming WorkSpaces Aplikasi pada perangkat yang mendukung sentuhan, pengguna dapat mengetuk ikon Fn pada bilah alat WorkSpaces Aplikasi untuk menampilkan pintasan keyboard. Melewati string ini ke HIDDEN\$1ELEMENTS menyembunyikan ikon Fn. | 

## Fungsi untuk `AppStream.Embed` Objek
<a name="functions-embed-object"></a>

Tabel berikut mencantumkan fungsi yang dapat dilakukan pada `AppStream.Embed` objek. 


| Fungsi | Deskripsi | 
| --- | --- | 
| AppStream.Embed(containerId:string, options:object) | Konstruktor AppStream.Embed objek. Konstruktor ini menginisialisasi dan berkomunikasi dengan AppStream.Embed objek, dan menggunakan ID kontainer div. ID digunakan untuk menyuntikkan iframe. Ini juga menyuntikkan objek yang mencakup opsi konfigurasi untuk appstreamOptions (sessionURLdanHIDDEN\$1ELEMENTS).  | 
| endSession() | Fungsi ini mengakhiri sesi streaming, tetapi tidak merusak iframe. Jika Anda menentukan URL pengalihan, iframe mencoba memuat URL. Bergantung pada header CORS halaman, URL mungkin tidak dimuat.  | 
| launchApp(appId:string) | Fungsi ini secara terprogram meluncurkan aplikasi dengan ID aplikasi yang ditentukan selama pembuatan gambar.  | 
| launchAppSwitcher() | Fungsi ini mengirimkan AppSwitcher perintah ke portal WorkSpaces Aplikasi. Ini memicu AppSwitcher perintah pada instance.  | 
| getSessionState() | Fungsi ini mengembalikan sebuah objek untuksessionStatus. Untuk informasi selengkapnya, lihat [Acara untuk Sesi Streaming WorkSpaces Aplikasi Tertanam](#events-embedded-streaming-sessions).  | 
| getUserInterfaceState() | Fungsi ini mengembalikan sebuah objek untuk`UserInterfaceState`. Objek berisi pasangan kunci-nilai untuk berikut:  `sessionStatus`: Pencacahan negara `sessionTerminationReason`: String `sessionDisconnectionReason`: String  Untuk informasi selengkapnya, lihat [Acara untuk Sesi Streaming WorkSpaces Aplikasi Tertanam](#events-embedded-streaming-sessions).  | 
| addEventListener(name, callback) | Fungsi ini menambahkan fungsi callback untuk memanggil ketika peristiwa tertentu dipicu. Untuk daftar peristiwa yang dapat dipicu, lihat[Acara untuk Sesi Streaming WorkSpaces Aplikasi Tertanam](#events-embedded-streaming-sessions).  | 
| removeEventListener(name, callback) | Fungsi ini menghapus callback untuk peristiwa tertentu.  | 
| destroy() | Fungsi ini menghapus iframe dan membersihkan sumber daya. Fungsi ini tidak memengaruhi sesi streaming yang sedang berlangsung.  | 

## Acara untuk Sesi Streaming WorkSpaces Aplikasi Tertanam
<a name="events-embedded-streaming-sessions"></a>

Tabel berikut mencantumkan peristiwa yang dapat dipicu selama sesi streaming WorkSpaces Aplikasi tertanam.


| Peristiwa | Data | Deskripsi | 
| --- | --- | --- | 
| AppStream.Embed.Events.SESSION\$1STATE\$1CHANGE |  `sessionStatus`: `State enumeration` `sessionTerminationReason`: String `sessionDisconnectionReason`: String  | Peristiwa ini dipicu ketika terjadi perubahan status sesi. Acara ini mencakup peta negara bagian yang berubah. Untuk mengambil status sesi penuh, gunakan `getSessionState()` fungsi. Berikut ini adalah status sesi: `AppStream.Embed.SessionStatus.Unknown`— Sesi belum dimulai dan tidak dicadangkan `AppStream.Embed.SessionStatus.Reserved`— Sesi dicadangkan tetapi belum dimulai.  `AppStream.Embed.SessionStatus.Started`— Pengguna terhubung ke sesi dan mulai streaming. `AppStream.Embed.SessionStatus Disconnected `— Pengguna terputus dari sesi. `AppStream.Embed.SessionStatus.Ended`— Sesi ditandai sebagai berakhir atau kedaluwarsa.  | 
| AppStream.Embed.Events.SESSION\$1INTERFACE\$1STATE\$1CHANGE | `hiddenElements`: Array string  `isFullscreen`: Boolean `isSoftKeyboardVisible`: Boolean  | Peristiwa ini dipicu ketika terjadi perubahan status sesi. Acara ini mencakup peta negara bagian yang berubah. Untuk mengambil status sesi penuh, gunakan getSessionState() fungsi. | 
| AppStream.Embed.Events.SESSION\$1ERROR | `errorCode`: Angka `errorMessage`: String  | Peristiwa ini dipicu ketika ada kesalahan yang terjadi selama sesi. | 

## Contoh untuk Menambahkan Pendengar Acara dan Mengakhiri Sesi Streaming WorkSpaces Aplikasi Tertanam
<a name="examples-add-event-listeners-end-embedded-streaming-session"></a>

Contoh di bagian ini menunjukkan cara melakukan hal berikut:
+ Tambahkan pendengar acara untuk sesi streaming WorkSpaces Aplikasi yang disematkan.
+ Akhiri sesi streaming WorkSpaces Aplikasi yang disematkan secara terprogram.

### Contoh 1: Tambahkan pendengar acara untuk sesi streaming WorkSpaces Aplikasi yang disematkan
<a name="example-add-event-listeners"></a>

Untuk menambahkan pendengar acara untuk perubahan status sesi, perubahan status antarmuka sesi, dan kesalahan sesi selama sesi streaming tertanam, gunakan kode berikut:

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

Dalam contoh ini,`AppStream.Embed.Events.SESSION_STATE_CHANGE`,`AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE`, dan `AppStream.Embed.Events.SESSION_ERROR` merupakan nama acara.

Fungsi `updateSessionStateCallback``updateUserInterfaceStateCallback`, dan `errorCallback` fungsi adalah yang Anda terapkan. Fungsi-fungsi ini diteruskan ke `addEventListener` fungsi dan dipanggil ketika suatu peristiwa dipicu.

### Contoh 2: Akhiri sesi streaming WorkSpaces Aplikasi yang disematkan secara terprogram
<a name="programmatically-end-embedded-streaming-session"></a>

Untuk mengakhiri sesi streaming WorkSpaces Aplikasi yang disematkan, gunakan fungsi berikut:

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