Java API参考

namespace com::orbbec::obsensor
AccelFrame : public com.orbbec.obsensor.Frame

加速度流数据帧

Public Functions

inline float[] getAccelData ()

获取加速度帧数据

返回

float[3]{x,y,z} 返回加速度帧数据

inline float getTemperature()

获取帧采样时的温度

返回

帧采样时的温度

enum AccelFullScaleRange

加速度计量程枚举

Public Functions

inline AccelFullScaleRange(int value)
inline int value()

获取加速度计量程对应的索引

返回

索引值

Public Members

FS_2g   =(1)

1倍重力加速度

FS_4g   =(2)

4倍重力加速度

FS_8g   =(3)

8倍重力加速度

FS_16g   =(4)

16倍重力加速度

Public Static Functions

static inline AccelFullScaleRange get(int value)

获取指定索引对应的量程枚举值

参数

value – 索引值

返回

加速度计量程枚举值

Private Members

final int mValue
AccelStreamProfile : public com.orbbec.obsensor.StreamProfile

加速度计Profile

Public Functions

inline AccelFullScaleRange getAccelFullScaleRange()

获取加速度计配置的量程范围

返回

加速度计量程范围 AccelFullScaleRange

inline SampleRate getAccelSampleRate()

获取加速度计流配置的采样频率

返回

加速度计采样频率 SampleRate

enum AlignMode

D2C状态

Public Functions

inline AlignMode(int value)
inline int value()

获取数据流格式对应的索引

返回

索引值

Public Members

ALIGN_D2C_DISABLE   =(0)

关闭D2C

ALIGN_D2C_HW_ENABLE   =(1)

使能硬件D2C

ALIGN_D2C_SW_ENABLE   =(2)

使能软件D2C

Public Static Functions

static inline AlignMode get(int value)

获取指定索引对应的数据流格式

参数

value – 索引值

返回

数据流格式

Private Members

final int mValue
class CameraParam

相机参数

Public Functions

inline CameraIntrinsic getDepthIntrinsic()

获取深度相机内参

返回

返回深度相机内参 CameraIntrinsic

inline CameraIntrinsic getColorIntrinsic()

获取彩色相机内参

返回

返回彩色相机内参 CameraIntrinsic

inline CameraDistortion getDepthDistortion()

获取深度相机去畸变参数

返回

返回深度相机去畸变参数 CameraDistortion

inline CameraDistortion getColorDistortion()

获取彩色相机去畸变参数

返回

返回彩色相机去畸变参数 CameraDistortion

inline D2CTransform getD2CTransform()

获取旋转/变换矩阵

返回

旋转/变换矩阵 D2CTransform

inline boolean isMirrored()

本组参数对应的图像帧是否被镜像

返回

本组参数对应的图像帧是否被镜像

CameraParamList : public com.orbbec.obsensor.LobClass

相机参数列表

Public Functions

inline int getCameraParamCount()

获取相机参数数量

返回

相机参数数量

inline CameraParam getCameraParam(int index)

根据相机参数列表中指定索引，获取相机参数

参数

index – 索引值

返回

相机参数 CameraParam

inline void close()

资源释放

ColorFrame : public com.orbbec.obsensor.VideoFrame

彩色流数据帧

Config : public com.orbbec.obsensor.LobClass

用于配置Pipeline数据流状态

Public Functions

inline Config()

创建新的pipeline配置,用于配置需要通过Pipeline开启的数据流及数据流的分辨率及帧率

inline void enableStream(StreamProfile streamProfile)

开启指定配置的数据流

See

Pipeline::getStreamProfileList(SensorType)

参数

streamProfile – 数据流配置StreamProfile

inline void disableStream(StreamType streamType)

关闭指定配置的数据流,通过该接口可配置需要关闭哪一路数据流

参数

streamType – 数据流配置StreamType

inline void setAlignMode(AlignMode mode)

设置对齐模式

参数

mode – 对齐模式AlignMode

inline void close()

释放Config对象资源

class DataType

数据类型基类，用于表示Native结构体映射到Java的类型

Subclassed by com.orbbec.obsensor.datatype.CameraDistortion, com.orbbec.obsensor.datatype.CameraIntrinsic, com.orbbec.obsensor.datatype.D2CTransform, com.orbbec.obsensor.datatype.DeviceTemperature, com.orbbec.obsensor.datatype.ExposureThresholdControl, com.orbbec.obsensor.datatype.MultiDeviceSyncConfig, com.orbbec.obsensor.datatype.OBRect

Public Functions

abstract int BYTES ()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

inline boolean checkInitialized()

检查对应的Java类是否初始化成功

返回

Java类是否初始化，false：失败，true：成功

class DataUtilities

数据处理工具类

Public Static Functions

static inline byte[] subBytes (byte[] bytes, int offset, int length)

截取byte数组

参数

  • bytes – 待截取的数组

  • offset – 截取的开始位置

  • length – 截取的长度

返回

返回截取后的数组

static inline void appendBytes (byte[] src, byte[] dst, int offset, int length)

byte数组拼接

参数

  • src – 待拼接数组

  • dst – 拼接后的数组

  • offset – 拼接的开始位置

  • length – 拼接的长度

static inline byte[] shortToBytes (short s)

short数据转换为byte数组

参数

s – 待转换数据

返回

转换后的byte数组

static inline byte[] shortsToBytes (short[] ss)

short数组转换为byte数组

参数

ss – 待转换的short数组

返回

转换后的byte数组

static inline short bytesToShort (byte[] bytes)

byte数组转换为short数据

参数

bytes – 待转换的byte数组

返回

转换后的short数据

static inline short[] bytesToShorts (byte[] bytes, int count)

byte数组转换为short数组

参数

  • bytes – 待转换的byte数组

  • count – short数组的长度

返回

转换后的short数组

static inline byte[] intToBytes (int i)

int类型数据转换为byte数组

参数

i – 待转换的int数据

返回

转换后的byte数组

static inline byte[] intsToBytes (int[] is)

int数组转换为byte数组

参数

is – 待转换的int数组

返回

转换后的byte数组

static inline int bytesToInt (byte[] bytes)

byte数组转换为int数据

参数

bytes – 待转换的byte数组

返回

转换后的int类型数据

static inline int[] bytesToInts (byte[] bytes, int count)

byte数组转换为int数组

参数

  • bytes – 待转换的byte数组

  • count – 转换后的int数组的长度

返回

转换后的int数组

static inline byte[] floatToBytes (float f)

float数据类型转换为byte数组

参数

f – 待转换的float数据类型

返回

转换后的byte数组

static inline byte[] floatsToBytes (float[] fs)

float数组转换为byte数组

参数

fs – 待转换的float数组

返回

转换后的byte数组

static inline float bytesToFloat (byte[] bytes)

byte数组转换为float数据类型

参数

bytes – 待转换的byte数组

返回

转换后的float数据类型

static inline float[] bytesToFloats (byte[] bytes, int count)

byte数组转换为float数组

参数

  • bytes – 待转换的byte数组

  • count – 转换后的float数组的长度

返回

转换后的float数组

static inline byte[] stringToBytes (String s)

String转换为byte数组

参数

s – 待转换的字符串

返回

转换后的byte数组

static inline String bytesToString (byte[] bytes)

byte数组转换为String字符串

参数

bytes – 待转换的byte数组

返回

转换后的字符串

static inline String floatsToString (float[] floats)

float数组转换为字符串

参数

floats – 待转换的float数组

返回

转换后的字符串

static inline String intsToString (int[] ints)

int数组转换为字符串

参数

ints – 待转换的int数组

返回

转换后的字符串

DepthFrame : public com.orbbec.obsensor.VideoFrame

深度流数据帧

Public Functions

inline float getValueScale()

获取深度帧的值刻度，单位为 mm/step， 如valueScale=0.1, 某坐标像素值为pixelValue=10000， 则表示深度值value = pixelValue*valueScale = 10000*0.1=1000mm。

返回

深度帧的值刻度

enum DepthPrecisionLevel

深度精度等级

深度精度等级并不完全决定深度的单位和真实精度，需要考虑数据打包格式的影响， 具体单位可通过DepthFrame的getValueScale()获取

See

DepthFrame::getValueScale()

Public Functions

inline DepthPrecisionLevel(int value)
inline int value()

获取深度精度等级对应的索引

返回

索引值

Public Members

OB_PRECISION_1MM   =(0)

1mm

OB_PRECISION_0MM25   =(1)

0.5mm

OB_PRECISION_0MM5   =(2)

0.25mm

OB_PRECISION_0MM1   =(3)

0.1mm

OB_PRECISION_COUNT   =(4)

Public Static Functions

static inline DepthPrecisionLevel get(int value)

获取指定索引对应的深度精度等级

参数

value – 索引值

返回

深度精度等级

Private Members

final int mValue
Device : public com.orbbec.obsensor.LobClass

公开orbbec设备功能

Public Functions

inline List<Sensor> querySensors()

查询设备包含的传感器列表

返回

传感器列表

inline List<DevicePropertyInfo> getSupportedPropertyList()

获取设备支持的属性信息列表

返回

设备支持的属性信息列表 List<DevicePropertyInfo>

inline boolean isPropertySupported(DeviceProperty property, PermissionType permissionType)

查询设备是否支持设置指定的设备属性

参数
返回

true 支持, false 不支持

inline void setPropertyValueB(DeviceProperty property, boolean value)

设置boolean类型设备属性的值

参数

  • property – 设备属性 DeviceProperty

  • value – 设置设备属性的值，boolean类型

inline void setPropertyValueI(DeviceProperty property, int value)

设置int类型设备属性的值

参数

  • property – 设备属性 DeviceProperty

  • value – 设置设备属性的值，int类型

inline void setPropertyValueF(DeviceProperty property, float value)

设置float类型设备属性的值

参数

  • property – 设备属性 DeviceProperty

  • value – 设置设备属性的值，float类型

inline void setPropertyValueDataType(DeviceProperty property, DataType dataType)

设置对应的设备属性的数据结构

参数
抛出

OBException – 当待设置的数据结构封装出错时

inline boolean getPropertyValueB(DeviceProperty property)

获取boolean类型设备属性的值

参数

property – 设备属性 DeviceProperty

返回

设备属性的值，boolean类型

inline int getPropertyValueI(DeviceProperty property)

获取int类型设备属性的值

参数

property – 设备属性 DeviceProperty

返回

设备属性的值，int类型

inline float getPropertyValueF(DeviceProperty property)

获取float类型设备属性的值

参数

property – 设备属性 DeviceProperty

返回

设备属性的值，float类型

inline void getPropertyValueDataType(DeviceProperty property, DataType dataType)

获取对应的设备属性的数据结构

参数
抛出

OBException – 当获取到的数据结构解析出错时

inline int getMinRangeI(DeviceProperty property)

获取int类型设备属性支持的最小值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的最小值，int类型

inline float getMinRangeF(DeviceProperty property)

获取float类型设备属性支持的最小值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的最小值，float类型

inline int getMaxRangeI(DeviceProperty property)

获取int类型设备属性支持的最大值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的最大值，int类型

inline float getMaxRangeF(DeviceProperty property)

获取float类型设备属性支持的最大值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的最大值，float类型

inline int getStepI(DeviceProperty property)

获取int类型设备属性在支持的范围内变化的步值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的范围内变化的步值，int类型

inline float getStepF(DeviceProperty property)

获取float类型设备属性在支持的范围内变化的步值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的范围内变化的步值，float类型

inline boolean getDefaultB(DeviceProperty property)

获取boolean类型设备属性的默认值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的默认值，boolean类型

inline int getDefaultI(DeviceProperty property)

获取int类型设备属性的默认值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的默认值，int类型

inline float getDefaultF(DeviceProperty property)

获取float类型设备属性的默认值

参数

property – 设备属性 DeviceProperty

返回

设备属性支持的默认值，float类型

inline DeviceInfo getInfo()

获取设备信息

返回

设备信息 DeviceInfo

inline Sensor getSensor(SensorType type)

获取指定类型的传感器

参数

type – 传感器类型 SensorType

返回

传感器 Sensor

inline void upgrade(String fileName, UpgradeCallback callback)

升级设备固件

参数

  • fileName – 固件路径

  • callback – 升级过程回调 UpgradeCallback

抛出

OBException – 固件路径异常

inline void sendFileToDestination(String filePath, String dstPath, FileSendCallback callback)

传输文件到指定路径

参数

  • filePath – 源文件路径

  • dstPath – 目标路径

  • callback – 文件传输回调 FileSendCallback

抛出

OBException – 源文件路径异常

inline DeviceTemperature getDeviceTemperature()

获取设备温度信息

返回

温度信息 DeviceTemperature

inline boolean activateAuthorization(String authCode)

使用授权码激活设备

参数

authCode – 授权码

返回

激活是否成功，激活成功：true，激活失败：false

inline void setStateChangeListener(OnStateChangeListener listener)

设置设备状态监听

参数

listener – 设备状态发生改变时的回调 OnStateChangeListener

inline void setMultiDeviceSyncConfig(MultiDeviceSyncConfig config)

设置多设备同步配置

参数

config – 多设备同步配置 MultiDeviceSyncConfig

inline MultiDeviceSyncConfig getMultiDeviceSyncConfig()

获取多设备同步配置

返回

返回多设备同步配置 MultiDeviceSyncConfig

inline long syncDeviceTime()

同步设备时间（向设备授时，同步本地系统时间到设备）

返回

命令往返时间延时（round trip time， rtt）

inline CameraParamList getCalibrationCameraParamList()

获取标定的相机参数列表

返回

相机参数列表 CameraParamList

inline void reboot()

设备重启,设备重启后需要将原来的设备资源进行释放,待设备重新连接后可重新获取

inline void close()

释放设备资源

interface OnStateChangeListener

设备状态监听

Public Functions

void onStateChange(DeviceStateType stateType, String msg)

设备状态发生改变时的回调

参数

  • stateType – 状态类型

  • msg – 状态信息

interface DeviceChangedCallback

用于注册监听设备状态的回调接口

Public Functions

void onDeviceAttach(DeviceList deviceList)

设备添加通知及列表

参数

deviceList – 新增设备列表 DeviceList

void onDeviceDetach(DeviceList deviceList)

设备移除通知及列表

参数

deviceList – 移除设备列表 DeviceList

DeviceInfo : public com.orbbec.obsensor.LobClass

设备信息

Public Functions

inline String getName()

获取设备产品名

返回

设备产品名

inline int getPid()

获取设备产品标识号

返回

产品标识号

inline int getVid()

获取设备所属公司标识号

返回

公司标识号

inline String getUid()

获取设备唯一标识

返回

设备唯一标识

inline String getSerialNumber()

获取设备序列号

返回

设备序列号

inline String getUsbType()

获取设备连接的USB类型

返回

设备连接的USB类型

inline String getFirmwareVersion()

获取固件版本号

返回

返回固件版本号

inline String getHardwareVersion()

获取硬件的版本号

返回

返回硬件的版本号

inline String getSupportedMinSdkVersion()

获取设备支持的SDK最小版本号

返回

返回设备支持的SDK最小版本号

inline String getAsicName()

获取芯片类型名称

返回

返回芯片类型名称

inline DeviceType getDeviceType()

获取设备类型

返回

返回设备类型 DeviceType

inline void close()

资源释放

DeviceList : public com.orbbec.obsensor.LobClass

设备列表

Public Functions

inline int getDeviceCount()

获取设备数量

返回

设备数量

inline String getName(int index)

根据设备列表中指定索引，获取设备产品名

参数

index – 索引值

返回

产品名

inline int getPid(int index)

根据设备列表中指定索引，获取设备产品标识号

参数

index – 索引值

返回

产品标识号

inline int getVid(int index)

根据设备列表中指定索引，获取设备所属公司标识号

参数

index – 索引值

返回

公司标识号

inline String getUid(int index)

根据设备列表中指定索引，获取设备唯一标识

参数

index – 索引值

返回

设备唯一标识

inline String getDeviceSerialNumber(int index)

根据设备列表中指定索引，获取设备序列号

参数

index – 索引值

返回

设备序列号

inline Device getDevice(int index)

根据设备列表中指定索引，获取设备对象

参数

index – 索引值

返回

指定设备

inline Device getDeviceBySerialNumber(String serialNum)

创建设备,如果设备有在其他地方被获取创建,重复获取将会返回错误

参数

serialNum – 要创建设备的序列号

返回

返回创建的设备 Device

inline Device getDeviceByUid(String uid)

创建设备,如果设备有在其他地方被获取创建，重复获取将会返回错误

参数

uid – 要创建设备的uid

返回

返回创建的设备 Device

inline void close()

资源释放

interface DeviceListener

SDK设备监听接口

Public Functions

void onDeviceAttach()

设备添加通知

void onDeviceDetach()

设备移除通知

enum DeviceProperty

设备属性

Public Functions

inline DeviceProperty(int value)
inline int value()

获取设备属性对应的索引

返回

索引值

Public Members

OB_PROP_LDP_BOOL   =(2)

LDP开关

OB_PROP_LASER_BOOL   =(3)

激光开光

OB_PROP_LASER_CURRENT_FLOAT   =(5)

激光电流

OB_PROP_FLOOD_BOOL   =(6)

泛光灯开关

OB_PROP_DEPTH_MIRROR_BOOL   =(14)

深度镜像

OB_PROP_DEPTH_FLIP_BOOL   =(15)

深度翻转

OB_PROP_DEPTH_POSTFILTER_BOOL   =(16)

深度Post filter

OB_PROP_DEPTH_HOLEFILTER_BOOL   =(17)

深度Hole filter

OB_PROP_IR_MIRROR_BOOL   =(18)

IR 镜像

OB_PROP_IR_FLIP_BOOL   =(19)

IR 翻转

OB_PROP_MIN_DEPTH_INT   =(22)

最小深度阈值

OB_PROP_MAX_DEPTH_INT   =(23)

最大深度阈值

OB_PROP_DEPTH_SOFT_FILTER_BOOL   =(24)

软件滤波开关

OB_PROP_LDP_STATUS_BOOL   =(32)

LDP状态

OB_PROP_DEPTH_MAX_DIFF_INT   =(40)

软件滤波的maxdiff参数

OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT   =(41)

软件滤波的maxSpeckleSize

OB_PROP_TIMESTAMP_OFFSET_INT   =(43)

时间戳调校

OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL   =(61)

硬件去畸变开关 Rectify

OB_PROP_FAN_WORK_MODE_INT   =(62)

风扇开关模式

OB_PROP_DEPTH_PRECISION_LEVEL_INT   =(75)

深度精度等级，可能会改变深度帧数据单位，需要通过DepthFrame的ValueScale接口确认 设置参数参考DepthPrecisionLevel#value() 获取的值可通过DepthPrecisionLevel#get(int)进行转换

OB_PROP_TOF_FILTER_RANGE_INT   =(76)

tof滤波场景范围配置

OB_PROP_LASER_MODE_INT   =(79)

mx6600 激光点亮模式，固件端目前只返回 1: IR Drive, 2: Torch

OB_PROP_RECTIFY2_BOOL   =(80)

mx6600 brt2r-rectify功能开关(brt2r是mx6600上的一个特殊模块)，false: Disable, true: Rectify Enable

OB_PROP_COLOR_MIRROR_BOOL   =(81)

彩色镜像

OB_PROP_COLOR_FLIP_BOOL   =(82)

彩色翻转

OB_PROP_INDICATOR_LIGHT_BOOL   =(83)

指示灯开关 false: Disable， true: Enable

OB_PROP_DISPARITY_TO_DEPTH_BOOL   =(85)

硬件视差转深度开关， 0：关闭硬件视差转深度开关，打开软件视差转深度开关 1. 打开硬件视差转深度开关，关闭软件视差转深度开关

OB_PROP_BRT_BOOL   =(86)

BRT功能开关(抗背景干扰)，false: Disable， true: Enable

OB_PROP_WATCHDOG_BOOL   =(87)

看门狗功能开关，false: Disable， true: Enable

OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL   =(88)

外部信号触发重启功能开关，false: Disable， true: Enable

OB_PROP_HEARTBEAT_BOOL   =(89)

心跳监测功能开关，false: Disable， true: Enable

OB_PROP_DEPTH_CROPPING_MODE_INT   =(90)

深度裁剪模式设备: OB_DEPTH_CROPPING_MODE_EM （当前仅适配龙泉剑）

OB_PROP_D2C_PREPROCESS_BOOL   =(91)

D2C前处理开关（如RGB裁剪），false：关，true：开

OB_PROP_RGB_CUSTOM_CROP_BOOL   =(94)

自定义RGB裁剪开关，0为关闭，1为开启自定义裁剪，下发ROI裁剪区域

OB_PROP_DEVICE_WORK_MODE_INT   =(95)

设备工作模式（功耗）

OB_STRUCT_DEVICE_TEMPERATURE   =(1003)

设备温度

OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL   =(1024)

TOF曝光阈值范围

OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG   =(1038)

多设备同步模式和参数配置

OB_PROP_COLOR_AUTO_EXPOSURE_BOOL   =(2000)

彩色相机自动曝光

OB_PROP_COLOR_EXPOSURE_INT   =(2001)

彩色相机曝光调节

OB_PROP_COLOR_GAIN_INT   =(2002)

彩色相机增益调节

OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL   =(2003)

彩色相机自动白平衡

OB_PROP_COLOR_WHITE_BALANCE_INT   =(2004)

彩色相机白平衡调节

OB_PROP_COLOR_BRIGHTNESS_INT   =(2005)

彩色相机亮度调节

OB_PROP_COLOR_SHARPNESS_INT   =(2006)

彩色相机锐度调节

OB_PROP_COLOR_SATURATION_INT   =(2008)

彩色相机饱和度调节

OB_PROP_COLOR_CONTRAST_INT   =(2009)

彩色相机对比度调节

OB_PROP_COLOR_GAMMA_INT   =(2010)

彩色相机伽马值调节

OB_PROP_COLOR_ROLL_INT   =(2011)

彩色相机图像旋转

OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT   =(2012)

彩色相机自动曝光优先

OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT   =(2013)

彩色相机亮度补偿

OB_PROP_COLOR_HUE_INT   =(2014)

彩色相机彩色色调

OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT   =(2015)

彩色相机电力线路频率

OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL   =(2016)

深度相机自动曝光（某些型号设备下会同步设置红外相机）

OB_PROP_DEPTH_EXPOSURE_INT   =(2017)

深度相机曝光调节（某些型号设备下会同步设置红外相机）

OB_PROP_DEPTH_GAIN_INT   =(2018)

深度相机增益调节（某些型号设备下会同步设置红外相机）

OB_PROP_IR_AUTO_EXPOSURE_BOOL   =(2025)

红外相机自动曝光（某些型号设备下会同步设置深度相机）

OB_PROP_IR_EXPOSURE_INT   =(2026)

红外相机曝光调节（某些型号设备下会同步设置深度相机）

OB_PROP_IR_GAIN_INT   =(2027)

红外相机增益调节（某些型号设备下会同步设置深度相机）

OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL   =(3007)

SDK端Depth数据解包功能开关(每次开流都会默认打开，支持RLE/Y10/Y11/Y12/Y14格式)

Public Static Functions

static inline DeviceProperty get(int value)

获取指定索引对应的设备属性

参数

value – 索引值

返回

设备属性

Private Members

final int mValue
class DevicePropertyInfo

用于描述每一个属性的特性

Public Functions

inline DeviceProperty getProperty()

获取属性

返回

返回属性 DeviceProperty

inline String getPropertyName()

获取属性名称

返回

返回属性名称

inline PropertyType getPropertyType()

获取属性类型

返回

返回属性类型 PropertyType

inline PermissionType getPermissionType()

获取属性的权限类型

返回

返回属性的权限类型 PermissionType

enum DeviceStateType

设备状态类型

Public Members

NORMAL

设备正常，默认值

WARN

设备高温警告

FATAL

设备超温异常

enum DeviceType

设备类型

Public Functions

inline DeviceType(int value)
inline int value()

设备类型对应的索引

返回

索引值

Public Members

OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA   =(0)

单目结构光相机

OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA   =(1)

双目结构光相机

OB_TOF_CAMERA   =(2)

TOF相机

Public Static Functions

static inline DeviceType get(int value)

获取指定索引对应的设备类型

参数

value – 索引值

返回

设备类型

Private Members

final int mValue
interface FileSendCallback

文件传输回调类

Public Functions

void onCallback(short state, short percent, String msg)

文件传输回调

参数

  • state – 当前状态

  • msg – 状态信息

  • percent – 当前状态进度，百分比0~100

Public Members

short FILE_TRAN_STAT_TRANSFER = 2

文件传输中

short FILE_TRAN_STAT_DONE = 1

文件传输成功

short FILE_TRAN_STAT_PREPARE = 0

准备中

short FILE_TRAN_ERR_DDR = -1

DDR访问失败

short FILE_TRAN_ERR_NOT_ENOUGH_SPACE = -2

目标空间不足错误

short FILE_TRAN_ERR_PATH_NOT_WRITABLE = -3

目标路径不可写

short FILE_TRAN_ERR_MD5_ERROR = -4

MD5校验错误

short FILE_TRAN_ERR_WRITE_FLASH_ERROR = -5

写Flash错误

short FILE_TRAN_ERR_TIMEOUT = -6

超时错误

Filter : public com.orbbec.obsensor.LobClass , public Cloneable

所有filter的基类

Subclassed by com.orbbec.obsensor.FormatConvertFilter, com.orbbec.obsensor.PointCloudFilter

Public Functions

inline Frame process(Frame frame)

处理数据帧得到格式转换后的数据帧

参数

frame – 待转换的数据帧

返回

格式转换后的Frame

inline void reset()

Filter重置,重置后可重新设置filter的格式,用于另外一中格式的处理

inline void setCallback(FilterCallback callback)

Filter 设置处理结果回调函数(异步回调接口)

参数

callback – filter回调

inline void pushFrame(Frame frame)

filter 压入frame_set到待处理缓存(异步回调接口)

参数

frame – 数据帧

inline void close()

释放数据帧资源

interface FilterCallback

filter回调

Public Functions

void onFrame(Frame frame)

数据帧回调

参数

frame – 数据帧

enum Format

描述像素格式的枚举值

Public Functions

inline Format(int value)
inline int value()

获取数据流格式对应的索引

返回

索引值

Public Members

YUYV   =(0)

YUYV格式

YUY2   =(1)

YUY2格式（实际格式与YUYV相同）

UYVY   =(2)

UYVY格式

NV12   =(3)

NV12格式

NV21   =(4)

NV21格式

MJPG   =(5)

MJPG编码格式

H264   =(6)

H.264编码格式

H265   =(7)

H.265编码格式

Y16   =(8)

Y16格式，单通道16bit深度

Y8   =(9)

Y8格式，单通道8bit深度

Y10   =(10)

Y10格式，单通道10bit深度（SDK默认会解包成Y16）

Y11   =(11)

Y11格式，单通道11bit深度（SDK默认会解包成Y16）

Y12   =(12)

Y12格式，单通道12bit深度（SDK默认会解包成Y16）

GRAY   =(13)

GRAY灰度（实际格式与YUYV相同）

HEVC   =(14)

HEVC编码格式（实际格式与H265相同）

I420   =(15)

I420格式

ACCEL   =(16)

加速度数据格式

GYRO   =(17)

陀螺仪数据格式

POINT   =(19)

纯x-y-z三维坐标点格式

RGB_POINT   =(20)

带RGB信息的x-y-z三维坐标点格式

RLE   =(21)

RLE压测格式（SDK默认会解包成Y16）

RGB888   =(22)

RGB888格式

BGR   =(23)

BGR格式（实际BRG888）

UNKNOWN   =(0xff)

未知格式

Public Static Functions

static inline Format get(int value)

获取指定索引对应的数据流格式

参数

value – 索引值

返回

数据流格式

Private Members

final int mValue
FormatConvertFilter : public com.orbbec.obsensor.Filter

FormatConvertFilter 用于数据流格式转换

Public Functions

inline FormatConvertFilter()

创建格式转换filter

inline void setFormatType(FormatConvertType type)

设置数据流转换格式

参数

type – 数据流转换格式

enum FormatConvertType

格式转换类型枚举

Public Functions

inline FormatConvertType(int value)
inline int value()

获取特定索引值对应的数据流转换格式

返回

索引值

Public Members

FORMAT_YUYV_TO_RGB888   =(0)

YUYV转RGB888

FORMAT_I420_TO_RGB888   =(1)

I420转RGB888

FORMAT_NV21_TO_RGB888   =(2)

NV21转RGB888

FORMAT_NV12_TO_RGB888   =(3)

NV12转RGB888

FORMAT_MJPEG_TO_I420   =(4)

MJPG转I420

FORMAT_RGB888_TO_BGR   =(5)

RGB888转BGR

FORMAT_MJPEG_TO_NV21   =(6)

MJPG转NV21

FORMAT_MJPEG_TO_RGB888   =(7)

MJPG转RGB888

Public Static Functions

static inline FormatConvertType get(int value)

获取指定索引对应的数据流转换格式

参数

value – 索引值

返回

数据流格式

Private Members

final int mValue
Frame : public com.orbbec.obsensor.LobClass , public Cloneable

数据流中的数据帧，是ColorFrame、DepthFrame、IRFrame、VideoFrame、FrameSet的基类

Subclassed by com.orbbec.obsensor.AccelFrame, com.orbbec.obsensor.FrameSet, com.orbbec.obsensor.GyroFrame, com.orbbec.obsensor.PointFrame, com.orbbec.obsensor.VideoFrame

Public Functions

inline long getSystemTimeStamp()

获取数据帧的系统时间戳，单位：ms

返回

系统时间戳

inline long getTimeStamp()

获取数据帧的设备时间戳，单位：ms

返回

设备时间戳

inline long getTimeStampUs()

获取数据帧的设备时间戳，单位：us

返回

设备时间戳

inline FrameType getStreamType()

获取数据帧所属的数据流类型

返回

数据流类型 FrameType

inline Format getFormat()

获取数据帧所属的数据流格式

返回

数据流格式 Format

inline long getFrameIndex()

获取数据帧在数据流的序号

返回

数据帧序号

inline int getDataSize()

获取数据帧的数据大小

返回

数据大小

inline void getData (byte[] data)

获取数据帧的数据

参数

data – 数据帧的数据

inline int getMetadataSize()

获取帧的元数据大小

返回

返回帧的元数据大小

inline void getMetadata (byte[] metadata)

获取帧的元数据

参数

metadata – 帧的元数据

inline void close()

释放数据帧资源

interface FrameCallback

数据帧回调接口

Public Functions

void onFrame(Frame frame)

数据帧回调

参数

frame – 数据帧

FrameSet : public com.orbbec.obsensor.Frame

数据帧集，包含0~N个数据帧

Public Functions

inline int getFrameCount()

获取数据帧集包含帧的数量

返回

帧的数量

inline DepthFrame getDepthFrame()

获取深度数据帧

返回

深度数据帧 DepthFrame

inline ColorFrame getColorFrame()

获取彩色数据帧

返回

彩色数据帧 ColorFrame

inline IRFrame getIrFrame()

获取红外数据帧

返回

红外数据帧 IRFrame

inline PointFrame getPointFrame()

从帧集合中获取点云数据

返回

返回点云帧 PointFrame

inline void close()

释放数据帧集资源

interface FrameSetCallback

数据帧集回调接口

Public Functions

void onFrameSet(FrameSet frameSet)

数据帧集回调

参数

frameSet – 数据帧集

enum FrameType

描述Frame类型枚举值

Public Functions

inline FrameType(int value)
inline int value()

获取数据帧类型对应的索引

返回

索引值

Public Members

VIDEO   =(0)

视频帧（红外、彩色、深度帧都属于视频帧）

IR   =(1)

红外帧

COLOR   =(2)

彩色帧

DEPTH   =(3)

深度帧

ACCEL   =(4)

加速度计数据帧

FRAME_SET   =(5)

帧集合（内部包含多种数据帧）

POINTS   =(6)

点云帧

GYRO   =(7)

陀螺仪数据帧

Public Static Functions

static inline FrameType get(int value)

获取指定索引对应的数据帧类型

参数

value – 索引值

返回

数据帧类型

Private Members

final int mValue
GyroFrame : public com.orbbec.obsensor.Frame

陀螺仪数据帧

Public Functions

inline float[] getGyroData ()

获取陀螺仪数据

返回

float[3]{x,y,z} 返回加速度数据

inline float getTemperature()

获取帧采样时的温度

返回

帧采样时的温度

enum GyroFullScaleRange

陀螺仪量程的枚举

Public Functions

inline GyroFullScaleRange(int value)
inline int value()

获取陀螺仪量程对应的索引

返回

索引值

Public Members

FS_16dps   =(1)

16度每秒

FS_31dps   =(2)

31度每秒

FS_62dps   =(3)

62度每秒

FS_125dps   =(4)

125度每秒

FS_245dps   =(5)

245度每秒

FS_250dps   =(6)

250度每秒

FS_500dps   =(7)

500度每秒

FS_1000dps   =(8)

1000度每秒

FS_2000dps   =(9)

2000度每秒

Public Static Functions

static inline GyroFullScaleRange get(int value)

获取陀螺仪指定索引对应的量程枚举值

参数

value – 索引值

返回

陀螺仪量程枚举

Private Members

final int mValue
GyroStreamProfile : public com.orbbec.obsensor.StreamProfile

陀螺仪Profile

Public Functions

inline GyroFullScaleRange getGyroFullScaleRange()

获取陀螺仪配置的量程范围

返回

陀螺仪量程范围 GyroFullScaleRange

inline SampleRate getGyroSampleRate()

获取陀螺仪配置的数据采样率

返回

陀螺仪数据采样率 SampleRate

IRFrame : public com.orbbec.obsensor.VideoFrame

IR流数据帧

class LobClass : public AutoCloseable

SDK基类，加载核心SDK库

Subclassed by com.orbbec.obsensor.CameraParamList, com.orbbec.obsensor.Config, com.orbbec.obsensor.Device, com.orbbec.obsensor.DeviceInfo, com.orbbec.obsensor.DeviceList, com.orbbec.obsensor.Filter, com.orbbec.obsensor.Frame, com.orbbec.obsensor.OBContext, com.orbbec.obsensor.Pipeline, com.orbbec.obsensor.Playback, com.orbbec.obsensor.Recorder, com.orbbec.obsensor.Sensor, com.orbbec.obsensor.StreamProfile, com.orbbec.obsensor.StreamProfileList

Public Functions

inline long getHandle()

获取当前类句柄

返回

句柄

enum LogSeverity

log等级, 等级越高Log过滤力度越大

Public Functions

inline LogSeverity(int value)
inline int value()

获取日志输出等级对应的索引

返回

索引值

Public Members

DEBUG   =(0)

调试

INFO   =(1)

信息

WARN   =(2)

警告

ERROR   =(3)

错误

FATAL   =(4)

致命错误

NONE   =(5)

无(关闭LOG)

Public Static Functions

static inline LogSeverity get(int value)

获取指定索引对应的日志输出等级

参数

value – 索引值

返回

日志输出等级

Private Members

final int mValue
enum MediaState

录制回放状态

Public Functions

inline MediaState(int value)
inline int value()

获取录制回放状态对应的索引

返回

索引值

Public Members

OB_MEDIA_BEGIN   =(0)

开始

OB_MEDIA_PAUSE   =(1)

暂停

OB_MEDIA_RESUME   =(2)

恢复

OB_MEDIA_END   =(3)

结束

Public Static Functions

static inline MediaState get(int value)

获取指定索引对应的录制回放状态

参数

value – 索引值

返回

录制回放状态

Private Members

final int mValue
interface MediaStateCallback

回放状态回调

Public Functions

void onState(MediaState state)

回放状态回调

参数

state – 回放状态

enum MediaType

回放数据类型

Public Functions

inline MediaType(int value)
inline int value()

获取数据流格式对应的索引

返回

索引值

Public Members

OB_MEDIA_COLOR_STREAM   =(1)

彩色流

OB_MEDIA_DEPTH_STREAM   =(2)

深度流

OB_MEDIA_IR_STREAM   =(4)

红外流

OB_MEDIA_GYRO_STREAM   =(8)

陀螺仪数据流

OB_MEDIA_ACCEL_STREAM   =(16)

加速度及数据流

OB_MEDIA_CAMERA_PARAM   =(32)

相机参数

OB_MEDIA_DEVICE_INFO   =(64)

设备信息

OB_MEDIA_STREAM_INFO   =(128)

流信息

OB_MEDIA_ALL  =(OB_MEDIA_COLOR_STREAM.value()| OB_MEDIA_DEPTH_STREAM.value()| OB_MEDIA_IR_STREAM.value()| OB_MEDIA_GYRO_STREAM.value()| OB_MEDIA_ACCEL_STREAM.value()| OB_MEDIA_CAMERA_PARAM.value()| OB_MEDIA_DEVICE_INFO.value()| OB_MEDIA_STREAM_INFO.value())

所有类型

Public Static Functions

static inline MediaType get(int value)

获取指定索引对应的数据流格式

参数

value – 索引值

返回

数据流格式

Private Members

final int mValue
OBContext : public com.orbbec.obsensor.LobClass

Orbbec Sensor SDK 上下文，可以进行设备监听、查询、日志管理、版本查询

Public Functions

inline OBContext(Context context, DeviceChangedCallback callback)

创建SDK上下文, 并申请授权，开启设备监听

参数

  • context – Android环境上下文，建议用Application的context

  • callback – 设备监听 DeviceChangedCallback

inline OBContext(Context context, String configPath, DeviceChangedCallback callback)

创建SDK上下文, 并申请授权，开启设备监听

参数

  • context – Android环境上下文，建议用Application的context

  • configPath – 配置文件路径

  • callback – 设备监听 DeviceChangedCallback

inline DeviceList queryDevices()

查询设备列表

返回

设备列表 DeviceList

inline synchronized void setDevicesChangedCallback (DeviceChangedCallback callback)

设置设备插拔监听回调

参数

callback – 设备插拔监听 DeviceChangedCallback

inline synchronized void removeDevicesChangedCallback ()

移除设备插拔监听回调

inline void enableMultiDeviceSync(long repeatInterval)

启动多设备同步功能，同步已创建设备的时钟(需要使用的设备支持该功能)

参数

repeatInterval – 定时同步时间间隔（单位ms；如果repeatInterval=0，表示只同步一次，不再定时执行）

inline void close()

SDK Context资源释放

Public Static Functions

static inline void setLoggerSeverity(LogSeverity severity)

设置全局日志的等级，会同时作用于输出到console和输出到文件的日志等级

参数

severity – 输出日志等级LogSeverity

static inline void setLoggerToConsole(LogSeverity severity)

设置日志参数，并输出到控制台

参数

severity – 日志输出等级 LogSeverity

static inline void setLoggerToFile(LogSeverity severity, String fileName)

设置日志参数，并输出到指定文件

参数

  • severity – 日志输出等级 LogSeverity

  • fileName – 文件路径

static inline String getVersionName()

获取SDK版本名称

返回

SDK版本名称

static inline int getVersionCode()

获取SDK版本号

返回

SDK版本号

static inline String getCoreVersionName()

获取SDK内核版本名称

返回

SDK内核版本号，major.minor.patch

static inline int getCoreVersionCode()

获取SDK内核版本号

返回

内核版本号

class OBException : public RuntimeException

Orbbec sdk抛出的异常

Public Functions

inline OBException()

创建Orbbec SDK异常

inline OBException(String message)

通过具体信息创建Orbbec SDK异常

参数

message – 详细信息

enum PermissionType

用于描述属性的访问权限的枚举

Public Functions

inline PermissionType(int value)
inline int value()

获取特定属性枚举对应的索引值

返回

索引值

Public Members

OB_PERMISSION_DENY   =(0)

无访问权限

OB_PERMISSION_READ   =(1)

可读

OB_PERMISSION_WRITE   =(2)

可写

OB_PERMISSION_READ_WRITE   =(3)

可读写

Public Static Functions

static inline PermissionType get(int value)

获取指定索引对应的属性值读写权限类型枚举

参数

value – 索引值

返回

属性枚举

Private Members

final int mValue
Pipeline : public com.orbbec.obsensor.LobClass

pipeline：用于控制数据，与Sensor类start方法冲突，不可以同时使用start方法开启数据流。可扩展附加操作，例如设置数据帧同步等高级接口

Public Functions

inline Pipeline(Device device)

使用指定设备，创建Pipeline,通过该接口创建Pipeline需要先创建对应的设备

See

DeviceList::getDevice(int)

inline Pipeline(String playbackFile)

使用回放文件来创建pipeline对象

参数

playbackFile – 用于创建pipeline的回放文件路径

inline void start(Config config)

开启指定配置的数据流，如果需要使用配置文件中的配置进行开流，则config传null （在config传null的情况下没有配置文件时则默认使用开流配置列表中的第一个进行开流）

注：如果pipeline是通过回放文件创建，则表示开始回放,此时config传null即可

参数

config – pipeline配置 Config

inline void start(Config config, FrameSetCallback callback)

开启指定配置的数据流，并设置数据帧集回调,如果需要使用配置文件中的配置进行开流，则config传null （在config传null的情况下没有配置文件时则默认使用开流配置列表中的第一个进行开流）

注：如果pipeline是通过回放文件创建，则表示以回调方式开始回放,此时config传null即可

重要：回调的数据帧在使用结束后，必须调用FrameSet#close()和Frame#close()释放资源。

参数
inline void stop()

关闭数据流

inline FrameSet waitForFrameSet(long timeoutMilliseconds)

查询方式获取数据帧集 重要：数据帧在使用结束后，必须调用FrameSet.close()和Frame.close()释放资源。

参数

timeoutMilliseconds – 等待超时时长

返回

数据帧集 FrameSet

inline Config getConfig()

获取当前pipeline配置，该配置通过start方法配置的

返回

pipeline配置 Config

inline void enableFrameSync()

开启帧同步

inline void disableFrameSync()

关闭帧同步

inline StreamProfileList getStreamProfileList(SensorType sensorType)

获取指定传感器类型支持的数据流配置

参数

sensorType – 传感器类型 SensorType

返回

数据流配置列表 StreamProfileList

inline void switchConfig(Config config)

动态切换对应的config配置

参数

config – pipeline的配置 Config

inline StreamProfileList getD2CDepthProfileList(StreamProfile colorProfile, AlignMode mode)

返回与输入的彩色传感器分辨率对应的支持D2C的深度传感器分辨率列表

参数
返回

匹配的深度的配置列表

inline OBRect getD2CValidArea(int distance)

获取D2C后有效的区域

参数

distance – 工作距离(mm)

返回

返回在工作距离下D2C后有效的区域信息 OBRect

inline CameraParam getCameraParam()

获取D2C后的相机参数，当pipeline通过回放文件创建时，则获取的是回放设备的相机内参

返回

返回对齐后的相机内参 CameraParam

inline void startRecord(String filePath)

开启录制

参数

filePath – 录制的文件路径

inline void stopRecord()

关闭录制

inline Playback getPlayback()

从pipeline中获取回放对象

返回

返回回放对象 Playback

inline void close()

Pipeline资源释放

Playback : public com.orbbec.obsensor.LobClass

数据回放器

Public Functions

inline Playback(String filePath)

创建回放器

参数

filePath – 回放文件路径

inline void start(PlaybackCallback callback, MediaType mediaType)

开启回放，回放数据从回调中返回

参数
inline void stop()

停止回放

inline DeviceInfo getDeviceInfo()

获取设备信息

返回

返回设备信息 DeviceInfo

inline CameraParam getCameraParam()

获取录制文件内的内外参信息

返回

返回的内外参信息 CameraParam

inline void setMediaStateCallback(MediaStateCallback callback)

设置回放状态回调

参数

callback – 回放状态回调

inline void close()

释放回放器资源

interface PlaybackCallback

数据帧回放回调接口

Public Functions

void onPlayback(Frame frame)

数据帧回放回调

参数

frame – 数据帧

PointCloudFilter : public com.orbbec.obsensor.Filter

PointCloudFilter 用于生成普通点云数据，RGB点云数据

Public Functions

inline PointCloudFilter()

创建点云filter

inline void setPointFormat(Format format)

设置生成点云的格式

参数

format – 点云格式 Format

inline void setCameraParam(CameraParam param)

PointCloud Filter设备相机参数

参数

param – 相机参数 CameraParam

inline void setD2CAlignStatus(boolean isAlign)

设置D2C对齐状态

参数

isAlign – D2C对齐状态，true: 对齐， false: 不对齐

PointFrame : public com.orbbec.obsensor.Frame

Public Functions

inline void getPointCloudData (float[] data)

返回点云帧数据

参数

data – 点云帧返回的数据

enum PropertyType

属性类型描述

Public Functions

inline PropertyType(int value)
inline int value()

获取特定属性枚举对应的索引值

返回

索引值

Public Members

BOOL_PROPERTY   =(0)

boolean类型数据的属性

INT_PROPERTY   =(1)

int类型数据的属性

FLOAT_PROPERTY   =(2)

float类型数据的属性

STRUCT_PROPERTY   =(3)

对应底层结构体类型数据的属性

Public Static Functions

static inline PropertyType get(int value)

获取指定索引对应的属性值类型枚举

参数

value – 索引值

返回

属性枚举

Private Members

final int mValue
Recorder : public com.orbbec.obsensor.LobClass

数据录制器

Public Functions

inline Recorder()

创建录制器

inline Recorder(Device device)

通过指定设备创建录制器

参数

device – 设备 Device

inline void start(String fileName, boolean async)

开始录制

参数

  • fileName – 录制的文件名称

  • async – 是否异步录制

inline void stop()

停止录制

inline void writeFrame(Frame frame)

向录制器内写入帧数据

参数

frame – 写入的帧数据 Frame

inline void close()

释放录制器资源

enum SampleRate

IMU采样率值的枚举(陀螺仪或加速度计)

Public Functions

inline SampleRate(int value)
inline int value()

获取加速度计或陀螺仪采样频率枚举值

返回

索引值

Public Members

ODR_1_5625_HZ   =(1)

1.5625Hz

ODR_3_125_HZ   =(2)

3.125Hz

ODR_6_25_HZ   =(3)

6.25Hz

ODR_12_5_HZ   =(4)

12.5Hz

ODR_25_HZ   =(5)

25Hz

ODR_50_HZ   =(6)

50Hz

ODR_100_HZ   =(7)

100Hz

ODR_200_HZ   =(8)

200Hz

ODR_500_HZ   =(9)

500Hz

ODR_1_KHZ   =(10)

1KHz

ODR_2_KHZ   =(11)

2KHz

ODR_4_KHZ   =(12)

4KHz

ODR_8_KHZ   =(13)

8KHz

ODR_16_KHZ   =(14)

16KHz

ODR_32_KHZ   =(15)

32Hz

Public Static Functions

static inline SampleRate get(int value)

获取加速度计或陀螺仪采样频率枚举

参数

value – 索引值

返回

加速度计或陀螺仪采样频率枚举

Private Members

final int mValue
Sensor : public com.orbbec.obsensor.LobClass

公开orbbec传感器功能

Public Functions

inline SensorType getType()

获取传感器类型

返回

传感器类型 SensorType

inline StreamProfileList getStreamProfileList()

获取传感器支持的数据流配置信息

返回

传感器支持的数据流配置信息列表 StreamProfileList

inline void start(StreamProfile profile, FrameCallback callback)

开启传感器数据流，不可与pipeline同时使用,如果使用配置文件中的配置开流，则profile传null （如果在传null时又没有配置文件的情况下则默认使用配置文件列表中的第一个配置）

重要：回调的数据帧在使用结束后，必须调用Frame.close()释放资源。

参数
inline void stop()

关闭传感器数据流

inline void switchProfile(StreamProfile profile)

动态切换分辨率

参数

profile – 需要切换的分辨率 StreamProfile

inline void close()

释放传感器资源

enum SensorType

描述传感器类型的枚举值

Public Functions

inline SensorType(int value)
inline int value()

获取传感器类型对应的索引

返回

索引值

Public Members

UNKNOWN   =(0)

未知类型传感器

IR   =(1)

红外

COLOR   =(2)

彩色

DEPTH   =(3)

深度

ACCEL   =(4)

加速度计

GYRO   =(5)

陀螺仪

Public Static Functions

static inline SensorType get(int value)

获取指定索引对应的传感器类型

参数

value – 索引值

返回

传感器类型

Private Members

final int mValue
StreamProfile : public com.orbbec.obsensor.LobClass

数据流配置基类

Subclassed by com.orbbec.obsensor.AccelStreamProfile, com.orbbec.obsensor.GyroStreamProfile, com.orbbec.obsensor.VideoStreamProfile

Public Functions

inline Format getFormat()

获取数据流格式

返回

数据流格式 Format

inline StreamType getType()

获取数据流类型

返回

数据流类型 StreamType

inline void close()

资源释放

StreamProfileList : public com.orbbec.obsensor.LobClass

流配置列表

Public Functions

inline int getStreamProfileCount()

获取流配置数量

返回

流配置数量

inline StreamProfile getStreamProfile(int index)

根据流配置列表中指定索引，获取配置

参数

index – 索引值

返回

流配置 StreamProfile

inline VideoStreamProfile getVideoStreamProfile(int width, int height, Format format, int fps)

通过传入的参数进行匹配对应的StreamProfile，若有多个匹配项默认返回列表中的第一个

参数

  • width – 宽度，如无需匹配宽度，则传0

  • height – 高度，如无需匹配高度，则传0

  • format – 类型 Format,如无需匹配类型，则传Format#UNKNOWN

  • fps – 帧率,如无需匹配帧率，则传0

返回

返回匹配的流配置

inline void close()

资源释放

enum StreamType

描述数据流类型的枚举值

Public Functions

inline StreamType(int value)
inline int value()

获取数据流类型对应的索引

返回

索引值

Public Members

VIDEO   =(0)

视频流(红外、彩色、深度流都属于视频流)

IR   =(1)

红外流

COLOR   =(2)

彩色流

DEPTH   =(3)

深度流

ACCEL   =(4)

加速度计数据流

GYRO   =(5)

陀螺仪数据流

Public Static Functions

static inline StreamType get(int value)

获取指定索引对应的数据流类型

参数

value – 索引值

返回

数据流类型

Private Members

final int mValue
enum SyncMode

同步模式

Public Functions

inline SyncMode(int value)
inline int value()

获取数据流格式对应的索引

返回

索引值

Public Members

OB_SYNC_STOP   =(0)

关闭同步

OB_SYNC_SINGLE_MODE   =(1)

single device模式

OB_SYNC_ONLINE_HOST_MODE   =(2)

single device模式，也是host模式，是ir作主的

OB_SYNC_ONLINE_SLAVE_MODE   =(3)

slave模式 (ext_in –> rgb、tof、ext_out)

OB_SYNC_ONLY_MCU_MODE   =(4)

mcu作host的模式

OB_SYNC_ONLY_IR_MODE   =(5)

IR作host的模式

Public Static Functions

static inline SyncMode get(int value)

获取指定索引对应的数据流格式

参数

value – 索引值

返回

数据流格式

Private Members

final int mValue
interface UpgradeCallback

固件升级回调类

Public Functions

void onCallback(short state, short percent, String msg)

固件升级回调

参数

  • state – 当前状态

  • msg – 状态信息

  • percent – 当前状态进度，百分比0~100

Public Members

short STAT_FILE_TRANSFER = 4

固件文件传输状态

short STAT_DONE = 3

固件升级完成

short STAT_IN_PROGRESS = 2

固件升级中

short STAT_START = 1

固件升级开始

short STAT_VERIFY_IMAGE = 0

固件文件校验

short ERR_VERIFY = -1

固件文件校验失败

short ERR_PROGRAM = -2

程序错误

short ERR_ERASE = -3

擦除失败

short ERR_FLASH_TYPE = -4

flash类型失败

short ERR_IMG_SIZE = -5

固件文件大小失败

short ERR_OTHER = -6

其他错误

short ERR_DDR = -7

DDR错误

short ERR_TIMEOUT = -8

升级超时

VideoFrame : public com.orbbec.obsensor.Frame

ColorFrame、DepthFrame、IRFrame的基类

Subclassed by com.orbbec.obsensor.ColorFrame, com.orbbec.obsensor.DepthFrame, com.orbbec.obsensor.IRFrame

Public Functions

inline int getWidth()

获取数据帧的宽

返回

数据帧的宽

inline int getHeight()

获取数据帧的高

返回

数据帧的高

inline int getPixelAvailableBitSize()

获取像素有效位数（如Y16格式帧，每个像素占16bit，但实际只有低10位是有效位，高6位填充0） 仅对Y8/Y10/Y11/Y12/Y14/Y16格式有效

返回

返回像素有效位数，如果是不支持的格式，返回0

VideoStreamProfile : public com.orbbec.obsensor.StreamProfile

数据流配置,用于Color, Depth, IR 流

Public Functions

inline int getWidth()

获取数据流宽

返回

数据流宽

inline int getHeight()

获取数据流高

返回

数据流高

inline int getFps()

获取数据流每秒帧率

返回

数据流帧率

inline void close()

资源释放

namespace datatype
CameraDistortion : public com.orbbec.obsensor.DataType

畸变参数

Public Functions

inline float getK1()

获取径向畸变系数1

返回

径向畸变系数1

inline float getK2()

获取径向畸变系数2

返回

径向畸变系数2

inline float getK3()

获取径向畸变系数3

返回

径向畸变系数3

inline float getK4()

获取径向畸变系数4

返回

径向畸变系数4

inline float getK5()

获取径向畸变系数5

返回

径向畸变系数5

inline float getK6()

获取径向畸变系数6

返回

径向畸变系数6

inline float getP1()

获取切向畸变系数1

返回

切向畸变系数1

inline float getP2()

获取切向畸变系数2

返回

切向畸变系数2

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

CameraIntrinsic : public com.orbbec.obsensor.DataType

相机内参

Public Functions

inline float getFx()

获取x方向焦距，单位：像素

返回

返回x方向焦距

inline float getFy()

获取y方向焦距，单位：像素

返回

返回y方向焦距

inline float getCx()

获取光心横坐标

返回

返回光心横坐标

inline float getCy()

获取光心纵坐标

返回

返回光心纵坐标

inline short getWidth()

获取图像宽度

返回

返回图像宽度

inline short getHeight()

获取图像高度

返回

返回图像高度

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

D2CTransform : public com.orbbec.obsensor.DataType

旋转/变换矩阵

Public Functions

inline float[] getRot ()

获取旋转矩阵，行优先

返回

旋转矩阵

inline float[] getTrans ()

获取变换矩阵

返回

变换矩阵

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

DeviceTemperature : public com.orbbec.obsensor.DataType

设备温度信息

Public Functions

inline float getCpuTemp()

获取CPU温度，单位：摄氏度

返回

CPU温度

inline float getIrTemp()

获取IR传感器温度，单位：摄氏度

返回

IR传感器温度

inline float getLdmTemp()

获取激光模组温度，单位：摄氏度

返回

激光模组温度

inline float getMainBoardTemp()

获取主板温度，单位：摄氏度

返回

主板温度

inline float getTecTemp()

获取TEC温度，单位：摄氏度

返回

TEC温度

inline float getImuTemp()

获取IMU传感器温度，单位：摄氏度

返回

IMU传感器温度

inline float getRgbTemp()

获取RGB传感器温度，单位：摄氏度

返回

RGB传感器温度

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

ExposureThresholdControl : public com.orbbec.obsensor.DataType

TOF曝光阈值

Public Functions

inline int getUpper()

获取阈值上限，单位：ms

返回

阈值上限

inline int getLower()

获取阈值下限，单位：ms

返回

阈值下限

inline void setUpper(int upper)

设置阈值上限，单位：ms

参数

upper – 阈值上限值

inline void setLower(int lower)

设置阈值下限，单位：ms

参数

lower – 阈值下限值

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

MultiDeviceSyncConfig : public com.orbbec.obsensor.DataType

Tof多设备同步配置

Public Functions

inline SyncMode getSyncMode()

获取同步模式

返回

同步模式 SyncMode

inline void setSyncMode(SyncMode mode)

设置同步模式

参数

mode – 同步模式 SyncMode

inline short getTofPhaseDelay()

获取TOF延迟曝光时间, 单位：us

返回

TOF延迟曝光时间

inline void setTofPhaseDelay(short delay)

设置TOF延迟曝光时间，单位：us

参数

delay – TOF延迟曝光时间

inline short getRgbPhaseDelay()

获取RGB延迟曝光时间，单位：us

返回

RGB延迟曝光时间

inline void setRgbPhaseDelay(short delay)

设置RGB延迟曝光时间，单位：us

参数

delay – RGB延迟曝光时间

inline short getOutPhaseDelay()

获取信号延迟输出时间，单位：us

返回

信号延迟输出时间

inline void setOutPhaseDelay(short delay)

设置信号延迟输出时间，单位：us

参数

delay – 信号延迟输出时间

inline short getOutOcPolarity()

获取脉冲类型

返回

返回脉冲类型，0:正向脉冲， 1:负向脉冲

inline void setOutOcPolarity(short polarity)

设置脉冲类型，0:正向脉冲， 1:负向脉冲

参数

polarity – 脉冲类型，0:正向脉冲， 1:负向脉冲

inline short getMcuHostFps()

获取mcu主模式时的触发帧率

返回

返回mcu主模式时的触发帧率

inline void setMcuHostFps(short fps)

设置mcu主模式时的触发帧率

参数

fps – mcu主模式时的触发帧率

inline short getCurDevId()

获取当前设备编号

返回

返回当前的设备编号

inline void setCurDevId(short id)

设置当前的设备编号

参数

id – 设备编号

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数

OBRect : public com.orbbec.obsensor.DataType

矩形描述

Public Functions

inline int getX()

获取矩形原点x坐标

返回

返回矩形原点x坐标

inline int getY()

获取矩形原点y坐标

返回

返回矩形原点y坐标

inline int getWidth()

获取矩形宽度

返回

返回矩形宽度

inline int getHeight()

获取矩形高度

返回

返回矩形高度

inline int BYTES()

获取Native结构体占用的字节数

返回

Native结构体占用的字节数