凯视佳产品文档 产品文档与技术支持

CB_Device SDK · 设备枚举与连接

版本 1.0 · 更新于 2026-10-21 · 阅读 0

SDK 初始化、设备枚举、打开/关闭设备与设备信息获取。

CB_Initial

CB_RESULT CB_Initial()

初始化SDK库。

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 这个函数必须在无特殊说明的函数之前调用一次。

CB_Uninitial

CB_RESULT CB_Uninitial()

反初始化SDK库。

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 这个函数必须与CB_Initial相对应，否则会出现资源泄露。

CB_EnumerateDevices

CB_RESULT CB_EnumerateDevices(int32_t* piDevNum, char *szDeviceUserDefinedName)

枚举设备，获取连接设备数目。

参数 方向 说明
piDevNum out 返回连接的设备数目
szDeviceUserDefinedName in 指定用户自定义的名称

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 这个函数与CB_EnumerateDevices的区别是只会枚举特定的用户自定义名称的设备。

CB_GetDeviceInfo

CB_RESULT CB_GetDeviceInfo(int32_t iDevIndex, CB_TDeviceInfo *ptDevInfo)

通过设备索引，获取设备信息。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
ptDevInfo out 用于接收设备信息

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • @note 这个函数在设备打开之前可以调用。

CB_OpenDevice

CB_RESULT CB_OpenDevice(int32_t iDevIndex)

打开设备。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 当操作一个设备之前，必须通过这个函数打开设备。

CB_CloseDevice

CB_RESULT CB_CloseDevice(int32_t iDevIndex)

关闭设备。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_IsDeviceOpen

CB_RESULT CB_IsDeviceOpen(int32_t iDevIndex, _Bool *pbOpen)

设备是否已经打开。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
pbOpen out 返回是否设备已经打开

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）