Table of Contents

Class ThreeDofCameraDevice

Namespace
easyar

ThreeDofCameraDevice implements a three-dof camera device that outputs CameraTransformType as ThreeDofRotOnly InputFrame (containing images, camera parameters, timestamps, pose transformation matrices, and tracking status). After creation, you can call start/stop to begin and stop collecting video stream data. When the device is no longer needed, you can call close to shut it down. After closing, it should not be used further. ThreeDofCameraDevice outputs InputFrame through inputFrameSource, which should be connected to InputFrameSink for use. bufferCapacity represents the buffer capacity of InputFrame. If more than this number of InputFrame are output from the device and not released, the device will stop outputting new InputFrame until the previous ones are released. This may cause issues such as screen freezing.

ThreeDofCameraDevice

Constructors

ThreeDofCameraDevice

Default creation method.

void easyar_ThreeDofCameraDevice__ctor(easyar_ThreeDofCameraDevice * * Return)
ThreeDofCameraDevice()
public ThreeDofCameraDevice()
constructor()
+ (easyar_ThreeDofCameraDevice *) create
public convenience init()
public ThreeDofCameraDevice()

Methods

isAvailable

Check if available. Returns true only on Android or iOS and when the gyroscope is available.

bool easyar_ThreeDofCameraDevice_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

Boolean

bufferCapacity

The buffer capacity of InputFrame, default value is 8.

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

Returns

Int32

setBufferCapacity

Set the buffer capacity of InputFrame.

void easyar_ThreeDofCameraDevice_setBufferCapacity(easyar_ThreeDofCameraDevice * 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

capacity Int32

Returns

Void

inputFrameSource

InputFrame output port.

void easyar_ThreeDofCameraDevice_inputFrameSource(easyar_ThreeDofCameraDevice * 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

InputFrameSource

setFocusMode

Set the focus mode to focusMode. Call before start.

void easyar_ThreeDofCameraDevice_setFocusMode(easyar_ThreeDofCameraDevice * This, easyar_ThreeDofCameraDeviceFocusMode focusMode)
void setFocusMode(ThreeDofCameraDeviceFocusMode focusMode)
public void setFocusMode(int focusMode)
fun setFocusMode(focusMode: Int): Unit
- (void)setFocusMode:(easyar_ThreeDofCameraDeviceFocusMode)focusMode
public func setFocusMode(_ focusMode: ThreeDofCameraDeviceFocusMode) -> Void
public virtual void setFocusMode(ThreeDofCameraDeviceFocusMode focusMode)

Parameters

focusMode ThreeDofCameraDeviceFocusMode

Returns

Void

type

Camera type. Called after successful open.

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

Returns

CameraDeviceType

cameraOrientation

The angle by which the camera image needs to be rotated clockwise to display in the device's natural orientation. Called after successful open.

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

Returns

Int32

size

Get the current image size. Called after successful open.

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

Returns

Vec2I

supportedSizeCount

Get the number of all image sizes supported by the current device. Called after successful open.

int easyar_ThreeDofCameraDevice_supportedSizeCount(const easyar_ThreeDofCameraDevice * This)
int supportedSizeCount()
public int supportedSizeCount()
fun supportedSizeCount(): Int
- (int)supportedSizeCount
public func supportedSizeCount() -> Int32
public virtual int supportedSizeCount()

Returns

Int32

supportedSize

Get the index-th image size of all sizes supported by the current device. If index is out of range, returns {0, 0}. Called after successful open.

easyar_Vec2I easyar_ThreeDofCameraDevice_supportedSize(const easyar_ThreeDofCameraDevice * This, int index)
Vec2I supportedSize(int index)
public @Nonnull Vec2I supportedSize(int index)
fun supportedSize(index: Int): Vec2I
- (easyar_Vec2I *)supportedSize:(int)index
public func supportedSize(_ index: Int32) -> Vec2I
public virtual Vec2I supportedSize(int index)

Parameters

index Int32

Returns

Vec2I

setSize

Set the current image size. The closest available size to the set value will be used. You can use size to get the actual size. Called after successful open. After setting the size, frameRateRange may change.

bool easyar_ThreeDofCameraDevice_setSize(easyar_ThreeDofCameraDevice * This, easyar_Vec2I size)
bool setSize(Vec2I size)
public boolean setSize(@Nonnull Vec2I size)
fun setSize(size: Vec2I): Boolean
- (bool)setSize:(easyar_Vec2I *)size
public func setSize(_ size: Vec2I) -> Bool
public virtual bool setSize(Vec2I size)

Parameters

size Vec2I

Returns

Boolean

open

Open the rear camera of the device. Returns false if it fails to open.

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

Returns

Boolean

start

Start collecting video stream data.

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

Returns

Boolean

stop

Stop collecting video stream data.

void easyar_ThreeDofCameraDevice_stop(easyar_ThreeDofCameraDevice * This)
void stop()
public void stop()
fun stop(): Unit
- (void)stop
public func stop() -> Void
public virtual void stop()

Returns

Void

close

Close. Should not be used after closing.

void easyar_ThreeDofCameraDevice_close(easyar_ThreeDofCameraDevice * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

Returns

Void

frameRateRangeLower

Get the lower bound of the current frame rate range. Called after successful open.

double easyar_ThreeDofCameraDevice_frameRateRangeLower(const easyar_ThreeDofCameraDevice * This)
double frameRateRangeLower()
public double frameRateRangeLower()
fun frameRateRangeLower(): Double
- (double)frameRateRangeLower
public func frameRateRangeLower() -> Double
public virtual double frameRateRangeLower()

Returns

Double

frameRateRangeUpper

Get the upper bound of the current frame rate range. Called after successful open.

double easyar_ThreeDofCameraDevice_frameRateRangeUpper(const easyar_ThreeDofCameraDevice * This)
double frameRateRangeUpper()
public double frameRateRangeUpper()
fun frameRateRangeUpper(): Double
- (double)frameRateRangeUpper
public func frameRateRangeUpper() -> Double
public virtual double frameRateRangeUpper()

Returns

Double