SensorManager.RegisterListener Method
Definition
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.
Overloads
| RegisterListener(ISensorEventListener, Sensor, SensorDelay, Int32, Handler) |
Registers a |
| RegisterListener(ISensorEventListener, Sensor, SensorDelay, Int32) |
Registers a |
| RegisterListener(ISensorEventListener, Sensor, SensorDelay, Handler) |
Registers a |
| RegisterListener(ISensorEventListener, Sensor, SensorDelay) |
Registers a |
| RegisterListener(ISensorListener, Int32) |
Obsolete.
Registers a listener for given sensors. |
| RegisterListener(ISensorListener, Int32, SensorDelay) |
Obsolete.
Registers a SensorListener for given sensors. |
RegisterListener(ISensorEventListener, Sensor, SensorDelay, Int32, Handler)
Registers a android.hardware.SensorEventListener SensorEventListener for the given
sensor at the given sampling frequency and the given maximum reporting latency.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;IILandroid/os/Handler;)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IILandroid_os_Handler_Handler")]
public virtual bool RegisterListener (Android.Hardware.ISensorEventListener? listener, Android.Hardware.Sensor? sensor, Android.Hardware.SensorDelay samplingPeriodUs, int maxReportLatencyUs, Android.OS.Handler? handler);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;IILandroid/os/Handler;)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IILandroid_os_Handler_Handler")>]
abstract member RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * int * Android.OS.Handler -> bool
override this.RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * int * Android.OS.Handler -> bool
Parameters
- listener
- ISensorEventListener
A android.hardware.SensorEventListener SensorEventListener object
that will receive the sensor events. If the application is interested in receiving
flush complete notifications, it should register with
android.hardware.SensorEventListener SensorEventListener2 instead.
- sensor
- Sensor
The android.hardware.Sensor Sensor to register to.
- samplingPeriodUs
- SensorDelay
The desired delay between two consecutive events in microseconds.
This is only a hint to the system. Events may be received faster or slower than
the specified rate. Usually events are received faster. Can be one of
#SENSOR_DELAY_NORMAL, #SENSOR_DELAY_UI,
#SENSOR_DELAY_GAME, #SENSOR_DELAY_FASTEST or the delay in
microseconds.
- maxReportLatencyUs
- Int32
Maximum time in microseconds that events can be delayed before
being reported to the application. A large value allows reducing the power
consumption associated with the sensor. If maxReportLatencyUs is set to zero,
events are delivered as soon as they are available, which is equivalent to calling
#registerListener(SensorEventListener, Sensor, int).
- handler
- Handler
The android.os.Handler Handler the android.hardware.SensorEvent
sensor events will be delivered to.
Returns
<code>true</code> if the sensor is supported and successfully enabled.
- Attributes
Remarks
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.
See also
- <xref:Android.Hardware.SensorManager.RegisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor)>
Applies to
RegisterListener(ISensorEventListener, Sensor, SensorDelay, Int32)
Registers a android.hardware.SensorEventListener SensorEventListener for the given
sensor at the given sampling frequency and the given maximum reporting latency.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;II)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IIHandler")]
public virtual bool RegisterListener (Android.Hardware.ISensorEventListener? listener, Android.Hardware.Sensor? sensor, Android.Hardware.SensorDelay samplingPeriodUs, int maxReportLatencyUs);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;II)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IIHandler")>]
abstract member RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * int -> bool
override this.RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * int -> bool
Parameters
- listener
- ISensorEventListener
A android.hardware.SensorEventListener SensorEventListener object
that will receive the sensor events. If the application is interested in receiving
flush complete notifications, it should register with
android.hardware.SensorEventListener SensorEventListener2 instead.
- sensor
- Sensor
The android.hardware.Sensor Sensor to register to.
- samplingPeriodUs
- SensorDelay
The desired delay between two consecutive events in microseconds.
This is only a hint to the system. Events may be received faster or slower than
the specified rate. Usually events are received faster. Can be one of
#SENSOR_DELAY_NORMAL, #SENSOR_DELAY_UI,
#SENSOR_DELAY_GAME, #SENSOR_DELAY_FASTEST or the delay in
microseconds.
- maxReportLatencyUs
- Int32
Maximum time in microseconds that events can be delayed before
being reported to the application. A large value allows reducing the power
consumption associated with the sensor. If maxReportLatencyUs is set to zero,
events are delivered as soon as they are available, which is equivalent to calling
#registerListener(SensorEventListener, Sensor, int).
Returns
<code>true</code> if the sensor is supported and successfully enabled.
- Attributes
Remarks
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.
See also
- <xref:Android.Hardware.SensorManager.RegisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor)>
- UnregisterListener(ISensorEventListener)
- Flush(ISensorEventListener)
Applies to
RegisterListener(ISensorEventListener, Sensor, SensorDelay, Handler)
Registers a android.hardware.SensorEventListener SensorEventListener for the given
sensor.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;ILandroid/os/Handler;)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_ILandroid_os_Handler_Handler")]
public virtual bool RegisterListener (Android.Hardware.ISensorEventListener? listener, Android.Hardware.Sensor? sensor, Android.Hardware.SensorDelay samplingPeriodUs, Android.OS.Handler? handler);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;ILandroid/os/Handler;)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_ILandroid_os_Handler_Handler")>]
abstract member RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * Android.OS.Handler -> bool
override this.RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay * Android.OS.Handler -> bool
Parameters
- listener
- ISensorEventListener
A android.hardware.SensorEventListener SensorEventListener object.
- sensor
- Sensor
The android.hardware.Sensor Sensor to register to.
- samplingPeriodUs
- SensorDelay
The rate android.hardware.SensorEvent sensor events are
delivered at. This is only a hint to the system. Events may be received faster or
slower than the specified rate. Usually events are received faster. The value must
be one of #SENSOR_DELAY_NORMAL, #SENSOR_DELAY_UI,
#SENSOR_DELAY_GAME, or #SENSOR_DELAY_FASTEST or, the desired
delay between events in microseconds. Specifying the delay in microseconds only
works from Android 2.3 (API level 9) onwards. For earlier releases, you must use
one of the SENSOR_DELAY_* constants.
- handler
- Handler
The android.os.Handler Handler the android.hardware.SensorEvent
sensor events will be delivered to.
Returns
<code>true</code> if the sensor is supported and successfully enabled.
- Attributes
Exceptions
when sensor is null or a trigger sensor
Remarks
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.
See also
- <xref:Android.Hardware.SensorManager.RegisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor)>
- UnregisterListener(ISensorEventListener)
- <xref:Android.Hardware.SensorManager.UnregisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor)>
Applies to
RegisterListener(ISensorEventListener, Sensor, SensorDelay)
Registers a android.hardware.SensorEventListener SensorEventListener for the given
sensor at the given sampling frequency.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;I)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IHandler")]
public virtual bool RegisterListener (Android.Hardware.ISensorEventListener? listener, Android.Hardware.Sensor? sensor, Android.Hardware.SensorDelay samplingPeriodUs);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorEventListener;Landroid/hardware/Sensor;I)Z", "GetRegisterListener_Landroid_hardware_SensorEventListener_Landroid_hardware_Sensor_IHandler")>]
abstract member RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay -> bool
override this.RegisterListener : Android.Hardware.ISensorEventListener * Android.Hardware.Sensor * Android.Hardware.SensorDelay -> bool
Parameters
- listener
- ISensorEventListener
A android.hardware.SensorEventListener SensorEventListener object.
- sensor
- Sensor
The android.hardware.Sensor Sensor to register to.
- samplingPeriodUs
- SensorDelay
The rate android.hardware.SensorEvent sensor events are
delivered at. This is only a hint to the system. Events may be received faster or
slower than the specified rate. Usually events are received faster. The value must
be one of #SENSOR_DELAY_NORMAL, #SENSOR_DELAY_UI,
#SENSOR_DELAY_GAME, or #SENSOR_DELAY_FASTEST or, the desired delay
between events in microseconds. Specifying the delay in microseconds only works
from Android 2.3 (API level 9) onwards. For earlier releases, you must use one of
the SENSOR_DELAY_* constants.
Returns
<code>true</code> if the sensor is supported and successfully enabled.
- Attributes
Exceptions
when sensor is null or a trigger sensor
Remarks
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.
See also
- <xref:Android.Hardware.SensorManager.RegisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor%2c+Android.Hardware.Sensor)>
- UnregisterListener(ISensorEventListener)
- <xref:Android.Hardware.SensorManager.UnregisterListener(Android.Hardware.ISensorEventListener%2c+Android.Hardware.Sensor)>
Applies to
RegisterListener(ISensorListener, Int32)
Caution
deprecated
Registers a listener for given sensors.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorListener;I)Z", "GetRegisterListener_Landroid_hardware_SensorListener_IHandler")]
[System.Obsolete("deprecated")]
public virtual bool RegisterListener (Android.Hardware.ISensorListener? listener, int sensors);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorListener;I)Z", "GetRegisterListener_Landroid_hardware_SensorListener_IHandler")>]
[<System.Obsolete("deprecated")>]
abstract member RegisterListener : Android.Hardware.ISensorListener * int -> bool
override this.RegisterListener : Android.Hardware.ISensorListener * int -> bool
Parameters
- listener
- ISensorListener
sensor listener object
- sensors
- Int32
a bit masks of the sensors to register to
Returns
<code>true</code> if the sensor is supported and successfully enabled
- Attributes
Remarks
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
RegisterListener(ISensorListener, Int32, SensorDelay)
Caution
deprecated
Registers a SensorListener for given sensors.
[Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorListener;II)Z", "GetRegisterListener_Landroid_hardware_SensorListener_IIHandler")]
[System.Obsolete("deprecated")]
public virtual bool RegisterListener (Android.Hardware.ISensorListener? listener, int sensors, Android.Hardware.SensorDelay rate);
[<Android.Runtime.Register("registerListener", "(Landroid/hardware/SensorListener;II)Z", "GetRegisterListener_Landroid_hardware_SensorListener_IIHandler")>]
[<System.Obsolete("deprecated")>]
abstract member RegisterListener : Android.Hardware.ISensorListener * int * Android.Hardware.SensorDelay -> bool
override this.RegisterListener : Android.Hardware.ISensorListener * int * Android.Hardware.SensorDelay -> bool
Parameters
- listener
- ISensorListener
sensor listener object
- sensors
- Int32
a bit masks of the sensors to register to
- rate
- SensorDelay
rate of events. This is only a hint to the system. events may be
received faster or slower than the specified rate. Usually events
are received faster. The value must be one of
#SENSOR_DELAY_NORMAL, #SENSOR_DELAY_UI,
#SENSOR_DELAY_GAME, or #SENSOR_DELAY_FASTEST.
Returns
<code>true</code> if the sensor is supported and successfully enabled
- Attributes
Remarks
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.