XboxLiveQualityOfServiceMeasurement.PublishedPrivatePayload Property

Definition

Namespace:

Windows.Networking.XboxLive

Gets or sets the private payload published for the local device.

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:
 static property IBuffer ^ PublishedPrivatePayload { IBuffer ^ get(); void set(IBuffer ^ value); };

static IBuffer PublishedPrivatePayload();

static void PublishedPrivatePayload(IBuffer value);

public static IBuffer PublishedPrivatePayload { get; set; }

var iBuffer = XboxLiveQualityOfServiceMeasurement.publishedPrivatePayload;
XboxLiveQualityOfServiceMeasurement.publishedPrivatePayload = iBuffer;

Public Shared Property PublishedPrivatePayload As IBuffer

Property Value

IBuffer

The local private payload.

Remarks

The buffer is not permitted to exceed MaxPrivatePayloadSize, in Bytes.

The private payload is used by your app to pass app-specific state about the currently running game without creating an XboxLiveEndpointPair. An example could be: number of slots available in game, or time left in the current round.

Private payload data bytes aren't 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.