Share via


LightSensor.MaxBatchSize Property

Definition

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

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

Property Value

UInt32

unsigned int

uint32_t

The maximum number of batched events.

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

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.

Applies to