XGameStreamingClientProperty

  • Article

Properties that can be queried for on the client streaming device.

Syntax

enum class XGameStreamingClientProperty  : uint32_t  
{  
    None = 0,  
    StreamPhysicalDimensions = 1,  
    TouchInputEnabled = 2,  
    TouchBundleVersion = 4,  
    IPAddress = 5,
    SessionId = 6,
    DisplayDetails = 7
}

Constants

Constant Description Related Function
None
StreamPhysicalDimensions The physical dimensions of the stream size. XGameStreamingGetStreamPhysicalDimensions
TouchInputEnabled Whether the streaming device is currently sending touch input. XGameStreamingIsTouchInputEnabled
TouchBundleVersion The version number and version name of the touch adaptation bundle currently in use by the client app. XGameStreamingGetTouchBundleVersion
IPAddress The IP address of the client. XGameStreamingGetClientIPAddress
SessionId The session id of the client. XGameStreamingGetSessionId
DisplayDetails The display details of the client. XGameStreamingGetDisplayDetails

Remarks

The XGameStreamingClientPropertiesChangedCallBack is invoked whenever any property of the client device that is streaming has changed.

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

To unregister the callback function use XGameStreamingUnregisterClientPropertiesChanged.

Requirements

Header: xgamestreaming.h

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

See also

XGameStreamingClientPropertiesChangedCallBack XGameStreamingRegisterClientPropertiesChanged
XGameStreamingUnregisterClientPropertiesChanged
XGameStreaming