XGameStreaming

Initialisation

API nécessaires pour initialiser les fonctionnalités de diffusion en continu de jeux.

Fonction	Description
XGameStreamingInitialize	Initialise les API de diffusion en continu de jeux.
XGameStreamingUninitialize	Annule l’initialisation des API de diffusion en continu de jeux.

Propriétés du client

API permettant d’obtenir les propriétés des appareils de diffusion en continu ou de leur flux de jeu

Fonctions

Fonction	Description
XGameStreamingClientPropertiesChangedCallback	Notification lorsque les propriétés d’un appareil de diffusion en continu ont changé.
XGameStreamingGetClientIPAddress	Déconseillé. Obtient l’adresse IP du client de diffusion en continu. Utilisez plutôt les revendications du jeton XSTS.
XGameStreamingGetDisplayDetails	Obtient les détails de l’affichage du client de diffusion en continu.
XGameStreamingGetSessionId	Obtient l’identificateur de session du client de diffusion en continu.
XGameStreamingGetStreamPhysicalDimensions	Obtient la taille physique du flux vidéo tel qu’il est actuellement rendu sur le client de diffusion en continu.
XGameStreamingGetTouchBundleVersion	Obtient la version de l’ensemble d’adaptation tactile actuellement utilisé sur l’appareil spécifié.
XGameStreamingGetTouchBundleVersionNameSize	Obtient la taille du nom de version spécifié dans l’ensemble d’adaptation tactile sur l’appareil spécifié.
XGameStreamingIsTouchInputEnabled	Vérifie si un client enverra des entrées tactiles au jeu.
XGameStreamingRegisterClientPropertiesChanged	Inscrit un rappel à appeler lorsque l’une des propriétés de l’appareil client de diffusion en continu change.
XGameStreamingUnregisterClientPropertiesChanged	Annule l’inscription d’un XGameStreamingClientPropertiesChangedCallback inscrit précédemment.

Énumérations

Énumération	Description
XGameStreamingClientProperty	Propriétés pouvant être interrogées concernant l’appareil client de diffusion en continu.
XGameStreamingVideoFlags	Fonctionnalités vidéo disponibles pouvant être prises en charge par l’appareil client de diffusion en continu.

Structures

Structures	Description
XGameStreamingDisplayDetails	Détails sur l’affichage de l’appareil client de diffusion en continu.

État de la connexion

API nécessaires pour gérer l’état de la connexion des appareils clients de diffusion en continu.

Fonctions

Fonction	Description
XGameStreamingConnectionStateChangedCallback	Fonction de rappel à appeler chaque fois que l’état d’un client de diffusion en continu connecté change.
XGameStreamingGetClientCount	Nombre d’appareils de diffusion en continu actuellement connectés.
XGameStreamingGetClients	Obtient les identificateurs de chaque client actuellement connecté.
XGameStreamingGetConnectionState	Obtient l’état de connexion actuel de l’appareil spécifié.
XGameStreamingIsStreaming	Détermine si le jeu est actuellement diffusé en continu.
XGameStreamingRegisterConnectionStateChanged	Inscrit un rappel à appeler lorsque l’état de connexion d’un appareil client de diffusion en continu change.
XGameStreamingUnregisterConnectionStateChanged	Annule l’inscription d’un XGameStreamingConnectionStateChangedCallback inscrit précédemment.

Énumérations

Énumération	Description
XGameStreamingConnectionState	États de connexion d’un appareil client de diffusion en continu.

Latence

API permettant d’adapter le jeu à la latence de diffusion en continu.

Fonctions

Fonction	Description
XGameStreamingGetStreamAddedLatency	Obtient la moyenne récente de la latence liée à la diffusion en continu.
XGameStreamingGetLastFrameDisplayed	Déconseillé. Obtient le jeton de pipeline d’images pour l’image affichée le plus récemment sur l’écran du client de diffusion en continu.
XGameStreamingGetAssociatedFrame	Déconseillé. Obtient le jeton de pipeline d’images à partir d’une lecture d’entrée spécifique.

Emplacement du serveur

API permettant d’accéder à l’emplacement à partir duquel le jeu est diffusé en continu.

Fonctions

Fonction	Description
XGameStreamingGetServerLocationName	Obtient l’emplacement du centre de données du serveur de diffusion en continu.
XGameStreamingGetServerLocationNameSize	Obtient la taille du nom de l’emplacement du centre de données du serveur de diffusion en continu

Adaptation tactile

API permettant de gérer les dispositions de manette tactile qui seront exposées aux clients de diffusion en continu appropriés.

Fonctions

Fonction	Description
XGameStreamingGetGamepadPhysicality	Obtient le mappage de la physicalité des entrées à partir d’une lecture de manette spécifique.
XGameStreamingHideTouchControls	Demande à tous les appareils clients de diffusion en continu connectés de masquer la disposition tactile si elle est visible.
XGameStreamingHideTouchControlsOnClient	Demande à un appareil client de diffusion en continu spécifié de masquer la disposition tactile si elle est visible.
XGameStreamingShowTouchControlLayout	Demande à tous les appareils clients de diffusion en continu connectés d’afficher une disposition tactile spécifiée.
XGameStreamingShowTouchControlLayoutOnClient	Demande à un appareil client de diffusion en continu connecté spécifié d’afficher une disposition tactile spécifiée.
XGameStreamingShowTouchControlsWithStateUpdate	Demande à tous les appareils clients de diffusion en continu connectés de mettre à jour l’état de leurs contrôles tactiles, puis d’afficher une disposition tactile spécifiée.
XGameStreamingShowTouchControlsWithStateUpdateOnClient	Demande à un appareil client de diffusion en continu spécifié de mettre à jour l’état de ses contrôles tactiles, puis d’afficher une disposition tactile spécifiée.
XGameStreamingUpdateTouchControlsState	Met à jour l’état des contrôles tactiles sur tous les appareils clients de diffusion en continu connectés.
XGameStreamingUpdateTouchControlsStateOnClient	Met à jour l’état des contrôles tactiles sur un appareil client de diffusion en continu spécifié.

Énumérations

Énumération	Description
XGameStreamingGamepadPhysicality	Mappage de la physicalité pour tous les boutons, sticks et gâchettes d’une manette sans fil XBOX standard. Pour un bouton, un stick ou une gâchette donné, la physicalité peut être inconnue, physique, virtuelle ou les deux.
XGameStreamingTouchControlsStateOperationKind	Opérations pouvant être effectuées lors de la mise à jour de l’état de la disposition des contrôles tactiles.
XGameStreamingTouchControlsStateValueKind	Spécifie le type de l’état associé aux dispositions tactiles.

Structures

Structures	Description
XGameStreamingTouchControlsStateOperation	Spécifie l’opération, le chemin d’accès à la variable spécifique et la valeur à appliquer.
XGameStreamingTouchControlsStateValue	Fournit le type et la valeur d’un élément spécifique de l’état des contrôles tactiles.

Résolution

API permettant de gérer la résolution du flux.

Fonctions

Fonction	Description
XGameStreamingSetResolution	Définit la résolution du flux vidéo.

Codes d’erreur

Les codes d’erreur suivants peuvent être retournés par les API XGameStreaming. Pour obtenir la liste complète, consultez Codes d’erreur.

Code	Valeur	Description
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	Le runtime XGameStreaming n’est pas initialisé. Appelez XGameStreamingInitialize avant d’appeler d’autres API.
E_GAMESTREAMING_CLIENT_NOT_CONNECTED	0x89245401	Le client spécifié n’est pas connecté.
E_GAMESTREAMING_NO_DATA	0x89245402	Les données demandées ne sont pas disponibles. Elles pourraient l’être plus tard.
E_GAMESTREAMING_NO_DATACENTER	0x89245403	L’ordinateur actuel ne s’exécute pas dans un centre de données.
E_GAMESTREAMING_NOT_STREAMING_CONTROLLER	0x89245404	La lecture actuelle ne provient pas d’une manette de diffusion en continu.

Documentation conceptuelle

Voir aussi

Référence des API système

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

XGameStreaming

XGameStreaming

Initialisation

Propriétés du client

Fonctions

Énumérations

Structures

État de la connexion

Fonctions

Énumérations

Latence

Fonctions

Emplacement du serveur

Fonctions

Adaptation tactile

Fonctions

Énumérations

Structures

Résolution

Fonctions

Codes d’erreur

Documentation conceptuelle

Voir aussi

​XGameStreaming

​Initialisation

​Propriétés du client

​Fonctions

​Énumérations

​Structures

​État de la connexion

​Fonctions

​Énumérations

​Latence

​Fonctions

​Emplacement du serveur

​Fonctions

​Adaptation tactile

​Fonctions

​Énumérations

​Structures

​Résolution

​Fonctions

​Codes d’erreur

​Documentation conceptuelle

​Voir aussi

XGameStreaming

Initialisation

Propriétés du client

Fonctions

Énumérations

Structures

État de la connexion

Fonctions

Énumérations

Latence

Fonctions

Emplacement du serveur

Fonctions

Adaptation tactile

Fonctions

Énumérations

Structures

Résolution

Fonctions

Codes d’erreur

Documentation conceptuelle

Voir aussi