CMMotionManager Class

Reference

Definition

Namespace:: CoreMotion

Assembly:: Xamarin.iOS.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.

Core class that provides access to the motion services in iOS.

[Foundation.Register("CMMotionManager", true)]
public class CMMotionManager : Foundation.NSObject

type CMMotionManager = class
    inherit NSObject

Inheritance: Object

NSObject
CMMotionManager

Attributes: RegisterAttribute

Remarks

Core Motion was introduced in iOS 7 and is not available on all devices (the iPhone 5S was the first phone to have the necessary coprocessor and the iPad Air 2 was the first tablet). Developers can check if Core Motion is available with DeviceMotionAvailable.

Applications that wish to access Core Motion must have an entitlements.plist file.

Users must explicitly grant access to Core Motion via a standard privacy dialog. Unlike most functions that require user permissions, there is not a corresponding API to check status. However, applications can perform a query and, if authorization is not available, will receive an error of type MotionActivityNotAuthorized. This technique is shown in the following example:

var stepCounter = new CMStepCounter ();
stepCounter.QueryStepCount(
	NSDate.FromTimeIntervalSinceNow(-60 * 60 * 24),
	NSDate.Now,
	NSOperationQueue.MainQueue, ((steps, error) => {
		if(error != null && error.Code == (int) CMError.MotionActivityNotAuthorized)
		{
			motionStatus = "Not Authorized";
			UpdateStatus();
		}
		else
		{
			motionStatus = "Available";
			var stepMsg = String.Format("You have taken {0} steps in the past 24 hours", steps);
			InvokeOnMainThread(() => {
				stepsMessage.Text = stepMsg;
				UpdateStatus();
			});
		}
	}));

Constructors

CMMotionManager()	Default constructor that initializes a new instance of this class with no parameters.
CMMotionManager(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
CMMotionManager(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AccelerometerActive	Whether the accelerometer is currently sending updates.
AccelerometerAvailable	Whether the device has an accelerometer.
AccelerometerData	The latest accelerometer data.
AccelerometerUpdateInterval	The duration, in seconds, between accelerometer data updates.
AttitudeReferenceFrame	The current attitude reference frame.
AvailableAttitudeReferenceFrames	Returns a bit-mask of all the available reference frames.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DeviceMotion	The latest device-motion data.
DeviceMotionActive	Whether the device is delivering device-motion updates.
DeviceMotionAvailable	Whether the device supports device-motion updates.
DeviceMotionUpdateInterval	The interval, in seconds, between device-motion data updates.
GyroActive	Whether the device gyroscope is delivering updates.
GyroAvailable	Whether the device has a gyroscope.
GyroData	The latest gyroscopic data from the device.
GyroUpdateInterval	The interval, in seconds, between gyroscopic data updates.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
MagnetometerActive	Whether the magnetometer is delivering data updates.
MagnetometerAvailable	Whether the device has a magnetometer.
MagnetometerData	The latest magnetometer data.
MagnetometerUpdateInterval	The interval, in seconds, between magnetometer updates.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
ShowsDeviceMovementDisplay	Whether the device-movement display is shown.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
StartAccelerometerUpdates()	Requests that the accelerometer begin delivering data updates.
StartAccelerometerUpdates(NSOperationQueue, CMAccelerometerHandler)	Requests that the accelerometer begin delivering data updates.
StartDeviceMotionUpdates()	Requests that the device begin delivering device-motion data updates.
StartDeviceMotionUpdates(CMAttitudeReferenceFrame)	Requests that the device begin delivering device-motion data updates, using `referenceFrame`.
StartDeviceMotionUpdates(CMAttitudeReferenceFrame, NSOperationQueue, CMDeviceMotionHandler)	Requests that the device begin delivering device-motion data updates.
StartDeviceMotionUpdates(NSOperationQueue, CMDeviceMotionHandler)	Requests that the device begin delivering device-motion data updates.
StartGyroUpdates()	Requests that the gyroscope begin delivering data updates.
StartGyroUpdates(NSOperationQueue, CMGyroHandler)	Requests that the gyroscope begin delivering data updates.
StartMagnetometerUpdates()	Requests that the magnetometer begin delivering data updates.
StartMagnetometerUpdates(NSOperationQueue, CMMagnetometerHandler)	Requests that the gyroscope begin delivering data updates.
StopAccelerometerUpdates()	Requests that the accelerometer stop delivering data updates.
StopDeviceMotionUpdates()	Requests that the device stop delivering device-motion updates.
StopGyroUpdates()	Requests that the gyroscope stop delivering data updates.
StopMagnetometerUpdates()	Requests that the magnetometer begin delivering data updates.
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to