CameraDevice Class

这个类型是C#语言的 EasyAR Sense API: CameraDevice 。页面中部分描述可能与Unity环境无关。

这个类型已经部分封装进Unity组件: CameraDeviceFrameSource EditorCameraDeviceFrameSource 。在大部分情况下不需要直接使用这个类型的成员和实例。如果要使用一些没有被封装的接口,需要使用 CameraDeviceFrameSource.Device EditorCameraDeviceFrameSource.Device ,而非创建新的实例。

Description

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权限声明。


Methods

isAvailable

C#

public static bool isAvailable()

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

androidCameraApiType

C#

public virtual AndroidCameraApiType androidCameraApiType()

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

setAndroidCameraApiType

C#

public virtual void setAndroidCameraApiType( AndroidCameraApiType type)

在Android上,可用于设置使用的Camera API(Camera 1或Camera 2)。必须在调用openWithIndex、openWithSpecificType或openWithPreferredType之前进行设置,否则不会生效。

推荐使用 CameraDeviceSelector 以根据使用的主要算法来创建设好推荐Camera API的CameraDevice。

bufferCapacity

C#

public virtual int bufferCapacity()

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

setBufferCapacity

C#

public virtual void setBufferCapacity(int capacity)

设置 InputFrame 缓冲的容量。

inputFrameSource

C#

public virtual InputFrameSource inputFrameSource()

InputFrame 输出端口。

setStateChangedCallback

C#

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

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

requestPermissions

C#

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

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

cameraCount

C#

public static int cameraCount()

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

openWithIndex

C#

public virtual bool openWithIndex(int cameraIndex)

按照camera索引打开camera设备。

openWithSpecificType

C#

public virtual bool openWithSpecificType( CameraDeviceType type)

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

openWithPreferredType

C#

public virtual bool openWithPreferredType( CameraDeviceType type)

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

start

C#

public virtual bool start()

开始采集数据。

stop

C#

public virtual void stop()

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

close

C#

public virtual void close()

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

index

C#

public virtual int index()

cameras索引。

type

C#

public virtual CameraDeviceType type()

camera类型。

cameraParameters

C#

public virtual CameraParameters cameraParameters()

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

setCameraParameters

C#

public virtual void setCameraParameters( CameraParameters cameraParameters)

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

size

C#

public virtual Vec2I size()

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

supportedSizeCount

C#

public virtual int supportedSizeCount()

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

supportedSize

C#

public virtual Vec2I supportedSize(int index)

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

setSize

C#

public virtual bool setSize( Vec2I size)

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

supportedFrameRateRangeCount

C#

public virtual int supportedFrameRateRangeCount()

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

supportedFrameRateRangeLower

C#

public virtual float supportedFrameRateRangeLower(int index)

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

supportedFrameRateRangeUpper

C#

public virtual float supportedFrameRateRangeUpper(int index)

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

frameRateRange

C#

public virtual int frameRateRange()

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

setFrameRateRange

C#

public virtual bool setFrameRateRange(int index)

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

setFlashTorchMode

C#

public virtual bool setFlashTorchMode(bool on)

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

setFocusMode

C#

public virtual bool setFocusMode( CameraDeviceFocusMode focusMode)

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

autoFocus

C#

public virtual bool autoFocus()

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