MultiplayerSession.SetQualityOfServiceConnectivityMetrics Method

Reference

Definition

Namespace:: Microsoft.Xbox.Services.Multiplayer

Assembly:: Microsoft.Xbox.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enables or disables the connectivity metrics used to satisfy QoS requirements on the network for the session.

public void SetQualityOfServiceConnectivityMetrics (bool enableLatencyMetric, bool enableBandwidthDownMetric, bool enableBandwidthUpMetric, bool enableCustomMetric);

abstract member SetQualityOfServiceConnectivityMetrics : bool * bool * bool * bool -> unit
override this.SetQualityOfServiceConnectivityMetrics : bool * bool * bool * bool -> unit

Public Sub SetQualityOfServiceConnectivityMetrics (enableLatencyMetric As Boolean, enableBandwidthDownMetric As Boolean, enableBandwidthUpMetric As Boolean, enableCustomMetric As Boolean)

Parameters

enableLatencyMetric: Boolean

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

enableBandwidthDownMetric: Boolean

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

enableBandwidthUpMetric: Boolean

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

enableCustomMetric: Boolean

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

Implements

Microsoft.Xbox.Services.Multiplayer.__IMultiplayerSessionPublicNonVirtuals.SetQualityOfServiceConnectivityMetrics(System.Boolean,System.Boolean,System.Boolean,System.Boolean)

Remarks

This can only be set when creating a new session. After calling this method, the caller must use MultiplayerService.WriteSessionAsync to write batched local changes to the service.

Applies to

Share via