Class ARKitCameraDevice

Namespace

easyar

ARKitCameraDevice implements an ARKit-based camera device that outputs InputFrame (containing images, camera parameters, timestamps, 6DOF position information, and tracking status). After creation, you can call start/stop to start and stop collecting video stream data. When the device is no longer needed, you can call close to shut it down. Do not continue to use it after close. ARKitCameraDevice outputs InputFrame through inputFrameSource. inputFrameSource should be connected to InputFrameSink for use. bufferCapacity represents the capacity of the InputFrame buffer. If more than this number of InputFrame are output from this device and not released, the device will no longer output new InputFrame until the previous ones are released. This may cause issues such as screen freezing.

ARKitCameraDevice

Constructors

ARKitCameraDevice

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice__ctor(easyar_ARKitCameraDevice * * Return)

ARKitCameraDevice()

public ARKitCameraDevice()

constructor()

+ (easyar_ARKitCameraDevice *) create

public convenience init()

public ARKitCameraDevice()

Methods

isAvailable

Checks if it is available. Returns true only on iOS 11 or later systems and on hardware that supports ARKit.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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

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

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_ARKitCameraDevice_bufferCapacity(const easyar_ARKitCameraDevice * 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.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice_setBufferCapacity(easyar_ARKitCameraDevice * 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

The output port for InputFrame.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice_inputFrameSource(easyar_ARKitCameraDevice * 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. Call before start. Valid from iOS 11.3 onwards.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice_setFocusMode(easyar_ARKitCameraDevice * This, easyar_ARKitCameraDeviceFocusMode focusMode)

void setFocusMode(ARKitCameraDeviceFocusMode focusMode)

public void setFocusMode(int focusMode)

fun setFocusMode(focusMode: Int): Unit

- (void)setFocusMode:(easyar_ARKitCameraDeviceFocusMode)focusMode

public func setFocusMode(_ focusMode: ARKitCameraDeviceFocusMode) -> Void

public virtual void setFocusMode(ARKitCameraDeviceFocusMode focusMode)

Parameters

Name	Type	Description
focusMode	ARKitCameraDeviceFocusMode

Returns

Type	Description
Void

start

Starts collecting video stream data.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_ARKitCameraDevice_start(easyar_ARKitCameraDevice * 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.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice_stop(easyar_ARKitCameraDevice * 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. Do not continue to use after close.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ARKitCameraDevice_close(easyar_ARKitCameraDevice * 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.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

easyar_CameraDeviceType easyar_ARKitCameraDevice_type(const easyar_ARKitCameraDevice * 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

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

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_ARKitCameraDevice_cameraOrientation(const easyar_ARKitCameraDevice * 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.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

easyar_Vec2I easyar_ARKitCameraDevice_size(const easyar_ARKitCameraDevice * 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

frameRate

Gets the current frame rate.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

double easyar_ARKitCameraDevice_frameRate(const easyar_ARKitCameraDevice * This)

double frameRate()

public double frameRate()

fun frameRate(): Double

- (double)frameRate

public func frameRate() -> Double

public virtual double frameRate()

Returns

Type	Description
Double

supportedSizeCount

Gets the number of all image sizes supported by the current device.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_ARKitCameraDevice_supportedSizeCount(const easyar_ARKitCameraDevice * This)

int supportedSizeCount()

public int supportedSizeCount()

fun supportedSizeCount(): Int

- (int)supportedSizeCount

public func supportedSizeCount() -> Int32

public virtual int supportedSizeCount()

Returns

Type	Description
Int32

supportedSize

Gets the index-th image size supported by the current device. If index is out of range, returns {0, 0}.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

easyar_Vec2I easyar_ARKitCameraDevice_supportedSize(const easyar_ARKitCameraDevice * 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

Name	Type	Description
index	Int32

Returns

Type	Description
Vec2I

setSize

Sets the current image size. The closest possible value to the set value will be used. You can use size to get the actual size. After setting size, the frameRateRange may change.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_ARKitCameraDevice_setSize(easyar_ARKitCameraDevice * 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

Name	Type	Description
size	Vec2I

Returns

Type	Description
Boolean

supportedFrameRateCount

Gets the number of frame rates supported by the current device.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_ARKitCameraDevice_supportedFrameRateCount(const easyar_ARKitCameraDevice * This)

int supportedFrameRateCount()

public int supportedFrameRateCount()

fun supportedFrameRateCount(): Int

- (int)supportedFrameRateCount

public func supportedFrameRateCount() -> Int32

public virtual int supportedFrameRateCount()

Returns

Type	Description
Int32

supportedFrameRate

Gets the index-th frame rate supported by the current device.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

double easyar_ARKitCameraDevice_supportedFrameRate(const easyar_ARKitCameraDevice * This, int index)

double supportedFrameRate(int index)

public double supportedFrameRate(int index)

fun supportedFrameRate(index: Int): Double

- (double)supportedFrameRate:(int)index

public func supportedFrameRate(_ index: Int32) -> Double

public virtual double supportedFrameRate(int index)

Parameters

Name	Type	Description
index	Int32

Returns

Type	Description
Double

setFrameRate

Sets the current frame rate of the current device.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_ARKitCameraDevice_setFrameRate(easyar_ARKitCameraDevice * This, double frameRate)

bool setFrameRate(double frameRate)

public boolean setFrameRate(double frameRate)

fun setFrameRate(frameRate: Double): Boolean

- (bool)setFrameRate:(double)frameRate

public func setFrameRate(_ frameRate: Double) -> Bool

public virtual bool setFrameRate(double frameRate)

Parameters

Name	Type	Description
frameRate	Double

Returns

Type	Description
Boolean