XblMultiplayerSessionConstantsSetQosConnectivityMetrics

Enables or disables connectivity metrics for the session. This can only be set when creating a new session.

Syntax

HRESULT XblMultiplayerSessionConstantsSetQosConnectivityMetrics(  
         XblMultiplayerSessionHandle handle,  
         bool enableLatencyMetric,  
         bool enableBandwidthDownMetric,  
         bool enableBandwidthUpMetric,  
         bool enableCustomMetric  
)  

Parameters

handle   _In_
Type: XblMultiplayerSessionHandle

Handle to the multiplayer session.

enableLatencyMetric   _In_
Type: bool

True to enable the measuring of latency, and false to disable latency measurement.

enableBandwidthDownMetric   _In_
Type: bool

True to enable the measuring of bandwidth down, and false to disable bandwidth down measurement.

enableBandwidthUpMetric   _In_
Type: bool

True to enable the measuring of bandwidth up, and false to disable bandwidth up measurement.

enableCustomMetric   _In_
Type: bool

True to enable custom metrics, and false to disable them.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

For ones that are enabled, they must be sufficient to satisfy the QoS requirements.

Requirements

Header: multiplayer_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

See also

multiplayer_c