SensorManager.Flush(ISensorEventListener) Method

Reference

Definition

Namespace:: Android.Hardware

Assembly:: Mono.Android.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.

Flushes the FIFO of all the sensors registered for this listener.

[Android.Runtime.Register("flush", "(Landroid/hardware/SensorEventListener;)Z", "GetFlush_Landroid_hardware_SensorEventListener_Handler")]
public virtual bool Flush (Android.Hardware.ISensorEventListener? listener);

[<Android.Runtime.Register("flush", "(Landroid/hardware/SensorEventListener;)Z", "GetFlush_Landroid_hardware_SensorEventListener_Handler")>]
abstract member Flush : Android.Hardware.ISensorEventListener -> bool
override this.Flush : Android.Hardware.ISensorEventListener -> bool

Parameters

listener: ISensorEventListener

A android.hardware.SensorEventListener SensorEventListener object which was previously used in a registerListener call.

Returns

Boolean

true if the flush is initiated successfully on all the sensors registered for this listener, false if no sensor is previously registered for this listener or flush on one of the sensors fails.

Attributes: RegisterAttribute

Exceptions

IllegalArgumentException

when listener is null.

Remarks

Flushes the FIFO of all the sensors registered for this listener. If there are events in the FIFO of the sensor, they are returned as if the maxReportLantecy of the FIFO has expired. Events are returned in the usual way through the SensorEventListener. This call doesn't affect the maxReportLantecy for this sensor. This call is asynchronous and returns immediately. android.hardware.SensorEventListener2#onFlushCompleted onFlushCompleted is called after all the events in the batch at the time of calling this method have been delivered successfully. If the hardware doesn't support flush, it still returns true and a trivial flush complete event is sent after the current event for all the clients registered for this sensor.

Java documentation for android.hardware.SensorManager.flush(android.hardware.SensorEventListener).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to