Accelerometer Class

Description

Accelerometer calls the accelerometer provided by the operating system, and outputs AccelerometerResult .

When it is not needed anymore, call close function to close it. It shall not be used after calling close.

It is not recommended to open the accelerometer multiple times simultaneously, which may cause failure on open or cause precision downgrade.

Constructor

C

void easyar_Accelerometer__ctor(easyar_Accelerometer * * Return)

C++

Accelerometer()

Java

public Accelerometer()

Kotlin

constructor()

Objective-C

+ (easyar_Accelerometer *) create

Swift

public convenience init()

C#

public Accelerometer()

isAvailable

Checks if the component is available. It returns true only on Android or iOS with supported hardware. On other operating systems, it is not supported.

C

bool easyar_Accelerometer_isAvailable(easyar_Accelerometer * This)

C++

bool isAvailable()

Java

public boolean isAvailable()

Kotlin

fun isAvailable(): Boolean

Objective-C

- (bool)isAvailable

Swift

public func isAvailable() -> Bool

C#

public virtual bool isAvailable()

output

Output port.

C

void easyar_Accelerometer_output(easyar_Accelerometer * This, easyar_AccelerometerResultSource * * Return)

C++

std::shared_ptr<AccelerometerResultSource> output()

Java

public @Nonnull AccelerometerResultSource output()

Kotlin

fun output(): AccelerometerResultSource

Objective-C

- (easyar_AccelerometerResultSource *)output

Swift

public func output() -> AccelerometerResultSource

C#

public virtual AccelerometerResultSource output()

open

Opens the device. Sampling period is defined by implementation. If failed, it will return false.

C

bool easyar_Accelerometer_open(easyar_Accelerometer * This)

C++

bool open()

Java

public boolean open()

Kotlin

fun open(): Boolean

Objective-C

- (bool)open

Swift

public func `open`() -> Bool

C#

public virtual bool open()

openWithSamplingPeriod

Opens the device with a specific sampling period. Sampling period is limited by hardware and may not reach the specified value. If failed, it will return false.

C

bool easyar_Accelerometer_openWithSamplingPeriod(easyar_Accelerometer * This, int samplingPeriodMilliseconds)

C++

bool openWithSamplingPeriod(int samplingPeriodMilliseconds)

Java

public boolean openWithSamplingPeriod(int samplingPeriodMilliseconds)

Kotlin

fun openWithSamplingPeriod(samplingPeriodMilliseconds: Int): Boolean

Objective-C

- (bool)openWithSamplingPeriod:(int)samplingPeriodMilliseconds

Swift

public func openWithSamplingPeriod(_ samplingPeriodMilliseconds: Int32) -> Bool

C#

public virtual bool openWithSamplingPeriod(int samplingPeriodMilliseconds)

close

Closes. It shall not be used after calling close.

C

void easyar_Accelerometer_close(easyar_Accelerometer * This)

C++

void close()

Java

public void close()

Kotlin

fun close(): Unit

Objective-C

- (void)close

Swift

public func close() -> Void

C#

public virtual void close()

getCurrentResult

Gets the most recent result. If there is no result, it returns empty.

C

easyar_OptionalOfAccelerometerResult easyar_Accelerometer_getCurrentResult(easyar_Accelerometer * This)

C++

std::optional<AccelerometerResult> getCurrentResult()

Java

public @Nullable AccelerometerResult getCurrentResult()

Kotlin

fun getCurrentResult(): AccelerometerResult?

Objective-C

- (easyar_AccelerometerResult *)getCurrentResult

Swift

public func getCurrentResult() -> AccelerometerResult?

C#

public virtual Optional<AccelerometerResult> getCurrentResult()