XGameStreamingClientPropertiesChangedCallback

Article
06/22/2023

A callback function which is invoked whenever properties of a connected streaming client device change. The callback is also invoked for all connected devices upon first registration.

Syntax

void XGameStreamingClientPropertiesChangedCallback(  
         void* context,  
         XGameStreamingClientId client,  
         uint32_t updatedPropertiesCount,  
         XGameStreamingClientProperty* updatedProperties  
)

Parameters

context _In_
Type: void*

A pointer to the context provided at event registration time.

client _In_
Type: XGameStreamingClientId

The client which has changed properties.

updatedPropertiesCount _In_
Type: uint32_t

The number of properties which have changed on the client.

updatedProperties _In_reads_(updatedPropertiesCount)
Type: XGameStreamingClientProperty*

A pointer to the identifiers of the changed client properties.

Return value

Type: void

Remarks

The XGameStreamingClientPropertiesChangedCallback is invoked whenever one or more properties of the streaming client device have changed. Upon connection of the device, the callback is invoked for each of the properties that are applicable to that device.

Upon initial registering of the callback function via XGameStreamingRegisterClientPropertiesChanged the callback will be invoked for each of the properties that are applicable to that device.

To unregister the callback function use XGameStreamingUnregisterClientPropertiesChanged.

Requirements

Header: xgamestreaming.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles