XGameStreamingGetClients
Gets the ID of each currently connected client.Syntax
Parameters
clientCount _In_Type: uint32_t Maximum number of clients to return in the clients array. clients _Out_writes_to_(clientCount,clientsUsed)
Type: XGameStreamingClientId Buffer to store the connected client IDs. clientsUsed _Out_
Type: uint32_t* The number of clients actually written to the clients array.
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.Potential Errors
For a list of error codes, see Error Codes.
Remarks
Used to get theXGameStreamingClientId of every streaming client device that is currently connected.
If the game is only trying to identify if ANY device is connected and streaming, consider using XGameStreamingIsStreaming.
If the game needs to get notification when a streaming client connects and/or disconnects, consider using XGameStreamingRegisterConnectionStateChanged.
Requirements
Header: xgamestreaming.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesSee also
XGameStreamingIsStreamingXGameStreamingRegisterConnectionStateChanged
XGameStreamingGetClientCount
XGameStreaming