Compass.MaxBatchSize Compass.MaxBatchSize Compass.MaxBatchSize Compass.MaxBatchSize Compass.MaxBatchSize Property

Definition

Gets the maximum number of events that can be batched by the sensor.

public : unsigned int MaxBatchSize { get; }
uint32_t MaxBatchSize();
public uint MaxBatchSize { get; }
Public ReadOnly Property MaxBatchSize As uint
var uint = compass.maxBatchSize;

Property Value

uint uint uint

The maximum number of batched events.

Additional features and requirements

Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported ReportLatency. The maximum latency equals the ReportInterval times the MaxBatchSize. For more information about sensor batching, see Sensors.