Mech-Eye API 2.3.3
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
mmind::eye::CameraEvent Class Reference

The camera event related. Use CameraEvent::registerCameraEventCallback to register an event of interest. More...

#include <CameraEvent.h>

Public Types

enum  Event { CAMERA_EVENT_DISCONNECTED = 0x0001 , CAMERA_EVENT_ALL = 0xFFFF }
 The defined camera event. More...
 
using EventCallback = std::function<void(Event event, void* pUser)>
 

Static Public Member Functions

static ErrorStatus registerCameraEventCallback (Camera &camera, EventCallback callback, void *pUser, unsigned int events)
 Registers a camera event of interest.
 

Detailed Description

The camera event related. Use CameraEvent::registerCameraEventCallback to register an event of interest.

Definition at line 48 of file CameraEvent.h.

Member Typedef Documentation

◆ EventCallback

using mmind::eye::CameraEvent::EventCallback = std::function<void(Event event, void* pUser)>

Definition at line 59 of file CameraEvent.h.

Member Enumeration Documentation

◆ Event

The defined camera event.

Definition at line 54 of file CameraEvent.h.

Member Function Documentation

◆ registerCameraEventCallback()

static ErrorStatus mmind::eye::CameraEvent::registerCameraEventCallback ( Camera & camera,
EventCallback callback,
void * pUser,
unsigned int events )
static

Registers a camera event of interest.

Parameters
[in]cameraThe camera handle.
[in]callbackThe callback functions for responding to camera events.
[in]pUserPointer used by the user.
[in]eventsThe camera event. See CameraEvent::Event for details.
Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid camera handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Camera disconnected.
ErrorStatus::MMIND_STATUS_NO_SUPPORT_ERROR Not supported camera model or firmware version.

The documentation for this class was generated from the following file: