Table of Contents

Class Accelerometer

Namespace
easyar

Accelerometer calls the system-provided accelerometer and outputs AccelerometerResult. When the device is no longer needed, call close to close it. It should not be used after close. Opening it multiple times at the same time is not recommended, as it may become unavailable or lose accuracy.

Accelerometer

Constructors

Accelerometer

void easyar_Accelerometer__ctor(easyar_Accelerometer * * Return)
Accelerometer()
public Accelerometer()
constructor()
+ (easyar_Accelerometer *) create
public convenience init()
public Accelerometer()

Methods

isAvailable

Checks whether it is available. Returns true only on Android or iOS when the hardware supports it. Other operating systems are not supported yet.

bool easyar_Accelerometer_isAvailable(easyar_Accelerometer * This)
bool isAvailable()
public boolean isAvailable()
fun isAvailable(): Boolean
- (bool)isAvailable
public func isAvailable() -> Bool
public virtual bool isAvailable()

Returns

Type Description
Boolean

output

Output port.

void easyar_Accelerometer_output(easyar_Accelerometer * This, easyar_AccelerometerResultSource * * Return)
std::shared_ptr<AccelerometerResultSource> output()
public @Nonnull AccelerometerResultSource output()
fun output(): AccelerometerResultSource
- (easyar_AccelerometerResultSource *)output
public func output() -> AccelerometerResultSource
public virtual AccelerometerResultSource output()

Returns

Type Description
AccelerometerResultSource

open

Opens the device. The sampling period is determined by the internal implementation. If opening fails, returns false.

bool easyar_Accelerometer_open(easyar_Accelerometer * This)
bool open()
public boolean open()
fun open(): Boolean
- (bool)open
public func `open`() -> Bool
public virtual bool open()

Returns

Type Description
Boolean

openWithSamplingPeriod

Opens the device with a specific sampling period. The sampling period may be limited by hardware and may not reach the specified value. If opening fails, returns false.

bool easyar_Accelerometer_openWithSamplingPeriod(easyar_Accelerometer * This, int samplingPeriodMilliseconds)
bool openWithSamplingPeriod(int samplingPeriodMilliseconds)
public boolean openWithSamplingPeriod(int samplingPeriodMilliseconds)
fun openWithSamplingPeriod(samplingPeriodMilliseconds: Int): Boolean
- (bool)openWithSamplingPeriod:(int)samplingPeriodMilliseconds
public func openWithSamplingPeriod(_ samplingPeriodMilliseconds: Int32) -> Bool
public virtual bool openWithSamplingPeriod(int samplingPeriodMilliseconds)

Parameters

Name Type Description
samplingPeriodMilliseconds Int32

Returns

Type Description
Boolean

close

Closes the device. It should not be used after close.

void easyar_Accelerometer_close(easyar_Accelerometer * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

Returns

Type Description
Void

getCurrentResult

Gets the current latest result. If no result has been obtained yet, returns empty.

easyar_OptionalOfAccelerometerResult easyar_Accelerometer_getCurrentResult(easyar_Accelerometer * This)
std::optional<AccelerometerResult> getCurrentResult()
public @Nullable AccelerometerResult getCurrentResult()
fun getCurrentResult(): AccelerometerResult?
- (easyar_AccelerometerResult *)getCurrentResult
public func getCurrentResult() -> AccelerometerResult?
public virtual Optional<AccelerometerResult> getCurrentResult()

Returns

Type Description
Optional<AccelerometerResult>