Class CameraDevice

命名空间

easyar

CameraDevice实现了一个camera设备，输出 InputFrame （包含图像、摄像机参数和时间戳）。在Windows、Mac、Android和iOS上可用。 打开之后，可以调用start/stop来开始和停止采集数据。start/stop不会影响之前所设置的camera参数。 当不再需要该设备时，可以调用close对其进行关闭。close之后不应继续使用。 CameraDevice通过inputFrameSource输出 InputFrame ，应将inputFrameSource连接到 InputFrameSink 上进行使用。 bufferCapacity表示 InputFrame 缓冲的容量，如果有超过此数量的 InputFrame 从该设备中输出并且没有被释放，该设备将不再输出新的 InputFrame ，直到之前的 InputFrame 被释放。这可能造成画面卡住等问题。 Android使用时需要在AndroidManifest.xml中加入android.permission.CAMERA权限声明。 iOS使用时需要在Info.plist中加入NSCameraUsageDescription权限声明。

CameraDevice

构造函数

CameraDevice

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

void easyar_CameraDevice__ctor(easyar_CameraDevice * * Return)

CameraDevice()

public CameraDevice()

constructor()

+ (easyar_CameraDevice *) create

public convenience init()

public CameraDevice()

方法

isAvailable

检查是否可用。只在Windows、Mac、Android和iOS上返回true。

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

bool easyar_CameraDevice_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()

返回

类型	描述
Boolean

androidCameraApiType

在Android上，可用于获得使用的Camera API（camera1或camera2）。camera1兼容性较好，但缺乏一些必要的信息，如时间戳。camera2在部分设备上存在兼容性问题。

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

easyar_AndroidCameraApiType easyar_CameraDevice_androidCameraApiType(easyar_CameraDevice * This)

AndroidCameraApiType androidCameraApiType()

public int androidCameraApiType()

fun androidCameraApiType(): Int

- (easyar_AndroidCameraApiType)androidCameraApiType

public func androidCameraApiType() -> AndroidCameraApiType

public virtual AndroidCameraApiType androidCameraApiType()

返回

类型	描述
AndroidCameraApiType

setAndroidCameraApiType

在Android上，可用于设置使用的Camera API（Camera 1或Camera 2）。必须在调用openWithIndex、openWithSpecificType或openWithPreferredType之前进行设置，否则不会生效。 推荐使用 CameraDeviceSelector 以根据使用的主要算法来创建设好推荐Camera API的CameraDevice。

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

void easyar_CameraDevice_setAndroidCameraApiType(easyar_CameraDevice * This, easyar_AndroidCameraApiType type)

void setAndroidCameraApiType(AndroidCameraApiType type)

public void setAndroidCameraApiType(int type)

fun setAndroidCameraApiType(type: Int): Unit

- (void)setAndroidCameraApiType:(easyar_AndroidCameraApiType)type

public func setAndroidCameraApiType(_ type: AndroidCameraApiType) -> Void

public virtual void setAndroidCameraApiType(AndroidCameraApiType type)

参数

名称	类型	描述
type	AndroidCameraApiType

返回

类型	描述
Void

bufferCapacity

InputFrame 缓冲的容量，默认值为8。

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

int easyar_CameraDevice_bufferCapacity(const easyar_CameraDevice * This)

int bufferCapacity()

public int bufferCapacity()

fun bufferCapacity(): Int

- (int)bufferCapacity

public func bufferCapacity() -> Int32

public virtual int bufferCapacity()

返回

类型	描述
Int32

setBufferCapacity

设置 InputFrame 缓冲的容量。

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

void easyar_CameraDevice_setBufferCapacity(easyar_CameraDevice * 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)

参数

名称	类型	描述
capacity	Int32

返回

类型	描述
Void

inputFrameSource

InputFrame 输出端口。

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

void easyar_CameraDevice_inputFrameSource(easyar_CameraDevice * 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()

返回

类型	描述
InputFrameSource

setStateChangedCallback

设置状态变化回调以通知摄像机断开或被抢占的状态。只在Windows平台上有作用。

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

void easyar_CameraDevice_setStateChangedCallback(easyar_CameraDevice * This, easyar_CallbackScheduler * callbackScheduler, easyar_OptionalOfFunctorOfVoidFromCameraState stateChangedCallback)

void setStateChangedCallback(std::shared_ptr<CallbackScheduler> callbackScheduler, std::optional<std::function<void(CameraState)>> stateChangedCallback)

public void setStateChangedCallback(@Nonnull CallbackScheduler callbackScheduler, @Nullable FunctorOfVoidFromCameraState stateChangedCallback)

fun setStateChangedCallback(callbackScheduler: CallbackScheduler, stateChangedCallback: FunctorOfVoidFromCameraState?): Unit

- (void)setStateChangedCallback:(easyar_CallbackScheduler *)callbackScheduler stateChangedCallback:(void (^)(easyar_CameraState))stateChangedCallback

public func setStateChangedCallback(_ callbackScheduler: CallbackScheduler, _ stateChangedCallback: ((CameraState) -> Void)?) -> Void

public virtual void setStateChangedCallback(CallbackScheduler callbackScheduler, Optional<Action<CameraState>> stateChangedCallback)

参数

名称	类型	描述
callbackScheduler	CallbackScheduler
stateChangedCallback	Optional<Action<CameraState>>

返回

类型	描述
Void

requestPermissions

请求camera系统权限。你可以选择使用这个函数或自己申请权限。只在Android和iOS平台上有效，其他平台上的行为为直接调用回调通知权限已授权。应在UI线程调用该函数。

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

void easyar_CameraDevice_requestPermissions(easyar_CallbackScheduler * callbackScheduler, easyar_OptionalOfFunctorOfVoidFromPermissionStatusAndString permissionCallback)

static void requestPermissions(std::shared_ptr<CallbackScheduler> callbackScheduler, std::optional<std::function<void(PermissionStatus, std::string)>> permissionCallback)

public static void requestPermissions(@Nonnull CallbackScheduler callbackScheduler, @Nullable FunctorOfVoidFromPermissionStatusAndString permissionCallback)

companion object fun requestPermissions(callbackScheduler: CallbackScheduler, permissionCallback: FunctorOfVoidFromPermissionStatusAndString?): Unit

+ (void)requestPermissions:(easyar_CallbackScheduler *)callbackScheduler permissionCallback:(void (^)(easyar_PermissionStatus status, NSString * value))permissionCallback

public static func requestPermissions(_ callbackScheduler: CallbackScheduler, _ permissionCallback: ((PermissionStatus, String) -> Void)?) -> Void

public static void requestPermissions(CallbackScheduler callbackScheduler, Optional<Action<PermissionStatus, string>> permissionCallback)

参数

名称	类型	描述
callbackScheduler	CallbackScheduler
permissionCallback	Optional<Action<PermissionStatus,String>>

返回

类型	描述
Void

cameraCount

获得操作系统识别到的camera数量。

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

int easyar_CameraDevice_cameraCount(void)

static int cameraCount()

public static int cameraCount()

companion object fun cameraCount(): Int

+ (int)cameraCount

public static func cameraCount() -> Int32

public static int cameraCount()

返回

类型	描述
Int32

openWithIndex

按照camera索引打开camera设备。

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

bool easyar_CameraDevice_openWithIndex(easyar_CameraDevice * This, int cameraIndex)

bool openWithIndex(int cameraIndex)

public boolean openWithIndex(int cameraIndex)

fun openWithIndex(cameraIndex: Int): Boolean

- (bool)openWithIndex:(int)cameraIndex

public func openWithIndex(_ cameraIndex: Int32) -> Bool

public virtual bool openWithIndex(int cameraIndex)

参数

名称	类型	描述
cameraIndex	Int32

返回

类型	描述
Boolean

openWithSpecificType

按照精确的camera设备类型打开camera设备，如果没有匹配的类型则会返回false。在Mac上，camera类型无法判别。

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

bool easyar_CameraDevice_openWithSpecificType(easyar_CameraDevice * This, easyar_CameraDeviceType type)

bool openWithSpecificType(CameraDeviceType type)

public boolean openWithSpecificType(int type)

fun openWithSpecificType(type: Int): Boolean

- (bool)openWithSpecificType:(easyar_CameraDeviceType)type

public func openWithSpecificType(_ type: CameraDeviceType) -> Bool

public virtual bool openWithSpecificType(CameraDeviceType type)

参数

名称	类型	描述
type	CameraDeviceType

返回

类型	描述
Boolean

openWithPreferredType

按照camera设备类型打开camera设备，如果没有匹配的类型则会尝试打开第一个camera设备。

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

bool easyar_CameraDevice_openWithPreferredType(easyar_CameraDevice * This, easyar_CameraDeviceType type)

bool openWithPreferredType(CameraDeviceType type)

public boolean openWithPreferredType(int type)

fun openWithPreferredType(type: Int): Boolean

- (bool)openWithPreferredType:(easyar_CameraDeviceType)type

public func openWithPreferredType(_ type: CameraDeviceType) -> Bool

public virtual bool openWithPreferredType(CameraDeviceType type)

参数

名称	类型	描述
type	CameraDeviceType

返回

类型	描述
Boolean

start

开始采集数据。

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

bool easyar_CameraDevice_start(easyar_CameraDevice * This)

bool start()

public boolean start()

fun start(): Boolean

- (bool)start

public func start() -> Bool

public virtual bool start()

返回

类型	描述
Boolean

stop

停止采集数据。这个方法只会停止捕获图像，所有参数和连接将不会受到影响。

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

void easyar_CameraDevice_stop(easyar_CameraDevice * This)

void stop()

public void stop()

fun stop(): Unit

- (void)stop

public func stop() -> Void

public virtual void stop()

返回

类型	描述
Void

close

关闭camera。close之后不应继续使用。

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

void easyar_CameraDevice_close(easyar_CameraDevice * This)

void close()

public void close()

fun close(): Unit

- (void)close

public func close() -> Void

public virtual void close()

返回

类型	描述
Void

index

cameras索引。在成功的open之后调用。

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

int easyar_CameraDevice_index(const easyar_CameraDevice * This)

int index()

public int index()

fun index(): Int

- (int)index

public func index() -> Int32

public virtual int index()

返回

类型	描述
Int32

type

camera类型。在成功的open之后调用。

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

easyar_CameraDeviceType easyar_CameraDevice_type(const easyar_CameraDevice * This)

CameraDeviceType type()

public int type()

fun type(): Int

- (easyar_CameraDeviceType)type

public func type() -> CameraDeviceType

public virtual CameraDeviceType type()

返回

类型	描述
CameraDeviceType

cameraOrientation

camera图像在设备的自然方向上显示时需要顺时针旋转的角度。在成功的open之后调用。

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

int easyar_CameraDevice_cameraOrientation(const easyar_CameraDevice * This)

int cameraOrientation()

public int cameraOrientation()

fun cameraOrientation(): Int

- (int)cameraOrientation

public func cameraOrientation() -> Int32

public virtual int cameraOrientation()

返回

类型	描述
Int32

cameraParameters

camera参数，包括图像大小、焦距、主点、camera类型和camera相对设备自然方向的旋转角度。在成功的open之后调用。

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

void easyar_CameraDevice_cameraParameters(easyar_CameraDevice * This, easyar_CameraParameters * * Return)

std::shared_ptr<CameraParameters> cameraParameters()

public @Nonnull CameraParameters cameraParameters()

fun cameraParameters(): CameraParameters

- (easyar_CameraParameters *)cameraParameters

public func cameraParameters() -> CameraParameters

public virtual CameraParameters cameraParameters()

返回

类型	描述
CameraParameters

setCameraParameters

设置camera参数。在成功的open之后调用。

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

void easyar_CameraDevice_setCameraParameters(easyar_CameraDevice * This, easyar_CameraParameters * cameraParameters)

void setCameraParameters(std::shared_ptr<CameraParameters> cameraParameters)

public void setCameraParameters(@Nonnull CameraParameters cameraParameters)

fun setCameraParameters(cameraParameters: CameraParameters): Unit

- (void)setCameraParameters:(easyar_CameraParameters *)cameraParameters

public func setCameraParameters(_ cameraParameters: CameraParameters) -> Void

public virtual void setCameraParameters(CameraParameters cameraParameters)

参数

名称	类型	描述
cameraParameters	CameraParameters

返回

类型	描述
Void

size

获取当前图像大小。在成功的open之后调用。

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

easyar_Vec2I easyar_CameraDevice_size(const easyar_CameraDevice * This)

Vec2I size()

public @Nonnull Vec2I size()

fun size(): Vec2I

- (easyar_Vec2I *)size

public func size() -> Vec2I

public virtual Vec2I size()

返回

类型	描述
Vec2I

supportedSizeCount

获取当前设备支持的所有图像大小的个数。在成功的open之后调用。

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

int easyar_CameraDevice_supportedSizeCount(const easyar_CameraDevice * This)

int supportedSizeCount()

public int supportedSizeCount()

fun supportedSizeCount(): Int

- (int)supportedSizeCount

public func supportedSizeCount() -> Int32

public virtual int supportedSizeCount()

返回

类型	描述
Int32

supportedSize

获取当前设备支持的所有图像大小的第 index 个. 如果 index 超出范围则返回{0, 0}。在成功的open之后调用。

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

easyar_Vec2I easyar_CameraDevice_supportedSize(const easyar_CameraDevice * 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)

参数

名称	类型	描述
index	Int32

返回

类型	描述
Vec2I

setSize

设置当前图像大小。最接近设置值的可选值将被使用。可以使用size来获取实际的大小。在成功的open之后调用。设置size后frameRateRange可能会发生变化。

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

bool easyar_CameraDevice_setSize(easyar_CameraDevice * 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)

参数

名称	类型	描述
size	Vec2I

返回

类型	描述
Boolean

supportedFrameRateRangeCount

获取当前设备支持的所有帧率范围的个数。在成功的open之后调用。

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

int easyar_CameraDevice_supportedFrameRateRangeCount(const easyar_CameraDevice * This)

int supportedFrameRateRangeCount()

public int supportedFrameRateRangeCount()

fun supportedFrameRateRangeCount(): Int

- (int)supportedFrameRateRangeCount

public func supportedFrameRateRangeCount() -> Int32

public virtual int supportedFrameRateRangeCount()

返回

类型	描述
Int32

supportedFrameRateRangeLower

获取当前设备支持的所有帧率范围的第 index 个的下界。在成功的open之后调用。

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

float easyar_CameraDevice_supportedFrameRateRangeLower(const easyar_CameraDevice * This, int index)

float supportedFrameRateRangeLower(int index)

public float supportedFrameRateRangeLower(int index)

fun supportedFrameRateRangeLower(index: Int): Float

- (float)supportedFrameRateRangeLower:(int)index

public func supportedFrameRateRangeLower(_ index: Int32) -> Float

public virtual float supportedFrameRateRangeLower(int index)

参数

名称	类型	描述
index	Int32

返回

类型	描述
Single

supportedFrameRateRangeUpper

获取当前设备支持的所有帧率范围的第 index 个的上界。在成功的open之后调用。

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

float easyar_CameraDevice_supportedFrameRateRangeUpper(const easyar_CameraDevice * This, int index)

float supportedFrameRateRangeUpper(int index)

public float supportedFrameRateRangeUpper(int index)

fun supportedFrameRateRangeUpper(index: Int): Float

- (float)supportedFrameRateRangeUpper:(int)index

public func supportedFrameRateRangeUpper(_ index: Int32) -> Float

public virtual float supportedFrameRateRangeUpper(int index)

参数

名称	类型	描述
index	Int32

返回

类型	描述
Single

frameRateRange

获取当前设备的当前帧率范围的索引。在成功的open之后调用。在iOS/macOS上，可能会返回-1，表示不固定帧率，可以使用supportedFrameRateRangeLower和supportedFrameRateRangeUpper获得最小值和最大值。

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

int easyar_CameraDevice_frameRateRange(const easyar_CameraDevice * This)

int frameRateRange()

public int frameRateRange()

fun frameRateRange(): Int

- (int)frameRateRange

public func frameRateRange() -> Int32

public virtual int frameRateRange()

返回

类型	描述
Int32

setFrameRateRange

设置当前设备的当前帧率范围的索引。在成功的open之后调用。

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

bool easyar_CameraDevice_setFrameRateRange(easyar_CameraDevice * This, int index)

bool setFrameRateRange(int index)

public boolean setFrameRateRange(int index)

fun setFrameRateRange(index: Int): Boolean

- (bool)setFrameRateRange:(int)index

public func setFrameRateRange(_ index: Int32) -> Bool

public virtual bool setFrameRateRange(int index)

参数

名称	类型	描述
index	Int32

返回

类型	描述
Boolean

setFlashTorchMode

设置flash torch模式为on。在成功的open之后调用。

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

bool easyar_CameraDevice_setFlashTorchMode(easyar_CameraDevice * This, bool on)

bool setFlashTorchMode(bool on)

public boolean setFlashTorchMode(boolean on)

fun setFlashTorchMode(on: Boolean): Boolean

- (bool)setFlashTorchMode:(bool)on

public func setFlashTorchMode(_ on: Bool) -> Bool

public virtual bool setFlashTorchMode(bool on)

参数

名称	类型	描述
on	Boolean

返回

类型	描述
Boolean

setFocusMode

设置对焦模式为focusMode。在成功的open之后调用。

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

bool easyar_CameraDevice_setFocusMode(easyar_CameraDevice * This, easyar_CameraDeviceFocusMode focusMode)

bool setFocusMode(CameraDeviceFocusMode focusMode)

public boolean setFocusMode(int focusMode)

fun setFocusMode(focusMode: Int): Boolean

- (bool)setFocusMode:(easyar_CameraDeviceFocusMode)focusMode

public func setFocusMode(_ focusMode: CameraDeviceFocusMode) -> Bool

public virtual bool setFocusMode(CameraDeviceFocusMode focusMode)

参数

名称	类型	描述
focusMode	CameraDeviceFocusMode

返回

类型	描述
Boolean

autoFocus

调用一次自动对焦。在start之后使用。仅在FocusMode为Normal或Macro时才能使用。

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

bool easyar_CameraDevice_autoFocus(easyar_CameraDevice * This)

bool autoFocus()

public boolean autoFocus()

fun autoFocus(): Boolean

- (bool)autoFocus

public func autoFocus() -> Bool

public virtual bool autoFocus()

返回

类型	描述
Boolean