Table of Contents

Class AREngineCameraDevice

Namespace
easyar

AREngineCameraDevice implements an AREngine-based camera device that outputs InputFrame (including image, camera parameters, timestamp, 6DOF pose information, and tracking status). After creation, start/stop can be called to start and stop video stream collection. When the device is no longer needed, close can be called to close it. It should not be used after close. AREngineCameraDevice outputs InputFrame through inputFrameSource. inputFrameSource should be connected to InputFrameSink for use. bufferCapacity indicates the capacity of the InputFrame buffer. If more than this number of InputFrame objects are output from the device and not released, the device will stop outputting new InputFrame objects until previous InputFrame objects are released. This may cause problems such as a frozen image.

AREngineCameraDevice

Constructors

AREngineCameraDevice 

void easyar_AREngineCameraDevice__ctor(easyar_AREngineCameraDevice * * Return)
AREngineCameraDevice()
public AREngineCameraDevice()
constructor()
+ (easyar_AREngineCameraDevice *) create
public convenience init()
public AREngineCameraDevice()

Methods

isAvailable

Checks whether it is available. Returns true only on HarmonyOS systems with AREngine installed.

bool easyar_AREngineCameraDevice_isAvailable(void)
static bool isAvailable()
public static boolean isAvailable()
companion object fun isAvailable(): Boolean
+ (bool)isAvailable
public static func isAvailable() -> Bool
public static bool isAvailable()

Returns

Type Description
Boolean

bufferCapacity

Capacity of the InputFrame buffer. The default value is 8.

int easyar_AREngineCameraDevice_bufferCapacity(const easyar_AREngineCameraDevice * This)
int bufferCapacity()
public int bufferCapacity()
fun bufferCapacity(): Int
- (int)bufferCapacity
public func bufferCapacity() -> Int32
public virtual int bufferCapacity()

Returns

Type Description
Int32

setBufferCapacity

Sets the capacity of the InputFrame buffer.

void easyar_AREngineCameraDevice_setBufferCapacity(easyar_AREngineCameraDevice * This, int capacity)
void setBufferCapacity(int capacity)
public void setBufferCapacity(int capacity)
fun setBufferCapacity(capacity: Int): Unit
- (void)setBufferCapacity:(int)capacity
public func setBufferCapacity(_ capacity: Int32) -> Void
public virtual void setBufferCapacity(int capacity)

Parameters

Name Type Description
capacity Int32

Returns

Type Description
Void

inputFrameSource

InputFrame output port.

void easyar_AREngineCameraDevice_inputFrameSource(easyar_AREngineCameraDevice * This, easyar_InputFrameSource * * Return)
std::shared_ptr<InputFrameSource> inputFrameSource()
public @Nonnull InputFrameSource inputFrameSource()
fun inputFrameSource(): InputFrameSource
- (easyar_InputFrameSource *)inputFrameSource
public func inputFrameSource() -> InputFrameSource
public virtual InputFrameSource inputFrameSource()

Returns

Type Description
InputFrameSource

setFocusMode

Sets the focus mode to focusMode.

void easyar_AREngineCameraDevice_setFocusMode(easyar_AREngineCameraDevice * This, easyar_AREngineCameraDeviceFocusMode focusMode)
void setFocusMode(AREngineCameraDeviceFocusMode focusMode)
public void setFocusMode(int focusMode)
fun setFocusMode(focusMode: Int): Unit
- (void)setFocusMode:(easyar_AREngineCameraDeviceFocusMode)focusMode
public func setFocusMode(_ focusMode: AREngineCameraDeviceFocusMode) -> Void
public virtual void setFocusMode(AREngineCameraDeviceFocusMode focusMode)

Parameters

Name Type Description
focusMode AREngineCameraDeviceFocusMode

Returns

Type Description
Void

start

Starts collecting video stream data.

bool easyar_AREngineCameraDevice_start(easyar_AREngineCameraDevice * This)
bool start()
public boolean start()
fun start(): Boolean
- (bool)start
public func start() -> Bool
public virtual bool start()

Returns

Type Description
Boolean

stop

Stops collecting video stream data.

void easyar_AREngineCameraDevice_stop(easyar_AREngineCameraDevice * This)
void stop()
public void stop()
fun stop(): Unit
- (void)stop
public func stop() -> Void
public virtual void stop()

Returns

Type Description
Void

close

Closes. It should not be used after close.

void easyar_AREngineCameraDevice_close(easyar_AREngineCameraDevice * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

Returns

Type Description
Void

type

Camera type.

easyar_CameraDeviceType easyar_AREngineCameraDevice_type(const easyar_AREngineCameraDevice * This)
CameraDeviceType type()
public int type()
fun type(): Int
- (easyar_CameraDeviceType)type
public func type() -> CameraDeviceType
public virtual CameraDeviceType type()

Returns

Type Description
CameraDeviceType

cameraOrientation

Clockwise rotation angle required when displaying the camera image in the device's natural orientation.

int easyar_AREngineCameraDevice_cameraOrientation(const easyar_AREngineCameraDevice * This)
int cameraOrientation()
public int cameraOrientation()
fun cameraOrientation(): Int
- (int)cameraOrientation
public func cameraOrientation() -> Int32
public virtual int cameraOrientation()

Returns

Type Description
Int32

size

Gets the current image size.

easyar_Vec2I easyar_AREngineCameraDevice_size(const easyar_AREngineCameraDevice * This)
Vec2I size()
public @Nonnull Vec2I size()
fun size(): Vec2I
- (easyar_Vec2I *)size
public func size() -> Vec2I
public virtual Vec2I size()

Returns

Type Description
Vec2I

frameRateRangeLower

Gets the lower bound of the current frame rate range.

double easyar_AREngineCameraDevice_frameRateRangeLower(const easyar_AREngineCameraDevice * This)
double frameRateRangeLower()
public double frameRateRangeLower()
fun frameRateRangeLower(): Double
- (double)frameRateRangeLower
public func frameRateRangeLower() -> Double
public virtual double frameRateRangeLower()

Returns

Type Description
Double

frameRateRangeUpper

Gets the upper bound of the current frame rate range.

double easyar_AREngineCameraDevice_frameRateRangeUpper(const easyar_AREngineCameraDevice * This)
double frameRateRangeUpper()
public double frameRateRangeUpper()
fun frameRateRangeUpper(): Double
- (double)frameRateRangeUpper
public func frameRateRangeUpper() -> Double
public virtual double frameRateRangeUpper()

Returns

Type Description
Double