Altimeter Altimeter Altimeter Altimeter Class

Gets the device identifier.

public : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// You can use this property in JavaScript.

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

public : unsigned int MaxBatchSize { get; }public uint MaxBatchSize { get; }Public ReadOnly Property MaxBatchSize As uint// You can use this property in JavaScript.

Device family	Windows 10 Insider Preview (introduced v10.0.16257.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.

The smallest report interval that is supported by this altimeter sensor.

public : unsigned int MinimumReportInterval { get; }public uint MinimumReportInterval { get; }Public ReadOnly Property MinimumReportInterval As uint// You can use this property in JavaScript.

Gets or sets the current report interval for the altimeter.

public : unsigned int ReportInterval { get; set; }public uint ReportInterval { get; set; }Public ReadWrite Property ReportInterval As uint// You can use this property in JavaScript.

Remarks

The report interval is specified in milliseconds.

The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling GetCurrentReading. The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor.

Changes to the report interval after an event handler has been registered or GetCurrentReading has been called may apply to the delivery of subsequent sensor readings.

Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection.

Your application should consult the MinimumReportInterval property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results.

Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic.

Prerelease. Gets or sets the delay between batches of sensor information.

public : unsigned int ReportLatency { get; set; }public uint ReportLatency { get; set; }Public ReadWrite Property ReportLatency As uint// You can use this property in JavaScript.

Device family	Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

This property is in reference to the frequency of ReadingChanged events.

Not all sensors support ReportLatency. If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor.

If you set ReportLatency to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible ReportLatency equals the MaxBatchSize times the ReportInterval.

Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for ReportLatency. In this scenario, the sensor needs to try to accommodate the lowest value for ReportLatency. Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor.

For more information about sensor batching, see Sensors.

Gets the current reading for the altimeter.

public : AltimeterReading GetCurrentReading()public AltimeterReading GetCurrentReading()Public Function GetCurrentReading() As AltimeterReading// You can use this method in JavaScript.

Remarks

It is important to note that the altitude reading for this sensor is not the absolute altitude. Rather, this API is designed to determine the change in elevation between readings.

Returns the default altimeter sensor.

public : static Altimeter GetDefault()public static Altimeter GetDefault()Public Static Function GetDefault() As Altimeter// You can use this method in JavaScript.

Remarks

If no barometer sensor is available, this method will return the null pointer.

Occurs each time the altimeter sensor reports a new value.

public : event TypedEventHandler ReadingChanged<Altimeter,  AltimeterReadingChangedEventArgs>public event TypedEventHandler ReadingChanged<Altimeter,  AltimeterReadingChangedEventArgs>Public Event ReadingChanged<Altimeter,  AltimeterReadingChangedEventArgs>// You can use this event in JavaScript.

Remarks

An application may register this event handler to obtain sensor readings. The application must establish a desired ReportInterval. This sets the frequency of the ReadingChanged event.