OrientationSensor.ReportInterval | reportInterval property

Applies to Windows and Windows Phone

Gets or sets the report interval supported by the sensor.

Syntax


var reportInterval = orientationSensor.reportInterval;
orientationSensor.reportInterval = reportInterval;

Property value

Type: Number [JavaScript] | System.UInt32 [.NET] | uint32 [C++]

The report interval supported by the sensor.

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.

The 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.

Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller.

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.

The Sensor platform automatically sets the change sensitivity for orientation sensors based on the current report interval. This table specifies the change sensitivity values for given intervals.

Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degreees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

None supported

Minimum supported phone

Windows Phone 8

Namespace

Windows.Devices.Sensors
Windows::Devices::Sensors [C++]

Metadata

Windows.winmd

See also

OrientationSensor
MinimumReportInterval

 

 

Show:
© 2014 Microsoft. All rights reserved.