Einbetten von AppStream-2.0-Streaming-Sitzungen - Amazon AppStream 2.0
VoraussetzungenEmpfehlungen und NutzungsüberlegungenSchritt 1: Angeben einer Host-Domain für eingebettete AppStream-2.0-Streaming-SitzungenSchritt 2: Erstellen einer Streaming-URL für die BenutzerauthentifizierungSchritt 3: Herunterladen der eingebetteten AppStream-2.0-DateienSchritt 4. Konfigurieren Ihrer Website für die Integration mit AppStream 2.0Konstanten, Funktionen und Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Einbetten von AppStream-2.0-Streaming-Sitzungen

Sie können ein dynamisches, interaktives und individuelles Erlebnis für Ihre Benutzer erstellen, indem Sie eine AppStream-2.0-Streaming-Sitzung in Ihre Website einbetten. Mit eingebetteten AppStream-2.0-Streaming-Sitzungen können Benutzer direkt von Ihrer Website aus mit 3D-Modellen, Karten und Datensätzen interagieren. Beispielsweise können sich Benutzer neben ihrer AppStream-2.0-Streaming-Sitzung Trainingsanweisungen oder Lehrmaterialien anzeigen lassen.

Voraussetzungen

Zum Einbetten einer AppStream-2.0-Streaming-Sitzung in eine Website benötigen Sie Folgendes:

Empfehlungen und Nutzungsüberlegungen

Beachten Sie die folgenden Empfehlungen und Verwendungshinweise für eingebettete AppStream-2.0-Streaming-Sitzungen.

  • Wir empfehlen Ihnen, kurzlebige Streaming-URLs zu konfigurieren, die etwa 5 Sekunden lang andauern, um maximale Kontrolle über das eingebettete AppStream-2.0-Streaming-Erlebnis für Ihre Benutzer zu wahren. Jeder Benutzer kann den Inhalt einer Webseite überprüfen und deren Quelle anzeigen. Dazu gehören das Document Object Model (DOM) und die src-(source)-URL des iframe. Wenn die URL immer noch gültig ist, wenn ein Benutzer sie kopiert, kann dieser Benutzer die URL in eine separate Browserregisterkarte einfügen und die Sitzung mit der standardmäßigen AppStream-2.0-Portalbenutzeroberfläche streamen, ohne die Einbettungsoptionen.

  • Gleichzeitige Sitzungen werden nicht unterstützt, wenn benutzerdefinierte Domains für eingebettete AppStream-2.0-Streaming-Sitzungen verwendet werden. Gleichzeitige Sitzungen treten auf, wenn Benutzer zwei eingebettete AppStream-2.0-Streaming-Sitzungen entweder auf derselben Webseite oder über zwei verschiedene Browser-Registerkarten starten. Sie können keinen einzelnen Benutzer mit gleichzeitigen Sitzungen haben, aber Sie können mehrere Benutzer haben. Beispiel: Ein Benutzer meldet sich bei Ihrer App an. Ihre App generiert eine Streaming-URL, die an den Kunden weitergegeben wird (und die für die Abrechnung als individueller Benutzer zählt). Der Kunde lädt die Streaming-URL und wird einer AppStream-Instance innerhalb des von Ihnen festgelegten Pools zugeordnet.

Schritt 1: Angeben einer Host-Domain für eingebettete AppStream-2.0-Streaming-Sitzungen

Zum Einbetten einer AppStream-2.0-Streaming-Sitzung in eine Webseite aktualisieren Sie zunächst Ihren Stack, um die Domain anzugeben, in der die eingebettete Streaming-Sitzung gehostet wird. Dies ist eine Sicherheitsmaßnahme, um sicherzustellen, dass nur autorisierte Website-Domains AppStream-2.0-Streaming-Sitzungen einbetten können. AppStream 2.0 fügt die von Ihnen angegebene(n) Domain(s) in den Header Content-Security-Policy (CSP) ein. Weitere Informationen finden Sie unter Content Security Policy (CSP) in der Mozilla-Dokumentation MDN Web Docs.

Verwenden Sie eine der folgenden Methoden, um den Stack zu aktualisieren, um die Domäne anzugeben, in der die eingebettete Streaming-Sitzung gehostet wird:

  • AppStream-2.0-Konsole

  • API-Aktion EmbedHostDomains

  • Befehl der AWS-Befehlszeilenschnittstelle (AWS-CLI) embed-host-domains

Führen Sie die folgenden Schritte aus, um mithilfe der AppStream-2.0-Konsole eine Host-Domain anzugeben.

  1. Öffnen Sie die AppStream-2.0-Konsole unter https://console.aws.amazon.com/appstream2.

  2. Wählen Sie im linken Navigationsbereich Stacks aus und wählen Sie dann den Stack aus.

  3. Wählen Sie Edit (Bearbeiten) aus.

  4. Erweitern Sie Einbetten von AppStream 2.0 (optional).

  5. Geben Sie unter Host-Domains eine gültige Domain an. Beispiel: training.example.com.

    Anmerkung

    Eingebettete Streaming-Sitzungen werden nur über HTTPS [TCP-Port 443] unterstützt.

  6. Wählen Sie Aktualisieren aus.

Schritt 2: Erstellen einer Streaming-URL für die Benutzerauthentifizierung

Sie müssen eine Streaming-URL erstellen, um Benutzer für eingebettete AppStream-2.0-Streaming-Sitzungen zu authentifizieren. SAML 2.0 und Benutzerpools werden derzeit nicht für eingebettete Streaming-Sitzungen unterstützt. Verwenden Sie eine der folgenden Methoden, um eine Streaming-URL zu erstellen:

Konfigurationsanforderungen für die Verwendung benutzerdefinierter Domänen

Unabhängig davon, ob Sie benutzerdefinierte Domains verwenden, um Ihr Firmenbranding anzuwenden oder um sicherzustellen, dass eingebettete AppStream-2.0-Streaming-Sitzungen mit Browsern funktionieren, die Cookies von Drittanbietern blockieren, sind die Konfigurationsanforderungen identisch.

Benutzerdefinierte Domains sind erforderlich, wenn Ihre Benutzer über Webbrowser verfügen, die Cookies von Drittanbietern blockieren. AppStream 2.0 verwendet Browser-Cookies zur Authentifizierung von Streaming-Sitzungen und ermöglicht es Benutzern, sich erneut mit einer aktiven Sitzung zu verbinden, ohne jedes Mal ihre Anmeldeinformationen eingeben zu müssen. Standardmäßig enthalten AppStream-2.0-Streaming-URLs appstream.com als Domain. Wenn Sie eine Streaming-Sitzung in Ihrer Website einbetten, wird appstream.com als Drittanbieter-Domäne behandelt. Daher können Streaming-Sitzungen blockiert werden, wenn moderne Browser verwendet werden, die Cookies von Drittanbietern standardmäßig blockieren.

Gehen Sie folgendermaßen vor, um zu verhindern, dass eingebettete AppStream-2.0-Streaming-Sitzungen in diesem Szenario blockiert werden:

  1. Geben Sie eine benutzerdefinierte Domain an, um Ihre eingebetteten AppStream-2.0-Streaming-Sitzungen zu hosten.

    Wenn Sie Ihre benutzerdefinierte Domain konfigurieren, stellen Sie sicher, dass sie eine Subdomain der Webseite ist, in die Sie AppStream 2.0 einbetten möchten. Wenn Sie Ihren Stack beispielsweise so aktualisieren, dass training.example.com als Host-Domäne angegeben wird, können Sie eine Subdomäne mit dem Namen content.training.example.com für Ihre eingebetteten Streaming-Sitzungen erstellen.

  2. Erstellen Sie eine Streaming-URL für eingebettete AppStream-2.0-Streaming-Sitzungen, die dieselbe benutzerdefinierte Subdomain verwenden. Verwenden Sie zum Erstellen der Streaming-URL die API-Aktion CreateStreamingURL oder den AWS-CLI-Befehl create-streaming-url. Sie können die AppStream-2.0-Konsole nicht verwenden, um in diesem Szenario eine Streaming-URL zu erstellen.

    Ersetzen Sie in der URL die appstream2.Region.aws.amazon.com durch Ihre eigene Domain, um eine Streaming-URL für eingebettete AppStream-2.0-Streaming-Sitzungen zu erstellen.

    Standardmäßig sind AppStream-2.0-Streaming-URLs wie folgt formatiert:

    https://appstream2.region.aws.amazon.com/authenticate?parameters=authenticationcode

    Wenn Ihre Subdomäne content.training.example.com ist, folgt Ihre neue Streaming-URL dem folgenden Format:

    https://content.training.example.com/authenticate?parameters=authenticationcode
    Anmerkung

    Wenn Sie eine benutzerdefinierte Domain erstellen, können Sie die Domain für eingebettete AppStream-2.0-Streaming-Sitzungen nur in der AWS-Region verwenden, für die sie konfiguriert wurde. Wenn Sie benutzerdefinierte Domänen in mehreren Regionen unterstützen möchten, erstellen Sie für jede entsprechende Region eine benutzerdefinierte Domäne. Außerdem werden eingebettete Streaming-Sitzungen nur über HTTPS [TCP-Port 443] unterstützt.

  3. Fügen Sie appstream-custom-url-domain zum Header der Webseite hinzu, die die eingebetteten Streaming-Sitzungen hosten soll. Verwenden Sie für den Header-Wert die Domäne, die Ihr Reverse-Proxy Benutzern anzeigt. Beispiele:

    Header name: appstream-custom-url-domain
Header value: training.example.com

    Wenn Sie eine benutzerdefinierte Domäne festlegen und eine Streaming-URL erstellen, die dieselbe Domäne angibt, können die Cookies als Erstanbieter-Cookies gespeichert werden. Informationen zum Konfigurieren benutzerdefinierter Domains mithilfe von Amazon CloudFront finden Sie unter Verwenden benutzerdefinierter Domains mit AppStream 2.0.

Wenn Sie eine benutzerdefinierte Domain für Ihre eingebetteten AppStream-2.0-Streaming-Sitzungen eingerichtet haben und Ihre Streaming-URLs nicht auf Ihre benutzerdefinierte Domain umgeleitet werden oder wenn Ihre benutzerdefinierte Domain für Ihre Benutzer nicht korrekt angezeigt wird, finden Sie weitere Informationen in den folgenden Themen zur Fehlerbehebung:

Schritt 3: Herunterladen der eingebetteten AppStream-2.0-Dateien

Sie müssen die bereitgestellte AppStream-2.0-API-JavaScript-Datei herunterladen und konfigurieren, um eingebettete AppStream-2.0-Streaming-Sitzungen zu hosten.

  1. Wählen Sie auf der Webseite Einbetten von AppStream 2.0 in Ihre Website den Link in Schritt 1 zum Herunterladen der AppStream-2.0-Embed-Kit-ZIP-Datei appstream_embed_<version>.zip aus.

  2. Navigieren Sie zu dem Speicherort, an dem Sie die ZIP-Datei heruntergeladen haben, und extrahieren Sie den Inhalt der Datei.

  3. Der extrahierte Inhalt der Datei besteht aus einem Ordner, appstream-embed. Neben den Dateien COPYRIGHT.txt und THRID_PARTY_NOTICES.txt enthält dieser Ordner die folgenden beiden Dateien:

    • appstream-embed.js – Stellt die eingebettete AppStream-2.0-API bereit. Diese JavaScript-Datei enthält die Funktionen und API-Aktionen zum Konfigurieren und Steuern Ihrer eingebetteten AppStream-2.0-Streaming-Sitzung.

    • embed-sample.html – Beschreibt, wie die eingebettete AppStream-2.0-API verwendet wird, um eine Streaming-Sitzung zu initialisieren, Funktionen aufzurufen und Ereignisse zu überwachen. Diese Beispieldatei erweitert die Informationen in diesem Thema, um einen Anwendungsfall für Entwickler bereitzustellen.

Schritt 4. Konfigurieren Ihrer Website für die Integration mit AppStream 2.0

In den folgenden Abschnitten finden Sie Informationen zum Konfigurieren der Webseite zum Hosten eingebetteter AppStream-2.0-Streaming-Sitzungen.

Importieren Sie die JavaScript-Datei von appstream-embed

  1. Importieren Sie auf der Webseite, auf der Sie die AppStream-2.0-Streaming-Sitzung einbetten möchten, die Datei appstream-embed.js, indem Sie den folgenden Code hinzufügen:

    <script type="text/javascript" src="./appstream_embed.js"> </script>

  2. Als nächstes erstellen Sie ein leeres Container-div. Die ID des von Ihnen festgelegten div wird an den eingebetteten AppStream-2.0-Konstruktor übergeben. Es wird dann verwendet, um einen iframe für die Streaming-Sitzung zu einzufügen. Um das div zu erstellen, fügen Sie den folgenden Code hinzu:

    <div id="appstream-container"> </div>

Initialisieren und Konfigurieren des Schnittstellenobjekts AppStream.Embed

Um das Schnittstellenobjekt AppStream.Embed in JavaScript zu initialisieren, müssen Sie Code hinzufügen, der ein AppStream.Embed-Objekt mit Optionen für die Streaming-URL und die Konfiguration der Benutzeroberfläche erstellt. Diese Optionen und die von Ihnen erstellte div-ID werden in einem Objekt namens appstreamOptions gespeichert.

Der folgende Beispielcode zeigt, wie das Schnittstellenobjekt AppStream.Embed initialisiert wird.

var appstreamOptions = {
     sessionURL: 'https://appstream2.region.aws.amazon.com/authenticate?parameters=authenticationcode...',
     userInterfaceConfig:{[AppStream.Embed.Options.HIDDEN_ELEMENTS]:[AppStream.Embed.Elements.TOOLBAR]}
 };
 appstreamEmbed = new AppStream.Embed("appstream-container", appstreamOptions);

Ersetzen Sie im Code sessionURL und userInterfaceConfig durch eigene Werte.

Anmerkung

Der für userInterfaceConfig angegebene Wert blendet die gesamte AppStream-2.0-Symbolleiste aus. Dieser Wert, der als Beispiel enthalten ist, ist optional.

Sitzungs-URL

Die Streaming-URL, die Sie mit der AppStream-2.0-Konsole, der API-Aktion CreateStreamingURL oder dem AWS-CLI-Befehl create-streaming-url erstellt haben. Bei diesem Parameter wird zwischen Groß- und Kleinschreibung unterschieden.

Typ: Zeichenfolge

Required: Yes

Benutzerschnittstellenkonfig

Die Konfiguration, die den Anfangszustand der Benutzeroberflächenelemente generiert. Die Konfiguration ist ein Schlüssel-Wert-Paar.

Der Schlüssel AppStream.Embed.Options.HIDDEN_ELEMENTS gibt die Benutzeroberflächenobjekte an, die anfänglich ausgeblendet werden, wenn die eingebettete AppStream-2.0-Streaming-Sitzung initialisiert wird. Später können Sie mithilfe des Parameters getInterfaceState sowohl ausgeblendete als auch sichtbare Objekte zurückgeben.

Der Wert ist ein Array von Konstanten (Symbolleistenschaltflächen). Eine Liste der Konstanten, die Sie verwenden können, finden Sie unter Arbeiten mit HIDDEN_ELEMENTS.

Typ: Karte (Schlüssel:Wert)

Required: No

Beispiele für das Ausblenden von Elementen in der AppStream-2.0-Benutzeroberfläche

Die Beispiele in diesem Abschnitt zeigen, wie Elemente in der AppStream-2.0-Benutzeroberfläche während ihrer eingebetteten AppStream-2.0-Streaming-Sitzungen vor Benutzern ausgeblendet werden.

Beispiel 1: Ausblenden der gesamten AppStream-2.0-Symbolleiste

Verwenden Sie die Konstante AppStream.Embed.Elements.TOOLBAR, um zu verhindern, dass Benutzer während eingebetteter Streaming-Sitzungen auf eine Schaltfläche in der AppStream-2.0-Symbolleiste zugreifen. Mit dieser Konstanten können Sie alle AppStream-2.0-Symbolleisten-Schaltflächen ausblenden.

var appstreamOptions = {
     sessionURL: 'https://appstream2.region.aws.amazon.com/authenticate?parameters=authenticationcode...',
     userInterfaceConfig:{[AppStream.Embed.Options.HIDDEN_ELEMENTS]:[AppStream.Embed.Elements.TOOLBAR]}
 };

Beispiel 2: Ausblenden einer bestimmten Schaltfläche in der AppStream-2.0-Symbolleiste

Sie können die AppStream-2.0-Symbolleiste anzeigen und verhindern, dass Benutzer während eingebetteter Streaming-Sitzungen auf eine bestimmte Symbolleistenschaltfläche zugreifen. Geben Sie dazu die Konstante für die Schaltfläche an, die ausgeblendet werden soll. Im folgenden Code wird die Konstante AppStream.Embed.Elements.FILES_BUTTON zum Ausblenden der Schaltfläche My Files (Eigene Dateien) verwendet. Dadurch wird verhindert, dass Benutzer während eingebetteter Streaming-Sitzungen auf persistente Speicheroptionen zugreifen.

var appstreamOptions = {
     sessionURL: 'https://appstream2.region.aws.amazon.com/authenticate?parameters=authenticationcode...',
     userInterfaceConfig:{[AppStream.Embed.Options.HIDDEN_ELEMENTS]:[AppStream.Embed.Elements.FILES_BUTTON]}
 };

Beispiel 3: Ausblenden mehrerer Schaltflächen in der AppStream-2.0-Symbolleiste

Sie können die AppStream-2.0-Symbolleiste anzeigen und verhindern, dass Benutzer während eingebetteter Streaming-Sitzungen auf mehr als eine Symbolleistenschaltfläche zugreifen. Geben Sie dazu die Konstanten für die Schaltflächen an, die ausgeblendet werden sollen. Im folgenden Code werden die Konstanten AppStream.Embed.Elements.END_SESSION_BUTTON und AppStream.Embed.Elements.FULLSCREEN_BUTTON verwendet, um die Schaltflächen End Session (Sitzung beenden) und Fullscreen (Vollbild) auszublenden.

Anmerkung

Trennen Sie jede Konstante durch ein Komma, ohne vorherige oder folgende Leerzeichen.

var appstreamOptions = {
     sessionURL: 'https://appstream2.region.aws.amazon.com/authenticate?parameters=authenticationcode... (https://appstream2.region.aws.amazon.com/#/)',
     userInterfaceConfig:{[AppStream.Embed.Options.HIDDEN_ELEMENTS]:[AppStream.Embed.Elements.END_SESSION_BUTTON,AppStream.Embed.Elements.FULLSCREEN_BUTTON]}
 };

Konstanten, Funktionen und Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen

Die folgenden Themen enthalten Referenzinformationen für Konstanten, Funktionen und Ereignisse, die Sie zum Konfigurieren eingebetteter AppStream-2.0-Streaming-Sitzungen verwenden können.

Die folgenden AppStream-2.0-Benutzeroberflächenelemente können an die Konfigurationsoption HIDDEN_ELEMENTS übergeben werden, wenn eine eingebettete AppStream-2.0-Streaming-Sitzung initialisiert wird.

Arbeiten mit HIDDEN_ELEMENTS

Die folgenden AppStream-2.0-Benutzeroberflächenelemente können an die Konfigurationsoption HIDDEN_ELEMENTS als Konstanten übergeben werden, wenn eine eingebettete AppStream-2.0-Streaming-Sitzung initialisiert wird. 

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

Die folgenden drei Elemente können nicht als Konstanten, sondern als Zeichenfolgen an HIDDEN_ELEMENTS übergeben werden.

Zeichenfolge Beschreibung
'adminCommandsButton' Wenn Sie mit einem AppStream 2.0 Image Builder verbunden sind, wird die Schaltfläche Admin-Befehle in der oberen rechten Ecke der Symbolleiste der Sitzung angezeigt. Wenn diese Zeichenfolge an HIDDEN_ELEMENTS übergeben wird, wird die Schaltfläche Admin Commands (Admin-Befehle) ausgeblendet.
'softKeyboardButton' Während AppStream-2.0-Streaming-Sitzungen auf Touch-fähigen Geräten können Benutzer auf das Tastatursymbol in der AppStream-2.0-Symbolleiste tippen, um sich die Bildschirmtastatur anzeigen zu lassen. Wenn Sie diese Zeichenfolge HIDDEN_ELEMENTS übergeben, wird das Tastatursymbol ausgeblendet.
'keyboardShortcutsButton' Während Streaming-Sitzungen in AppStream 2.0 auf Touch-fähigen Geräten können Benutzer auf das Fn-Symbol in der AppStream-2.0-Symbolleiste tippen, um sich die Tastaturkürzel anzeigen zu lassen. Wenn Sie diese Zeichenfolge HIDDEN_ELEMENTS übergeben, wird das Fn-Symbol ausgeblendet.

Funktionen für das AppStream.Embed-Objekt

In der folgenden Tabelle sind die Funktionen aufgeführt, die für das Objekt AppStream.Embed ausgeführt werden können.

Funktion Beschreibung
AppStream.Embed(containerId:string, options:object) Der AppStream.Embed-Objektkonstruktor. Dieser Konstruktor initialisiert das Objekt AppStream.Embed und kommuniziert mit ihm und verwendet eine div-Container-ID. Die ID wird zum Einfügen des iframe verwendet. Es fügt auch ein Objekt mit den Konfigurationsoptionen für appstreamOptions (sessionURL und HIDDEN_ELEMENTS) ein.
endSession() Diese Funktion beendet die Streaming-Sitzung, zerstört aber nicht den iframe. Wenn Sie eine Umleitungs-URL angeben, versucht der iframe, die URL zu laden. Abhängig von den CORS-Headern der Seite wird die URL möglicherweise nicht geladen.
launchApp(appId:string) Diese Funktion startet programmgesteuert eine Anwendung mit der Anwendungs-ID, die während der Erstellung des Abbildes angegeben wurde.
launchAppSwitcher() Diese Funktion sendet den Befehl AppSwitcher an das AppStream-2.0-Portal. Dies löst den Befehl AppSwitcher für die Instance aus.
getSessionState() Diese Funktion gibt ein Objekt für sessionStatus zurück. Weitere Informationen finden Sie unter Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen.
getUserInterfaceState()

Diese Funktion gibt ein Objekt für UserInterfaceState zurück. Das Objekt enthält die Schlüssel-Wert-Paare für Folgendes:

sessionStatus: Status-Aufzählung

sessionTerminationReason: Zeichenfolge

sessionDisconnectionReason: Zeichenfolge

Weitere Informationen finden Sie unter Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen.
addEventListener(name, callback) Diese Funktion fügt eine Callback-Funktion hinzu, die aufzurufen ist, wenn das angegebene Ereignis ausgelöst wird. Eine Liste der Ereignisse, die ausgelöst werden können, finden Sie unter Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen.
removeEventListener(name, callback) Diese Funktion entfernt den Rückruf für die angegebenen Ereignisse.
destroy() Diese Funktion löscht den iframe und bereinigt Ressourcen. Diese Funktion hat keine Auswirkungen auf Streaming-Sitzungen, die gerade ausgeführt werden.

Ereignisse für eingebettete AppStream-2.0-Streaming-Sitzungen

In der folgenden Tabelle sind die Ereignisse aufgeführt, die während eingebetteter AppStream-2.0-Streaming-Sitzungen ausgelöst werden können.

Veranstaltung Daten Beschreibung
AppStream.Embed.Events.SESSION_STATE_CHANGE

sessionStatus: State enumeration

sessionTerminationReason: Zeichenfolge

sessionDisconnectionReason: Zeichenfolge

Dieses Ereignis wird ausgelöst, wenn eine Änderung des Sitzungsstatus auftritt. Das Ereignis enthält eine Karte der geänderten Zustände. Verwenden Sie die Funktion getSessionState(), um den vollständigen Sitzungsstatus abzurufen.

Nachstehend folgen die Sitzungsstatus:

AppStream.Embed.SessionStatus.Unknown – Die Sitzung hat noch nicht begonnen und ist nicht reserviert.

AppStream.Embed.SessionStatus.Reserved – Die Sitzung ist reserviert, hat aber noch nicht begonnen.

AppStream.Embed.SessionStatus.Started – Der Benutzer hat sich mit der Sitzung verbunden und mit dem Streaming begonnen.

AppStream.Embed.SessionStatus Disconnected  – Der Benutzer hat die Verbindung zur Sitzung getrennt.

AppStream.Embed.SessionStatus.Ended – Die Sitzung wurde als beendet oder abgelaufen markiert.
AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE

hiddenElements: Zeichenfolgen-Array

isFullscreen: Boolesch

isSoftKeyboardVisible: Boolesch

 Dieses Ereignis wird ausgelöst, wenn eine Änderung des Sitzungsstatus auftritt. Das Ereignis enthält eine Karte der geänderten Zustände. Verwenden Sie die Funktion getSessionState(), um den vollständigen Sitzungsstatus abzurufen.
AppStream.Embed.Events.SESSION_ERROR

errorCode: Nummer

errorMessage: Zeichenfolge

 Dieses Ereignis wird ausgelöst, wenn während einer Sitzung Fehler auftreten.

Beispiele für das Hinzufügen von Ereignis-Listener und das Beenden einer eingebetteten AppStream-2.0-Streaming-Sitzung

In den Beispielen in diesem Abschnitt wird gezeigt, wie Sie Folgendes tun können:

  • Fügen Sie Ereignis-Listener für eingebettete AppStream-2.0-Streaming-Sitzungen hinzu.

  • Programmgesteuertes Beenden einer eingebetteten AppStream-2.0-Streaming-Sitzung.

Beispiel 1: Hinzufügen von Ereignis-Listener für eingebettete AppStream-2.0-Streaming-Sitzungen

Verwenden Sie den folgenden Code, um Ereignis-Listener für Sitzungsstatusänderungen, Sitzungsschnittstellenstatusänderungen und Sitzungsfehler während eingebetteter Streaming-Sitzungen hinzuzufügen:

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 diesem Beispiel sind AppStream.Embed.Events.SESSION_STATE_CHANGE, AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE und AppStream.Embed.Events.SESSION_ERROR Ereignisnamen.

Die Funktionen updateSessionStateCallback, updateUserInterfaceStateCallback und errorCallback sind diejenigen, die Sie implementieren. Diese Funktionen werden in die Funktion addEventListener übergeben und aufgerufen, wenn ein Ereignis ausgelöst wird.

Beispiel 2: Programmgesteuertes Beenden einer eingebetteten AppStream-2.0-Streaming-Sitzung

Verwenden Sie die folgende Funktion, um eingebettete AppStream-2.0-Streaming-Sitzungen zu beenden:

appstreamEmbed.endSession();