Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
366 lines (366 sloc) 21.8 KB
<Type Name="CMSensorRecorder" FullName="CoreMotion.CMSensorRecorder">
<TypeSignature Language="C#" Value="public class CMSensorRecorder : Foundation.NSObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CMSensorRecorder extends Foundation.NSObject" />
<TypeSignature Language="DocId" Value="T:CoreMotion.CMSensorRecorder" />
<TypeSignature Language="F#" Value="type CMSensorRecorder = class&#xA; inherit NSObject" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Foundation.NSObject</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>Foundation.Register("CMSensorRecorder", true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Gathers and retrieves accelerometer data.</summary>
<remarks>To be added.</remarks>
<related type="externalDocumentation" href="https://developer.apple.com/library/ios/documentation/CoreMotion/Reference/CMSensorRecorder_class/index.html">Apple documentation for <c>CMSensorRecorder</c></related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CMSensorRecorder ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("init")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Default constructor, initializes a new instance of this class.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CMSensorRecorder (Foundation.NSObjectFlag t);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Foundation.NSObjectFlag t) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.#ctor(Foundation.NSObjectFlag)" />
<MemberSignature Language="F#" Value="new CoreMotion.CMSensorRecorder : Foundation.NSObjectFlag -&gt; CoreMotion.CMSensorRecorder" Usage="new CoreMotion.CMSensorRecorder t" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="t" Type="Foundation.NSObjectFlag" />
</Parameters>
<Docs>
<param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
<summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
<remarks>
<para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke the constructor that takes the NSObjectFlag.Empty they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.</para>
<para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
<para>It is the developer's responsibility to completely initialize the object if they chain up using the NSObjectFlag.Empty path.</para>
<para>In general, if the developer's constructor invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class. </para>
<para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// The NSObjectFlag merely allocates the object and registers the
// C# class with the Objective-C runtime if necessary, but no actual
// initXxx method is invoked, that is done later in the constructor
//
// This is taken from Xamarin.iOS's source code:
//
[Export ("initWithFrame:")]
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
{
// Invoke the init method now.
var initWithFrame = new Selector ("initWithFrame:").Handle;
if (IsDirectBinding)
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
else
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
}
]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal CMSensorRecorder (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.#ctor(System.IntPtr)" />
<MemberSignature Language="F#" Value="new CoreMotion.CMSensorRecorder : nativeint -&gt; CoreMotion.CMSensorRecorder" Usage="new CoreMotion.CMSensorRecorder handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">Pointer (handle) to the unmanaged object.</param>
<summary>A constructor used when creating managed representations of unmanaged objects; Called by the runtime.</summary>
<remarks>
<para>This constructor is invoked by the runtime infrastructure (<see cref="M:ObjCRuntime.Runtime.GetNSObject(System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizationStatus">
<MemberSignature Language="C#" Value="public static CoreMotion.CMAuthorizationStatus AuthorizationStatus { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype CoreMotion.CMAuthorizationStatus AuthorizationStatus" />
<MemberSignature Language="DocId" Value="P:CoreMotion.CMSensorRecorder.AuthorizationStatus" />
<MemberSignature Language="F#" Value="member this.AuthorizationStatus : CoreMotion.CMAuthorizationStatus" Usage="CoreMotion.CMSensorRecorder.AuthorizationStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 4, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("authorizationStatus")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 4, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>CoreMotion.CMAuthorizationStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassHandle">
<MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
<MemberSignature Language="DocId" Value="P:CoreMotion.CMSensorRecorder.ClassHandle" />
<MemberSignature Language="F#" Value="member this.ClassHandle : nativeint" Usage="CoreMotion.CMSensorRecorder.ClassHandle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>The handle for this class.</summary>
<value>The pointer to the Objective-C class.</value>
<remarks>Each Xamarin.iOS class mirrors an unmanaged Objective-C class. This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
</Docs>
</Member>
<Member MemberName="GetAccelerometerData">
<MemberSignature Language="C#" Value="public virtual CoreMotion.CMSensorDataList GetAccelerometerData (Foundation.NSDate fromDate, Foundation.NSDate toDate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class CoreMotion.CMSensorDataList GetAccelerometerData(class Foundation.NSDate fromDate, class Foundation.NSDate toDate) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.GetAccelerometerData(Foundation.NSDate,Foundation.NSDate)" />
<MemberSignature Language="F#" Value="abstract member GetAccelerometerData : Foundation.NSDate * Foundation.NSDate -&gt; CoreMotion.CMSensorDataList&#xA;override this.GetAccelerometerData : Foundation.NSDate * Foundation.NSDate -&gt; CoreMotion.CMSensorDataList" Usage="cMSensorRecorder.GetAccelerometerData (fromDate, toDate)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("accelerometerDataFromDate:toDate:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 3, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>CoreMotion.CMSensorDataList</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fromDate" Type="Foundation.NSDate" />
<Parameter Name="toDate" Type="Foundation.NSDate" />
</Parameters>
<Docs>
<param name="fromDate">To be added.</param>
<param name="toDate">To be added.</param>
<summary>Retrieves accelerometer data for the specified time interval.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAccelerometerDataSince">
<MemberSignature Language="C#" Value="public virtual CoreMotion.CMSensorDataList GetAccelerometerDataSince (ulong identifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class CoreMotion.CMSensorDataList GetAccelerometerDataSince(unsigned int64 identifier) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.GetAccelerometerDataSince(System.UInt64)" />
<MemberSignature Language="F#" Value="abstract member GetAccelerometerDataSince : uint64 -&gt; CoreMotion.CMSensorDataList&#xA;override this.GetAccelerometerDataSince : uint64 -&gt; CoreMotion.CMSensorDataList" Usage="cMSensorRecorder.GetAccelerometerDataSince identifier" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Apple removed this API in iOS 9.3.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>CoreMotion.CMSensorDataList</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identifier" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="identifier">To be added.</param>
<summary>Retrieves the accelerometer data recorded since the Unix time (see <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=System%20Date%20Time%20Offset%20From%20Unix%20Time%20Seconds&amp;scope=Xamarin" title="M:System.DateTimeOffset.FromUnixTimeSeconds*">M:System.DateTimeOffset.FromUnixTimeSeconds*</a></format> and <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=System%20Date%20Time%20Offset%20To%20Unix%20Time%20Seconds&amp;scope=Xamarin" title="M:System.DateTimeOffset.ToUnixTimeSeconds*">M:System.DateTimeOffset.ToUnixTimeSeconds*</a></format>).</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAccelerometerRecordingAvailable">
<MemberSignature Language="C#" Value="public static bool IsAccelerometerRecordingAvailable { get; }" />
<MemberSignature Language="ILAsm" Value=".property bool IsAccelerometerRecordingAvailable" />
<MemberSignature Language="DocId" Value="P:CoreMotion.CMSensorRecorder.IsAccelerometerRecordingAvailable" />
<MemberSignature Language="F#" Value="member this.IsAccelerometerRecordingAvailable : bool" Usage="CoreMotion.CMSensorRecorder.IsAccelerometerRecordingAvailable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 3, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("isAccelerometerRecordingAvailable")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 3, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether accelerometer recording is available on the device.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAuthorizedForRecording">
<MemberSignature Language="C#" Value="public static bool IsAuthorizedForRecording { get; }" />
<MemberSignature Language="ILAsm" Value=".property bool IsAuthorizedForRecording" />
<MemberSignature Language="DocId" Value="P:CoreMotion.CMSensorRecorder.IsAuthorizedForRecording" />
<MemberSignature Language="F#" Value="member this.IsAuthorizedForRecording : bool" Usage="CoreMotion.CMSensorRecorder.IsAuthorizedForRecording" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.WatchOS, 4, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'CMSensorRecorder.AuthorizationStatus' instead.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'CMSensorRecorder.AuthorizationStatus' instead.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("isAuthorizedForRecording")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.WatchOS, 4, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'CMSensorRecorder.AuthorizationStatus' instead.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'CMSensorRecorder.AuthorizationStatus' instead.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Developers should not use this deprecated property. Developers should use 'CMSensorRecorder.AuthorizationStatus' instead.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RecordAccelerometer">
<MemberSignature Language="C#" Value="public virtual void RecordAccelerometer (double duration);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RecordAccelerometer(float64 duration) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMotion.CMSensorRecorder.RecordAccelerometer(System.Double)" />
<MemberSignature Language="F#" Value="abstract member RecordAccelerometer : double -&gt; unit&#xA;override this.RecordAccelerometer : double -&gt; unit" Usage="cMSensorRecorder.RecordAccelerometer duration" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("recordAccelerometerForDuration:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 3, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="duration" Type="System.Double" />
</Parameters>
<Docs>
<param name="duration">To be added.</param>
<summary>Begins recording sensor data for <paramref name="duration" /> seconds.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.