Share via

XboxLiveQualityOfServicePrivatePayloadResult Class

  • Reference

Definition

Namespace:
Windows.Networking.XboxLive
Edit

Encapsulates the private payload from a Quality of Service (QoS) measurement when the XboxLiveQualityOfServiceMeasurement.ShouldRequestPrivatePayloads flag has been specified.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public ref class XboxLiveQualityOfServicePrivatePayloadResult sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class XboxLiveQualityOfServicePrivatePayloadResult final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class XboxLiveQualityOfServicePrivatePayloadResult
Public NotInheritable Class XboxLiveQualityOfServicePrivatePayloadResult
Inheritance
Object Platform::Object IInspectable XboxLiveQualityOfServicePrivatePayloadResult
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Xbox One System Apps Extensions for the UWP (introduced in 10.0.0.1)
 Xbox Live Extension SDK (introduced in 10.0.10240.0)
 Xbox One Extensions for the UWP (introduced in 10.0.10240.0)
 Windows Desktop Extension SDK (introduced in 10.0.16299.0)
API contract
Windows.Networking.XboxLive.XboxLiveSecureSocketsContract (introduced in v1.0)

Properties

DeviceAddress

Gets the device address of the device that returned this private payload.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
Status

Gets the status of the measurement that includes this private payload retrieval.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
Value

Gets the private payload. Format and meaning of the private payload bytes are determined by each individual app.

Private payload data bytes are not interpreted or validated by XboxLiveQualityOfServiceMeasurement objects. They are transmitted as-is. As with all messages exchanged with remote devices over the network, apps should be mindful that the remote device publishing or receiving the private payload might not be running the same version of the app that's running locally. Consider using a versioning scheme, and always check that a payload is well-formed before acting on it.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Applies to