Magnetometer

API Examples - Magnetometer class

Before you starting to use the Magnetometer sensor make sure the device supports this sensor type via:

if (Magnetometer.isSupported())
{
	magnetometer = new Magnetometer();
}

setRequestedUpdateInterval(interval : Number) : void

Sets the frequency in ms in which you wanted to receive status updates. Whenever a status update occurs, the sensor will fires an MagnetometerEvent.UPDATE.

magnetometer.setRequestedUpdateInterval(1000);
magnetometer.addEventListener(MagnetometerEvent.UPDATE, handleMagnetometerUpdate);

getPower() : Number

Retrieve the power in mA used by this sensor while in use.

getMaximumRange() : Number

Retrieve maximum range of the sensor in the sensor's unit. (micro-Tesla, uT)

getResolution() : Number

Retrieve resolution of the sensor in the sensor's unit. (micro-Tesla, uT)

dispose() : void

Call this function if you don't need the class anymore to free your memory.