Miinam API 手册

1. 版本和平台

• 版本:5.32226.20260808

• 平台
  • Win32:
    • x64: Win7及以上版本
    • x86: XP SP3及以上版本; CPU至少需要支持SSE2指令集
  • macOS:
    • x64; macOS 10.10及以上版本
  • Linux: 内核2.6.27及以上, GLIBC 2.17及以上
    • x64
    • x86: CPU至少需要支持SSE3指令集
    • arm64: 由aarch64-linux-gnu(版本5.4.0)编译
    • armhf: 由arm-linux-gnueabihf(版本5.4.0)编译
    • armel: 由arm-linux-gnueabi(版本5.4.0)编译

2. 函数

• 回调函数: PMIINAM_EVENT_CALLBACK, PMIINAM_PARA_CALLBACK, PMIINAM_DATA_CALLBACK, PMIINAM_CAPTURE_CALLBACK

  事件	描述	值
  MIINAM_EVENT_ENUM	相机数量发生变化	0x01
  MIINAM_EVENT_WIFI	WiFi发生变化	0x02
  MIINAM_EVENT_PARA	参数发生变化, 详见MIINAM_PARA_xxx详细参数说明	0x03
  MIINAM_EVENT_IMAGE	视频图像数据到达(视频)	0x04
  MIINAM_EVENT_THUMBNAIL	获取缩略图	0x08
  MIINAM_EVENT_DIRCHANG	目录更改事件	0x09
  MIINAM_EVENT_RECORDSTART	记录开始	0x0a
  MIINAM_EVENT_RECORDSTOP	记录停止	0x0b
  MIINAM_EVENT_ERROR	发生错误	0x80
  MIINAM_EVENT_EOF	录入文件结束	0x81

  
  

  参数	描述	值
  MIINAM_PARA_UNKNOWN	未知	0x00
  MIINAM_PARA_EXPOTIME	曝光时间	0x01
  MIINAM_PARA_AGAIN	模拟增益, 百分比, 如200表示增益200%	0x02
  MIINAM_PARA_AEXPOTARGET	自动曝光的目标	0x03
  MIINAM_PARA_TEMP	色温	0x04
  MIINAM_PARA_TINT	Tint	0x05
  MIINAM_PARA_CONTRAST	对比度	0x06
  MIINAM_PARA_HUE	色度	0x07
  MIINAM_PARA_SATURATION	饱和度	0x08
  MIINAM_PARA_BRIGHTNESS	亮度	0x09
  MIINAM_PARA_GAMMA	Gamma	0x0a
  MIINAM_PARA_AEXPO	自动曝光	0x0b
  MIINAM_PARA_AWB	自动白平衡 XCAM1080P:once XCAM4K:(0:manual;1:global auto;2:roi)	0x0c
  MIINAM_PARA_BINSKIP	bin/skip模式	0x0d
  MIINAM_PARA_HZ	光源的电力供应频率0表示60Hz交流, 1表示50Hz交流, 2表示直流	0x0e
  MIINAM_PARA_BPS	带宽kbps (bits per second)	0x0f
  MIINAM_PARA_KEYFRAME	关键帧间隔	0x10
  MIINAM_PARA_LOWLIGHTCOMPENSATION	低光补偿	0x11
  MIINAM_PARA_SHARPNESS	锐化	0x12
  MIINAM_PARA_WBREDGAIN	白平衡红增益	0x13
  MIINAM_PARA_WBGREENGAIN	白平衡绿增益	0x14
  MIINAM_PARA_WBBLUEGAIN	白平衡蓝增益	0x15
  MIINAM_PARA_DENOISE	降噪	0x16
  MIINAM_PARA_APSTA	ap或sta (无线网络工作模式)	0x17
  MIINAM_PARA_CODEC	编解码器, H264, H265等	0x18
  MIINAM_PARA_AFPOSITION	自动对焦传感器板位置(AFDM, EFL均适用)	0x19
  MIINAM_PARA_AFMODE	自动对焦模式, 0:手动对焦; 1:自动对焦; 2:单次对焦; 3:共轭校准	0x1a
  MIINAM_PARA_AFZONE	自动对焦区域整个分辨率被划分为w*h区域:w=imax>>16, h=imax&0xffff, 所以自动对焦的行 row=value / w, 自动对焦的列column=value % w (value位区域的序号)	0x1b
  MIINAM_PARA_AFFEEDBACK	自动对焦信息反馈 AFDM: 0: 未知 1: 已对焦 2: 对焦中 3: 失焦 4: 上升（工作台上移） 5: 下降（工作台下移） EFL: 0: 不可用 1: 对焦完成，已找到焦点位置 2: 对焦结束，失焦 3: 对焦结束，物体过近 4: 对焦结束，物体过远 5: 对焦结束, ROI 变化 6: 对焦结束，场景变化 7: 对焦结束，对焦模式变化（通常由用户调节器决定） 8: 对焦未完成；对焦开始时会被设置为未完成	0x1c
  MIINAM_PARA_AFPOSITION_ABSOLUTE	自动对焦传感器板的绝对位置	0x1d
  MIINAM_PARA_STATUS	状态, 详见MIINAM_STATE_XXXX	0x1e
  MIINAM_PARA_EVENT	事件, 详见MIINAM_EVENT_XXXX	0x1f
  MIINAM_PARA_WBROILEFT	白平衡下roi区域的左边界	0x20
  MIINAM_PARA_WBROITOP	白平衡下roi区域的上边界	0x21
  MIINAM_PARA_WBROIWIDTH	白平衡下roi区域的宽度	0x22
  MIINAM_PARA_WBROIHEIGHT	白平衡下roi区域的高度	0x23
  MIINAM_PARA_VFLIP	垂直翻转	0x24
  MIINAM_PARA_HFLIP	水平翻转	0x25
  MIINAM_PARA_CHROME	单色模式	0x26
  MIINAM_PARA_SIZE	视频的宽和高	0x27
  MIINAM_PARA_LIGHTADJUSTMENT	光源亮度调节	0x28
  MIINAM_PARA_ZOOM	变焦	0x29
  MIINAM_PARA_EF_MODE	自动对焦模式, 0:镜头校准模式; 1:手动对焦; 2:单次对焦; 3:自动对焦;(EF表示镜头自动对焦, 下列即表示EF相关的参数)	0x2a
  MIINAM_PARA_EF_FL	焦距	0x2b
  MIINAM_PARA_EF_APERTURE	F数, 24~16bit:Cur, 15~8bit:Min, 7~0bit:Max	0x2c
  MIINAM_PARA_EF_FOCUS_MAX	焦距最大值	0x2d
  MIINAM_PARA_EF_LENS_ID	镜头ID	0x2e
  MIINAM_PARA_EF_AFMF	镜头对焦模式, 0;AF; 1:MF;	0x2f
  MIINAM_PARA_EF_WD_ENABLE	开启工作距离功能	0x30
  MIINAM_PARA_EF_WD_NEAR	近距离工作点	0x31
  MIINAM_PARA_EF_WD_FAR	远距离工作点	0x32
  MIINAM_PARA_CHROME_LOCAL	本地的单色模式	0x80
  MIINAM_PARA_VFLIP_LOCAL	本地的垂直翻转	0x81
  MIINAM_PARA_HFLIP_LOCAL	本地的水平翻转	0x82
  MIINAM_PARA_NEGATIVE_LOCAL	本地的负片	0x83
  MIINAM_PARA_FORMAT_LOCAL	图像输出格式, 必须在start之前设置	0x84

  pDataCallback和pParaCallback是由miinam.dll的内部线程回调的, 因此请注意多线程问题. 请尽量保持回调函数代码的简洁, 并且快速返回.
  当帧到达时, pDataCallback被回调. (NULL==pData)表示有错误.
  当MIINAM_PARA_xxx值更改时, pParaCallback将被回调.
  pCallbackCtx是Start传递的回调上下文.
  

• Miinam_Init

  返回值：无

  参数：pCallback回调函数, pCallbackCtx传到回调函数的指针

  说明：当miinam.dll/libmiinam.so发现新相机时, 将调用pCallback, 如果应用程序对此不感兴趣, pCallback可以为NULL. Miinam_Init应用程序启动时只调用一次

• Miinam_Fini

  返回值：无

  参数：无

  说明：应用程序退出时只调用一次

• Miinam_Enum

  返回值：非负整数, 枚举到的相机数目

  参数：MiinamDevice数组缓冲区

  说明：函数返回时, MiinamDevice缓冲区包含有枚举到的每个相机实例的信息. 如果不关心多个相机同时联入电脑的情况的话, 调用本函数枚举相机实例是可选的.

  name	型号名称
  flag	位标记 (Bitwise flag)
  	MIINAM_FLAG_WIFI_AP	终端
  	MIINAM_FLAG_WIFI_STA	客户端
  	MIINAM_FLAG_ETHERNET	以太网
  	MIINAM_FLAG_CAPTURE	支持从相机捕获图像
  	MIINAM_FLAG_AWBCHECKMODE	支持自动白平衡
  	MIINAM_FLAG_UVC	UVC相机
  	MIINAM_FLAG_WBGAIN	支持白平衡下的增益模式或者色温模式
  	MIINAM_FLAG_MULTICAST	RTSP/RTP
  	MIINAM_FLAG_AF	支持自动对焦
  	MIINAM_FLAG_SD	支持sd卡
  	MIINAM_FLAG_WBROI	支持白平衡的roi
  	MIINAM_FLAG_STA_SUPPORT	相机具有sta模式, 应用程序应具有sta账号和密码功能
  	MIINAM_FLAG_RTP_OVER_RTSP	rtp over rtsp
  	MIINAM_FLAG_HZ_AUTOEXPO	在50/60HZ光源的电力供应频率约束下支持自动曝光
  	MIINAM_FLAG_AFDM	自动对焦的一种方式
  	MIINAM_FLAG_EFL	支持镜头自动对焦
  	MIINAM_FLAG_CAPTURERAW	获取raw图
  state	状态
  	MIINAM_STATE_INITING	初始化
  	MIINAM_STATE_NORMAL	常态
  	MIINAM_STATE_UNREACHABLE	网络无法连接
  url	网络地址, 例如rtsp://xxxx/yyyy
  addr	ip地址
  version	版本号
  sn	序列号
  id	相机ID

• Miinam_Open
  Miinam_Open_ByIndex

  返回值：相机句柄. 失败时返回NULL

  参数：camId: 相机ID, 由Miinam_Enum枚举得到

  说明：打开相机实例.

• Miinam_Close

  返回值：无

  参数：HMiinam h: 相机句柄

  说明：关闭相机实例. 句柄关闭之后, 请不要再使用

• Miinam_PullImagePtr

  返回值：HRESULT 类型，表示操作成功或失败。

  参数：

  HMiinam h：相机句柄。

  MiinamImagePtr* ptrImage：帧缓冲区。

  说明：使用 ImagePtr 模式获取帧缓冲区。

• Miinam_PushImagePtr

  返回值：HRESULT 类型，表示操作成功或失败。

  参数：

  HMiinam h：相机句柄。

  unsigned ptrId：帧缓冲区 ID。

  说明：帧缓冲区使用完成后，必须将其归还给 SDK 以便重复利用。请注意以下事项：

  (a) 只有在帧缓冲区不再被使用时才能将其归还给 SDK。归还后继续访问该缓冲区是不安全的，因为 SDK 可能已经重新使用该缓冲区，并用新的图像数据覆盖了原有内存。

  (b) 如果帧缓冲区未被归还，可用缓冲区池中的缓冲区数量将逐渐减少。

  (c) 每个通过 Pull 获取的帧缓冲区（以其 ID 标识）只能归还一次，不允许重复归还。

  (d) 归还的顺序和Pull得到的顺序不需要一致, 也就是说可以乱序归还。

  (e) 对于尚未归还的帧缓冲区，在调用 Miinam_Stop 后仍然有效；而在调用 Miinam_Close 后，所有尚未归还的帧缓冲区会立即失效。

• Miinam_PullImage

  返回值：HRESULT类型表示成功或失败, 不存在图像可供获取时返回E_PENDING

  参数：

  HMiinam h: 相机句柄

  pImageData: 数据缓冲区. 用户应用程序必须确保改缓冲区足够大以容纳图像数据

  bits: 图像颜色位数, 支持24, 32, 48, 8, 16和64, 分别代表RGB24, RGB32, RGB48, 8位灰度, 16位灰度, RGB64图像

  pnWidth, pnHeight: 输出参数, 图像的宽度高度

  说明：无

• Miinam_StartPullModeWithCallback

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  void* pCallbackContext: 用户程序指定的回调函数

  说明：无

• Miinam_Stop

  返回值：HRESULT类型表示成功或失败

  参数：HMiinam h: 相机句柄

  说明：停止相机实例

• Miinam_Pause

  返回值：HRESULT类型表示成功或失败

  参数：HMiinam h: 相机句柄

  说明：暂停或者继续视频流

• Miinam_Capture
  Miinam_Capture_ById

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  camId: 相机id

  pstrFileName: 文件名

  pCaptureCallback: 回调函数

  pCallbackCtx: 传递的回调上下文

  说明：捕获图像，将其与从视频中提取的图像进行比较

  pstrFileName: NULL->捕获图像，然后通过回调返回

  “raw”->捕获原始图像，然后通过回调返回

  “abc.jpg”->捕获图像, 然后将其保存在相机sd卡中, 文件名为“abc.jpg”

  “abc.raw”->捕获原始图像, 然后将其保存在相机sd卡中, 文件名为“abc.raw”

  “thumbnail”->捕获缩略图图像，然后通过回调返回

  “*”->捕获图像, 然后用自动生成的文件名将其保存在相机sd卡中

  “*.raw”->捕获原始图像, 然后用自动生成的文件名将其保存在相机sd卡中

• Miinam_get_Size_ById

  返回值：HRESULT类型表示成功或失败

  参数：

  camId: 相机id

  res: 相机分辨率

  pWidth, pHeight: 传递宽和高的指针

  说明：无

• Miinam_get_Device

  返回值：MiinamDevice类型表示相机实例的信息

  参数：HMiinam h: 相机句柄

  说明：获取相机实例的信息

• Miinam_get_Size
  Miinam_get_CapSize

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  pWidth, pHeight: 当前分辨率的宽度高度

  说明：得到当前分辨率或录制分辨率

• Miinam_get_FourCC

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  unsigned* pFourCC: Four-Character Codes, 四字符代码

  说明：详见 http://en.wikipedia.org/wiki/FourCC, http://www.fourcc.org

• Miinam_Record

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  const char* fullpathname: 录制保存文件的绝对地址

  说明：当fullpathname == NULL 表示停止录制，支持的文件格式：*.asf, *.mp4, *.mkv

• Miinam_put_Para
  Miinam_get_Para

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  unsigned para: 参数类型, 详见MIINAM_PARA_xxx

  value: 设置或获取的值

  说明：得到当前分辨率或录制分辨率

• Miinam_put_Para_ById
  Miinam_put_Para_ById

  返回值：HRESULT类型表示成功或失败

  参数：

  HMiinam h: 相机句柄

  unsigned para: 参数类型, 详见MIINAM_PARA_xxx

  value: 设置或获取的值

  说明：通过相机id来设置参数, 与Miinam_put_Para, Miinam_get_Para有所区分

• Miinam_put_Wifi

  返回值：HRESULT类型表示成功或失败

  参数：

  const char* camId: 相机id

  MiinamWifi wifi: wifi账号密码

  说明：设置WiFi

• Miinam_add_Ip
  Miinam_del_Ip

  返回值：无

  参数：const char** arr: 相机ip地址的列表

  说明：用于组播通讯模式, 可以对指定ip地址的相机进行通信, 对广播通讯模式无效

  如下面的代码片段：
  

  char* arr[] = { "1.2.3.4", "1.2.3.5", ..., NULL }; Miinam_add_Ip(arr);