GigE Vision functions.
More...
#include <stdint.h>
#include <sys/types.h>
Go to the source code of this file.
|
| enum | GbeEventType {
GBE_EVENT_DISCOVERY_CHANGE = 100
, GBE_EVENT_CABLEDIAGNOSTIC_STATUS = 110
, GBE_EVENT_TEMPERATURE_ALERT = 120
, GBE_EVENT_PHY_IRQ = 130
,
GBE_EVENT_CAMERA_CONNECTION_LOST = 200
, GBE_EVENT_GEVEVENT = 300
, GBE_EVENT_CORRUPTED_FRAME = 400
, GBE_EVENT_EXTERNAL_FRAME_LOSS = 401
,
GBE_EVENT_LOST_FRAME = 402
, GBE_EVENT_BROKEN_FRAME = 403
, GBE_EVENT_ACTIONCOMMAND_LOST = 404
, GBE_EVENT_ACTIONCOMMAND_TIMEOUT = 405
} |
| |
|
| int | Gbe_ApplyChunkData (struct CameraHandle *cameraHandle, const void *buffer, size_t length, uint32_t flags) |
| | Apply chunk data to the GenICam data model. More...
|
| |
| int | Gbe_callInternalFunction (int id, const void *const in, void *const out) |
| | Generic interface for calling an internal functions (not for public use!) More...
|
| |
| int | Gbe_connectCamera (struct CameraHandle *camera_handle) |
| | Establish camera connection. More...
|
| |
| int | Gbe_connectCameraWithExternalXml (struct CameraHandle *camera_handle, const char *filename) |
| | Establish camera connection. More...
|
| |
| int | Gbe_connectUdpSocket (struct BoardHandle *board_handle, int port, uint16_t *local_udp_port, uint32_t flags) |
| | Establish local UDP socket. More...
|
| |
| int | Gbe_disconnectCamera (struct CameraHandle *camera_handle) |
| | Release camera connection. More...
|
| |
| int | Gbe_disconnectUdpSocket (struct BoardHandle *board_handle, int port, uint16_t local_udp_port) |
| | Remove local UDP socket. More...
|
| |
| int | Gbe_enableChecks (struct CameraHandle *camera_handle, unsigned int flag) |
| | Enable/Disable GenICam checks (i.e. locked/available/implemented) More...
|
| |
| int | Gbe_executeCommand (struct CameraHandle *camera_handle, const char *name) |
| | Execute GenICam Command. More...
|
| |
| void | Gbe_freeBoard (struct BoardHandle *board_handle) |
| | Releases the Gbe board. More...
|
| |
| void | Gbe_freeCamera (struct CameraHandle *camera_handle) |
| | Releases the camera. More...
|
| |
| int | Gbe_getBoardPropertyWithType (struct BoardHandle *board_handle, const char *propertyName, void *propertyValuePtr, int propertyType) |
| | Get board property. More...
|
| |
| int | Gbe_getBooleanValue (struct CameraHandle *camera_handle, const char *name, unsigned int *value_ptr) |
| | Get GenICam Boolean value. More...
|
| |
| int | Gbe_getCameraByIndex (struct BoardHandle *board_handle, int port, unsigned int index, struct CameraHandle **camera_handle_ptr) |
| | Get camera by index on a port. More...
|
| |
| int | Gbe_getCameraByIp (struct BoardHandle *board_handle, int port, uint32_t ip, struct CameraHandle **camera_handle_ptr) |
| | Get camera by IP on a port. More...
|
| |
| int | Gbe_getCameraByMac (struct BoardHandle *board_handle, int port, uint8_t mac[6], struct CameraHandle **camera_handle_ptr) |
| | Get camera by MAC on a port. More...
|
| |
| int | Gbe_getCameraByUserName (struct BoardHandle *board_handle, int port, char *user_name, struct CameraHandle **camera_handle_ptr) |
| | Get camera by camera user name on a port. More...
|
| |
| int | Gbe_getCameraCount (struct BoardHandle *board_handle, int port) |
| | Get the number of cameras found on a port. More...
|
| |
| struct CameraInfo * | Gbe_getCameraInfo (struct CameraHandle *camera_handle) |
| | Get camera info. More...
|
| |
| int | Gbe_getCameraPropertyWithType (struct CameraHandle *camera_handle, const char *propertyName, void *propertyValuePtr, int propertyType) |
| | Get camera property. More...
|
| |
| int | Gbe_getEnumerationValue (struct CameraHandle *camera_handle, const char *name, const char **value_ptr) |
| | Get GenICam Enumeration value. More...
|
| |
| const char * | Gbe_getErrorDescription (int errcode) |
| | Get error description. More...
|
| |
| int | Gbe_getFirstCamera (struct BoardHandle *board_handle, int port, struct CameraHandle **camera_handle_ptr) |
| | Get the first camera found on a port. More...
|
| |
| int | Gbe_getFloatValue (struct CameraHandle *camera_handle, const char *name, double *value_ptr) |
| | Get GenICam Float value. More...
|
| |
| int | Gbe_getFloatValueLimits (struct CameraHandle *camera_handle, const char *name, double *min_value_ptr, double *max_value_ptr) |
| | Get GenICam Float limit values. More...
|
| |
| int | Gbe_getGenICamXML (struct CameraHandle *camera_handle, char *buffer, size_t *buffer_size) |
| | Get the GenICam XML data for the camera. More...
|
| |
| int | Gbe_getIntegerValue (struct CameraHandle *camera_handle, const char *name, int64_t *value_ptr) |
| | Get GenICam Integer value. More...
|
| |
| int | Gbe_getIntegerValueLimits (struct CameraHandle *camera_handle, const char *name, int64_t *min_value_ptr, int64_t *max_value_ptr, int64_t *inc_value_ptr) |
| | Get GenICam Integer limit values. More...
|
| |
| int | Gbe_getStringValue (struct CameraHandle *camera_handle, const char *name, const char **value_ptr) |
| | Get GenICam String value. More...
|
| |
| int | Gbe_gsConnectCamera (struct CameraHandle *camera_handle) |
| | Establish a camera connection without starting a GenAPI connection. More...
|
| |
| int | Gbe_initBoard (int board, int init_flag, struct BoardHandle **board_handle_ptr) |
| | Initializes the Gbe board. More...
|
| |
| int | Gbe_invalidateCache (struct CameraHandle *camera_handle) |
| | Invalidates the register cache for the camera. More...
|
| |
| int | Gbe_isCommandDone (struct CameraHandle *camera_handle, const char *name) |
| | Check status of a GenICam Command. More...
|
| |
| int | Gbe_isServiceConnectionValid (struct BoardHandle *board_handle) |
| | Check if the service connection is still valid. More...
|
| |
| int | Gbe_LoadCameraParameters (struct CameraHandle *cameraHandle, const char *paramFileName, uint32_t flags) |
| | Load a camera parameters file (name/value pairs) and applies value to camera. More...
|
| |
| int | Gbe_lockTLParams (struct CameraHandle *camera_handle) |
| | Lock GenICam transport layer parameters. More...
|
| |
| int | Gbe_NotifyMasterInitialized (unsigned int board) |
| | Notify slave processes about a completed Fg_Init(...) as master process. More...
|
| |
| int | Gbe_recvUdpDatagram (struct BoardHandle *board_handle, int port, uint16_t local_udp_port, void *buffer, size_t *length, int32_t timeout) |
| | Recv UDP datagram via camera socket. More...
|
| |
| int | Gbe_registerBoardEventCallback (struct BoardHandle *board_handle, Gbe_BoardEventCallbackFunc_t callback, const void *userData) |
| | Register callback function for board Gbe Events. More...
|
| |
| int | Gbe_registerCameraEventCallback (struct CameraHandle *camera_handle, Gbe_CameraEventCallbackFunc_t callback, const void *userData) |
| | Register callback function for camera Gbe Events. More...
|
| |
| int | Gbe_registerReadFromCamera (struct CameraHandle *camera_handle, void *buffer, uint64_t address, size_t length) |
| | Read register content from camera. More...
|
| |
| int | Gbe_registerWriteToCamera (struct CameraHandle *camera_handle, const void *buffer, uint64_t address, size_t length) |
| | Write register content to camera. More...
|
| |
| int | Gbe_RequestMasterSlaveInit (unsigned int board, int slave, unsigned int flags, unsigned int timeout) |
| | Synchronize system wide Master/Slave initialization (call this function before Fg_Init(...)) More...
|
| |
| int | Gbe_resetStreamChannel (struct CameraHandle *camera_handle) |
| | Reset stream channel of a camera connection. More...
|
| |
| int | Gbe_SaveCameraParameters (struct CameraHandle *cameraHandle, const char *paramFileName, uint32_t flags) |
| | Save all current camera parameters to file (name/value pairs) More...
|
| |
| int | Gbe_scanNetwork (struct BoardHandle *board_handle, int port, int discovery_timeout) |
| | Scans the network for cameras. More...
|
| |
| int | Gbe_sendActionCommand (struct BoardHandle *board_handle, int port, uint32_t ipv4, uint32_t device_key, uint32_t group_key, uint32_t group_mask) |
| | Sends an ACTION command over selected port. More...
|
| |
| int | Gbe_sendForceIpCommand (struct BoardHandle *board_handle, int port, uint8_t mac[6], uint32_t ipv4, uint32_t ipv4_mask, uint32_t ipv4_gateway) |
| | Sends a FORCEIP command over selected port. More...
|
| |
| int | Gbe_sendUdpPayload (struct BoardHandle *board_handle, int port, uint16_t local_udp_port, uint32_t remote_ipv4, uint16_t remote_port, const void *buffer, size_t length) |
| | Send UDP payload via UDP socket. More...
|
| |
| int | Gbe_setBoardPropertyWithType (struct BoardHandle *board_handle, const char *propertyName, const void *propertyValuePtr, int propertyType) |
| | Set board property. More...
|
| |
| int | Gbe_setBooleanValue (struct CameraHandle *camera_handle, const char *name, unsigned int value) |
| | Set GenICam Boolean value. More...
|
| |
| int | Gbe_setCameraPropertyWithType (struct CameraHandle *camera_handle, const char *propertyName, const void *propertyValuePtr, int propertyType) |
| | Set camera property. More...
|
| |
| int | Gbe_setEnumerationValue (struct CameraHandle *camera_handle, const char *name, const char *value) |
| | Set GenICam Enumeration value. More...
|
| |
| int | Gbe_setFloatValue (struct CameraHandle *camera_handle, const char *name, double value) |
| | Set GenICam Float value. More...
|
| |
| int | Gbe_setIntegerValue (struct CameraHandle *camera_handle, const char *name, int64_t value) |
| | Set GenICam Integer value. More...
|
| |
| int | Gbe_setStringValue (struct CameraHandle *camera_handle, const char *name, const char *value) |
| | Set GenICam String value. More...
|
| |
| int | Gbe_startAcquisition (struct CameraHandle *camera_handle) |
| | Start image acquisition. More...
|
| |
| int | Gbe_stopAcquisition (struct CameraHandle *camera_handle) |
| | Stop image acquisition. More...
|
| |
| int | Gbe_switchCameraConnection (struct CameraHandle *camera_handle, struct BoardHandle *board_handle, int port) |
| | Switch established camera connection to another board/port. More...
|
| |
| int | Gbe_unlockTLParams (struct CameraHandle *camera_handle) |
| | Unlock GenICam transport layer parameters. More...
|
| |
GigE Vision functions.
gbe.h
Copyright (c) 2021 Basler AG, All Rights Reserved.
- Author
- Basler AG
◆ GBE_BOARDPROP_CLOSEIMAGETIMEOUT0
| #define GBE_BOARDPROP_CLOSEIMAGETIMEOUT0 "closeImageTimeout0" |
current CloseImageTimeout for portgroup 0 [in/out]
◆ GBE_BOARDPROP_CLOSEIMAGETIMEOUT1
| #define GBE_BOARDPROP_CLOSEIMAGETIMEOUT1 "closeImageTimeout1" |
current CloseImageTimeout for portgroup 1 [in/out]
◆ GBE_BOARDPROP_CLOSEIMAGETIMEOUT2
| #define GBE_BOARDPROP_CLOSEIMAGETIMEOUT2 "closeImageTimeout2" |
current CloseImageTimeout for portgroup 2 [in/out]
◆ GBE_BOARDPROP_CLOSEIMAGETIMEOUT3
| #define GBE_BOARDPROP_CLOSEIMAGETIMEOUT3 "closeImageTimeout3" |
current CloseImageTimeout for portgroup 3 [in/out]
◆ GBE_BOARDPROP_CONNECTIONSTATE0
| #define GBE_BOARDPROP_CONNECTIONSTATE0 "connectionState0" |
Connection state of port 0 (if supported) [out] (uint32)
◆ GBE_BOARDPROP_CONNECTIONSTATE1
| #define GBE_BOARDPROP_CONNECTIONSTATE1 "connectionState1" |
Connection state of port 1 (if supported) [out] (uint32)
◆ GBE_BOARDPROP_CONNECTIONSTATE2
| #define GBE_BOARDPROP_CONNECTIONSTATE2 "connectionState2" |
Connection state of port 2 (if supported) [out] (uint32)
◆ GBE_BOARDPROP_CONNECTIONSTATE3
| #define GBE_BOARDPROP_CONNECTIONSTATE3 "connectionState3" |
Connection state of port 3 (if supported) [out] (uint32)
◆ GBE_BOARDPROP_FAULTFLAGS0
| #define GBE_BOARDPROP_FAULTFLAGS0 "faultFlags0" |
Fault flags of port 0 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_FAULTFLAGS1
| #define GBE_BOARDPROP_FAULTFLAGS1 "faultFlags1" |
Fault flags of port 1 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_FAULTFLAGS2
| #define GBE_BOARDPROP_FAULTFLAGS2 "faultFlags2" |
Fault flags of port 2 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_FAULTFLAGS3
| #define GBE_BOARDPROP_FAULTFLAGS3 "faultFlags3" |
Fault flags of port 3 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_GVSPIMAGEPORT0
| #define GBE_BOARDPROP_GVSPIMAGEPORT0 "gvspImagePort0" |
current GVSP image port for portgroup 0 [out]
◆ GBE_BOARDPROP_GVSPIMAGEPORT1
| #define GBE_BOARDPROP_GVSPIMAGEPORT1 "gvspImagePort1" |
current GVSP image port for portgroup 1 [out]
◆ GBE_BOARDPROP_GVSPIMAGEPORT2
| #define GBE_BOARDPROP_GVSPIMAGEPORT2 "gvspImagePort2" |
current GVSP image port for portgroup 2 [out]
◆ GBE_BOARDPROP_GVSPIMAGEPORT3
| #define GBE_BOARDPROP_GVSPIMAGEPORT3 "gvspImagePort3" |
current GVSP image port for portgroup 3 [out]
◆ GBE_BOARDPROP_IDLEERRORCOUNT0
| #define GBE_BOARDPROP_IDLEERRORCOUNT0 "idleErrorCount0" |
Idle error count of port 0 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_IDLEERRORCOUNT1
| #define GBE_BOARDPROP_IDLEERRORCOUNT1 "idleErrorCount1" |
Idle error count of port 1 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_IDLEERRORCOUNT2
| #define GBE_BOARDPROP_IDLEERRORCOUNT2 "idleErrorCount2" |
Idle error count of port 2 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_IDLEERRORCOUNT3
| #define GBE_BOARDPROP_IDLEERRORCOUNT3 "idleErrorCount3" |
Idle error count of port 3 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_IP0
| #define GBE_BOARDPROP_IP0 "ip0" |
current IP for portgroup 0 [out]
◆ GBE_BOARDPROP_IP1
| #define GBE_BOARDPROP_IP1 "ip1" |
current IP for portgroup 1 [out]
◆ GBE_BOARDPROP_IP2
| #define GBE_BOARDPROP_IP2 "ip2" |
current IP for portgroup 2 [out]
◆ GBE_BOARDPROP_IP3
| #define GBE_BOARDPROP_IP3 "ip3" |
current IP for portgroup 3 [out]
◆ GBE_BOARDPROP_LAG
| #define GBE_BOARDPROP_LAG "lag" |
◆ GBE_BOARDPROP_LINKSTATE0
| #define GBE_BOARDPROP_LINKSTATE0 "linkState0" |
Link state of port 0 (if supported) [out]
◆ GBE_BOARDPROP_LINKSTATE1
| #define GBE_BOARDPROP_LINKSTATE1 "linkState1" |
Link state of port 1 (if supported) [out]
◆ GBE_BOARDPROP_LINKSTATE2
| #define GBE_BOARDPROP_LINKSTATE2 "linkState2" |
Link state of port 2 (if supported) [out]
◆ GBE_BOARDPROP_LINKSTATE3
| #define GBE_BOARDPROP_LINKSTATE3 "linkState3" |
Link state of port 3 (if supported) [out]
◆ GBE_BOARDPROP_MAXLINKSPEED0
| #define GBE_BOARDPROP_MAXLINKSPEED0 "maxLinkSpeed0" |
Maximum link speed of port 0 (if supported) [in/out]
◆ GBE_BOARDPROP_MAXLINKSPEED1
| #define GBE_BOARDPROP_MAXLINKSPEED1 "maxLinkSpeed1" |
Maximum link speed of port 1 (if supported) [in/out]
◆ GBE_BOARDPROP_MAXLINKSPEED2
| #define GBE_BOARDPROP_MAXLINKSPEED2 "maxLinkSpeed2" |
Maximum link speed of port 2 (if supported) [in/out]
◆ GBE_BOARDPROP_MAXLINKSPEED3
| #define GBE_BOARDPROP_MAXLINKSPEED3 "maxLinkSpeed3" |
Maximum link speed of port 3 (if supported) [in/out]
◆ GBE_BOARDPROP_PAYLOADWIDTH0
| #define GBE_BOARDPROP_PAYLOADWIDTH0 "payloadWidth0" |
set payload width in bytes for port 0 [in]
◆ GBE_BOARDPROP_PAYLOADWIDTH1
| #define GBE_BOARDPROP_PAYLOADWIDTH1 "payloadWidth1" |
set payload width in bytes for port 1 [in]
◆ GBE_BOARDPROP_PAYLOADWIDTH2
| #define GBE_BOARDPROP_PAYLOADWIDTH2 "payloadWidth2" |
set payload width in bytes for port 2 [in]
◆ GBE_BOARDPROP_PAYLOADWIDTH3
| #define GBE_BOARDPROP_PAYLOADWIDTH3 "payloadWidth3" |
set payload width in bytes for port 3 [in]
◆ GBE_BOARDPROP_POE0
| #define GBE_BOARDPROP_POE0 "poe0" |
POE on/off state of port 0 (if supported) [in/out] (uint16)
◆ GBE_BOARDPROP_POE1
| #define GBE_BOARDPROP_POE1 "poe1" |
POE on/off state of port 1 (if supported) [in/out] (uint16)
◆ GBE_BOARDPROP_POE2
| #define GBE_BOARDPROP_POE2 "poe2" |
POE on/off state of port 2 (if supported) [in/out] (uint16)
◆ GBE_BOARDPROP_POE3
| #define GBE_BOARDPROP_POE3 "poe3" |
POE on/off state of port 3 (if supported) [in/out] (uint16)
◆ GBE_BOARDPROP_POE_SENSOR0
| #define GBE_BOARDPROP_POE_SENSOR0 "poeSensor0" |
POE sensors of port 0 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_SENSOR1
| #define GBE_BOARDPROP_POE_SENSOR1 "poeSensor1" |
POE sensors of port 1 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_SENSOR2
| #define GBE_BOARDPROP_POE_SENSOR2 "poeSensor2" |
POE sensors of port 2 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_SENSOR3
| #define GBE_BOARDPROP_POE_SENSOR3 "poeSensor3" |
POE sensors of port 3 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_STATE0
| #define GBE_BOARDPROP_POE_STATE0 "poeState0" |
POE state of port 0 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_STATE1
| #define GBE_BOARDPROP_POE_STATE1 "poeState1" |
POE state of port 1 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_STATE2
| #define GBE_BOARDPROP_POE_STATE2 "poeState2" |
POE state of port 2 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_POE_STATE3
| #define GBE_BOARDPROP_POE_STATE3 "poeState3" |
POE state of port 3 (if supported) [out] (uint64)
◆ GBE_BOARDPROP_RXERCOUNT0
| #define GBE_BOARDPROP_RXERCOUNT0 "rxerCount0" |
RXER count of port 0 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_RXERCOUNT1
| #define GBE_BOARDPROP_RXERCOUNT1 "rxerCount1" |
RXER count of port 1 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_RXERCOUNT2
| #define GBE_BOARDPROP_RXERCOUNT2 "rxerCount2" |
RXER count of port 2 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_RXERCOUNT3
| #define GBE_BOARDPROP_RXERCOUNT3 "rxerCount3" |
RXER count of port 3 (if supported) [out] (uint16)
◆ GBE_BOARDPROP_START_CABLEDIAGNOSTIC0
| #define GBE_BOARDPROP_START_CABLEDIAGNOSTIC0 "startCableDiagnostic0" |
start cable diagnostic for port 0 (if supported) [writeonly]
◆ GBE_BOARDPROP_START_CABLEDIAGNOSTIC1
| #define GBE_BOARDPROP_START_CABLEDIAGNOSTIC1 "startCableDiagnostic1" |
start cable diagnostic for port 1 (if supported) [writeonly]
◆ GBE_BOARDPROP_START_CABLEDIAGNOSTIC2
| #define GBE_BOARDPROP_START_CABLEDIAGNOSTIC2 "startCableDiagnostic2" |
start cable diagnostic for port 2 (if supported) [writeonly]
◆ GBE_BOARDPROP_START_CABLEDIAGNOSTIC3
| #define GBE_BOARDPROP_START_CABLEDIAGNOSTIC3 "startCableDiagnostic3" |
start cable diagnostic for port 3 (if supported) [writeonly]
◆ GBE_CAMPROP_ACTIONDEVICEKEY
| #define GBE_CAMPROP_ACTIONDEVICEKEY "actionDeviceKey" |
set/get action device key [in/out]
◆ GBE_CAMPROP_ACTIONGROUPKEY0
| #define GBE_CAMPROP_ACTIONGROUPKEY0 "actionGroupKey0" |
set/get action group key for action 0 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPKEY1
| #define GBE_CAMPROP_ACTIONGROUPKEY1 "actionGroupKey1" |
set/get action group key for action 1 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPKEY2
| #define GBE_CAMPROP_ACTIONGROUPKEY2 "actionGroupKey2" |
set/get action group key for action 2 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPKEY3
| #define GBE_CAMPROP_ACTIONGROUPKEY3 "actionGroupKey3" |
set/get action group key for action 3 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPMASK0
| #define GBE_CAMPROP_ACTIONGROUPMASK0 "actionGroupMask0" |
set/get action group mask for action 0 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPMASK1
| #define GBE_CAMPROP_ACTIONGROUPMASK1 "actionGroupMask1" |
set/get action group mask for action 1 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPMASK2
| #define GBE_CAMPROP_ACTIONGROUPMASK2 "actionGroupMask2" |
set/get action group mask for action 2 [in/out]
◆ GBE_CAMPROP_ACTIONGROUPMASK3
| #define GBE_CAMPROP_ACTIONGROUPMASK3 "actionGroupMask3" |
set/get action group mask for action 4 [in/out]
◆ GBE_CAMPROP_COMMANDPACKET_RETRIES
| #define GBE_CAMPROP_COMMANDPACKET_RETRIES "commandPacketRetries" |
set/get command packet retries count [in/out]
◆ GBE_CAMPROP_COMMANDPACKET_TIMEOUT
| #define GBE_CAMPROP_COMMANDPACKET_TIMEOUT "commandPacketTimeout" |
set/get command packet timeout (ms) [in/out]
◆ GBE_CAMPROP_EXTENDED_ID
| #define GBE_CAMPROP_EXTENDED_ID "extendedId" |
set/get extended ID mode (if supported) [in/out]
◆ GBE_CAMPROP_FWAC_DEVICEKEY
| #define GBE_CAMPROP_FWAC_DEVICEKEY "fwacDeviceKey" |
set/get firmware action device key (if supported) [in/out]
◆ GBE_CAMPROP_FWAC_ENABLE
| #define GBE_CAMPROP_FWAC_ENABLE "fwacEnable" |
set/get firmware action enable flag (if supported) [in/out]
◆ GBE_CAMPROP_FWAC_GROUPKEY
| #define GBE_CAMPROP_FWAC_GROUPKEY "fwacGroupKey" |
set/get firmware action group key (if supported) [in/out]
◆ GBE_CAMPROP_FWAC_GROUPMASK
| #define GBE_CAMPROP_FWAC_GROUPMASK "fwacGroupMask" |
set/get firmware action group mask (if supported) [in/out]
◆ GBE_CAMPROP_FWAC_PENDING
| #define GBE_CAMPROP_FWAC_PENDING "fwacPending" |
set/get firmware action command pending count (if supported) [out]
◆ GBE_CAMPROP_FWAC_TIMEOUT
| #define GBE_CAMPROP_FWAC_TIMEOUT "fwacTimeout" |
set/get firmware action command acknowledge timeout (if supported) [in/out]
◆ GBE_CAMPROP_MTU
| #define GBE_CAMPROP_MTU "mtu" |
set/get MTU size [in/out]
◆ GBE_CAMPROP_NUMBEROFACTIONSIGNALS
| #define GBE_CAMPROP_NUMBEROFACTIONSIGNALS "numberOfActionSignals" |
get number of action signals [out]
◆ GBE_FLAGS_NONE
| #define GBE_FLAGS_NONE 0x0 |
◆ GBE_FLAGS_STOPONERROR
| #define GBE_FLAGS_STOPONERROR 0x1 |
◆ GBE_PROPERTY_TYPE_UINT
property type is unsigned int (32bit)
◆ GBE_PROPERTY_TYPE_UINT16
| #define GBE_PROPERTY_TYPE_UINT16 0x2 |
property type is unsigned int (16bit)
◆ GBE_PROPERTY_TYPE_UINT32
| #define GBE_PROPERTY_TYPE_UINT32 0x1 |
property type is unsigned int (32bit)
◆ GBE_PROPERTY_TYPE_UINT64
| #define GBE_PROPERTY_TYPE_UINT64 0x3 |
property type is unsigned int (64bit)
◆ SISO_INTERNAL_FUNCTION__RESET_PHY
| #define SISO_INTERNAL_FUNCTION__RESET_PHY 1 |
Id for Siso Internal Function 'Reset PHY'
◆ Gbe_BoardEventCallbackFunc_t
| typedef int(* Gbe_BoardEventCallbackFunc_t) (struct BoardHandle *boardHandle, const GbeEventInfo *const eventInfo, const void *userData) |
Callback function definition for Board Events.
- Parameters
-
| boardHandle | the handle to the board the event is triggered from |
| eventInfo | event details/data |
| userData | user data pointer from the matching call to Gbe_registerBoardEventCallback |
- Returns
- use 0 to indicate success (currently the return value will be ignored)
◆ Gbe_CameraEventCallbackFunc_t
| typedef int(* Gbe_CameraEventCallbackFunc_t) (struct CameraHandle *cameraHandle, const GbeEventInfo *const eventInfo, const void *userData) |
Callback function definition for Camera Events.
- Parameters
-
| cameraHandle | the handle to the camera the event is triggered from |
| eventInfo | event details/data |
| userData | user data pointer from the matching call to Gbe_registerCameraEventCallback |
- Returns
- use 0 to indicate success (currently the return value will be ignored)
◆ GbeEventType
| Enumerator |
|---|
| GBE_EVENT_DISCOVERY_CHANGE | event type "Discovery Change": the camera environment for the board has changed (Board Event)
|
| GBE_EVENT_CABLEDIAGNOSTIC_STATUS | event type "Cable Diagnostic Status": cable diagnostic status changed (Board Event)
|
| GBE_EVENT_TEMPERATURE_ALERT | event type "Temperature Alert": temperature alert (Board Event)
|
| GBE_EVENT_PHY_IRQ | event type "PHY IRQ": phy interrupt occurred (Board Event)
|
| GBE_EVENT_CAMERA_CONNECTION_LOST | event type "Camera Connection Lost": the connection to the connected camera has been lost (Camera Event)
|
| GBE_EVENT_GEVEVENT | event type "GEV Event": an GigE Vision event occurred (Camera Event)
|
| GBE_EVENT_CORRUPTED_FRAME | event type "Corrupted Frame": Event of type "Corrupted Frame" occurred (Camera Event)
|
| GBE_EVENT_EXTERNAL_FRAME_LOSS | event type "External Frame Loss": Event of type "External Frame Loss" occurred (Camera Event)
|
| GBE_EVENT_LOST_FRAME | event type "Lost Frame": Event of type "Lost Frame" occurred (Camera Event)
|
| GBE_EVENT_BROKEN_FRAME | event type "Broken Frame": Event of type "Broken Frame" occurred (Camera Event)
|
| GBE_EVENT_ACTIONCOMMAND_LOST | event type "ActionCommand Lost": Event of type "Action Command Lost" occurred (Camera Event)
|
| GBE_EVENT_ACTIONCOMMAND_TIMEOUT | event type "ActionCommand Timeout": Event of type "Action Command Timeout" occurred (Camera Event)
|
◆ Gbe_ApplyChunkData()
| int Gbe_ApplyChunkData |
( |
struct CameraHandle * |
cameraHandle, |
|
|
const void * |
buffer, |
|
|
size_t |
length, |
|
|
uint32_t |
flags |
|
) |
| |
Apply chunk data to the GenICam data model.
- Parameters
-
| cameraHandle | camera handle instance |
| buffer | pointer to the chunk data array |
| length | length of the chunk data array in bytes |
| flags | reserved (use 0) |
- Returns
- Gbe error code (defined in gbe_error.h)
◆ Gbe_callInternalFunction()
| int Gbe_callInternalFunction |
( |
int |
id, |
|
|
const void *const |
in, |
|
|
void *const |
out |
|
) |
| |
Generic interface for calling an internal functions (not for public use!)
- Parameters
-
| id | function id |
| in | input parameters |
| out | output parameters |
- Returns
- Gbe error code (defined in gbe_error.h)
◆ Gbe_connectCamera()
| int Gbe_connectCamera |
( |
struct CameraHandle * |
camera_handle | ) |
|
◆ Gbe_connectCameraWithExternalXml()
| int Gbe_connectCameraWithExternalXml |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
filename |
|
) |
| |
Establish camera connection.
- Parameters
-
| camera_handle | camera handle instance |
| filename | path to external xml file |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_connectUdpSocket()
| int Gbe_connectUdpSocket |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint16_t * |
local_udp_port, |
|
|
uint32_t |
flags |
|
) |
| |
Establish local UDP socket.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| local_udp_port | local udp port |
| flags | connection flags |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_disconnectCamera()
| int Gbe_disconnectCamera |
( |
struct CameraHandle * |
camera_handle | ) |
|
◆ Gbe_disconnectUdpSocket()
| int Gbe_disconnectUdpSocket |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint16_t |
local_udp_port |
|
) |
| |
Remove local UDP socket.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| local_udp_port | local udp port |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_enableChecks()
| int Gbe_enableChecks |
( |
struct CameraHandle * |
camera_handle, |
|
|
unsigned int |
flag |
|
) |
| |
Enable/Disable GenICam checks (i.e. locked/available/implemented)
- Parameters
-
| camera_handle | camera handle instance |
| flag | 0 = false, otherwise true |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_executeCommand()
| int Gbe_executeCommand |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name |
|
) |
| |
◆ Gbe_freeBoard()
| void Gbe_freeBoard |
( |
struct BoardHandle * |
board_handle | ) |
|
Releases the Gbe board.
- Parameters
-
| board_handle | board handle instance |
◆ Gbe_freeCamera()
| void Gbe_freeCamera |
( |
struct CameraHandle * |
camera_handle | ) |
|
Releases the camera.
- Parameters
-
| camera_handle | camera handle instance |
◆ Gbe_getBoardPropertyWithType()
| int Gbe_getBoardPropertyWithType |
( |
struct BoardHandle * |
board_handle, |
|
|
const char * |
propertyName, |
|
|
void * |
propertyValuePtr, |
|
|
int |
propertyType |
|
) |
| |
Get board property.
- Parameters
-
| board_handle | board handle instance |
| propertyName | name of the property |
| propertyValuePtr | pointer to the value of the property |
| propertyType | type of the property (see GBE_PROPERTY_TYPE_* defines) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_getBooleanValue()
| int Gbe_getBooleanValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
unsigned int * |
value_ptr |
|
) |
| |
Get GenICam Boolean value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value_ptr | pointer to value |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getCameraByIndex()
| int Gbe_getCameraByIndex |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
unsigned int |
index, |
|
|
struct CameraHandle ** |
camera_handle_ptr |
|
) |
| |
Get camera by index on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| index | index of the camera |
| camera_handle_ptr | pointer to the camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getCameraByIp()
| int Gbe_getCameraByIp |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint32_t |
ip, |
|
|
struct CameraHandle ** |
camera_handle_ptr |
|
) |
| |
Get camera by IP on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| ip | IP address of the camera |
| camera_handle_ptr | pointer to the camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getCameraByMac()
| int Gbe_getCameraByMac |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint8_t |
mac[6], |
|
|
struct CameraHandle ** |
camera_handle_ptr |
|
) |
| |
Get camera by MAC on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| mac | MAC address of the camera |
| camera_handle_ptr | pointer to the camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getCameraByUserName()
| int Gbe_getCameraByUserName |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
char * |
user_name, |
|
|
struct CameraHandle ** |
camera_handle_ptr |
|
) |
| |
Get camera by camera user name on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| user_name | user name of the camera (from the camera bootstrap registers) |
| camera_handle_ptr | pointer to the camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getCameraCount()
| int Gbe_getCameraCount |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port |
|
) |
| |
Get the number of cameras found on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
- Returns
- number of cameras found
◆ Gbe_getCameraInfo()
| struct CameraInfo * Gbe_getCameraInfo |
( |
struct CameraHandle * |
camera_handle | ) |
|
Get camera info.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- camera info structure
- See also
- CameraInfo
◆ Gbe_getCameraPropertyWithType()
| int Gbe_getCameraPropertyWithType |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
propertyName, |
|
|
void * |
propertyValuePtr, |
|
|
int |
propertyType |
|
) |
| |
Get camera property.
- Parameters
-
| camera_handle | camera handle instance |
| propertyName | name of the property |
| propertyValuePtr | pointer to the value of the property |
| propertyType | type of the property (see GBE_PROPERTY_TYPE_* defines) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_getEnumerationValue()
| int Gbe_getEnumerationValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
const char ** |
value_ptr |
|
) |
| |
Get GenICam Enumeration value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value_ptr | pointer to value |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getErrorDescription()
| const char * Gbe_getErrorDescription |
( |
int |
errcode | ) |
|
Get error description.
- Parameters
-
- Returns
- error description as string
◆ Gbe_getFirstCamera()
| int Gbe_getFirstCamera |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
struct CameraHandle ** |
camera_handle_ptr |
|
) |
| |
Get the first camera found on a port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| camera_handle_ptr | pointer to the camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getFloatValue()
| int Gbe_getFloatValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
double * |
value_ptr |
|
) |
| |
Get GenICam Float value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value_ptr | pointer to value |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getFloatValueLimits()
| int Gbe_getFloatValueLimits |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
double * |
min_value_ptr, |
|
|
double * |
max_value_ptr |
|
) |
| |
Get GenICam Float limit values.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| min_value_ptr | pointer to min value |
| max_value_ptr | pointer to max value |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getGenICamXML()
| int Gbe_getGenICamXML |
( |
struct CameraHandle * |
camera_handle, |
|
|
char * |
buffer, |
|
|
size_t * |
buffer_size |
|
) |
| |
Get the GenICam XML data for the camera.
- Parameters
-
| camera_handle | camera handle instance |
| buffer | user supplied buffer for the xml data (use 0 to get the needed buffer size!) |
| buffer_size | size of the user supplied buffer for the xml data (as return value: real size of the xml data) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_getIntegerValue()
| int Gbe_getIntegerValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
int64_t * |
value_ptr |
|
) |
| |
Get GenICam Integer value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value_ptr | pointer to value |
- Returns
- Gbe error code
- See also
- Gbe_getErrorDescription
◆ Gbe_getIntegerValueLimits()
| int Gbe_getIntegerValueLimits |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
int64_t * |
min_value_ptr, |
|
|
int64_t * |
max_value_ptr, |
|
|
int64_t * |
inc_value_ptr |
|
) |
| |
Get GenICam Integer limit values.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| min_value_ptr | pointer to min value |
| max_value_ptr | pointer to max value |
| inc_value_ptr | pointer to inc value |
- Returns
- Gbe error code
- See also
- Gbe_getErrorDescription
◆ Gbe_getStringValue()
| int Gbe_getStringValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
const char ** |
value_ptr |
|
) |
| |
Get GenICam String value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value_ptr | pointer to value |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_gsConnectCamera()
| int Gbe_gsConnectCamera |
( |
struct CameraHandle * |
camera_handle | ) |
|
Establish a camera connection without starting a GenAPI connection.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_initBoard()
| int Gbe_initBoard |
( |
int |
board, |
|
|
int |
init_flag, |
|
|
struct BoardHandle ** |
board_handle_ptr |
|
) |
| |
Initializes the Gbe board.
- Parameters
-
| board | board id |
| init_flag | initialization flags, should be 0 |
| board_handle_ptr | pointer to the board handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_invalidateCache()
| int Gbe_invalidateCache |
( |
struct CameraHandle * |
camera_handle | ) |
|
Invalidates the register cache for the camera.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_isCommandDone()
| int Gbe_isCommandDone |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name |
|
) |
| |
Check status of a GenICam Command.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
- Returns
- 0 = command in inactive, otherwise active
◆ Gbe_isServiceConnectionValid()
| int Gbe_isServiceConnectionValid |
( |
struct BoardHandle * |
board_handle | ) |
|
Check if the service connection is still valid.
- Parameters
-
| board_handle | board handle instance |
◆ Gbe_LoadCameraParameters()
| int Gbe_LoadCameraParameters |
( |
struct CameraHandle * |
cameraHandle, |
|
|
const char * |
paramFileName, |
|
|
uint32_t |
flags |
|
) |
| |
Load a camera parameters file (name/value pairs) and applies value to camera.
- Parameters
-
| cameraHandle | camera handle instance |
| paramFileName | source file path |
| flags | GBE_FLAGS_NONE or GBE_FLAGS_STOPONERROR |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_SaveCameraParameters
-
Gbe_getErrorDescription
◆ Gbe_lockTLParams()
| int Gbe_lockTLParams |
( |
struct CameraHandle * |
camera_handle | ) |
|
Lock GenICam transport layer parameters.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_NotifyMasterInitialized()
| int Gbe_NotifyMasterInitialized |
( |
unsigned int |
board | ) |
|
Notify slave processes about a completed Fg_Init(...) as master process.
- Parameters
-
- Returns
- Gbe error code (defined in gbe_error.h)
◆ Gbe_recvUdpDatagram()
| int Gbe_recvUdpDatagram |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint16_t |
local_udp_port, |
|
|
void * |
buffer, |
|
|
size_t * |
length, |
|
|
int32_t |
timeout |
|
) |
| |
Recv UDP datagram via camera socket.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| local_udp_port | local udp port |
| buffer | pointer to datagram buffer |
| length | size of datagram buffer |
| timeout | timeout in milliseconds |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_registerBoardEventCallback()
Register callback function for board Gbe Events.
- Parameters
-
| board_handle | board handle instance |
| callback | pointer to the user callback function (0 means deregister) |
| userData | user data pointer |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_registerCameraEventCallback()
Register callback function for camera Gbe Events.
- Parameters
-
| camera_handle | camera handle instance |
| callback | pointer to the user callback function (0 means deregister) |
| userData | user data pointer |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_registerReadFromCamera()
| int Gbe_registerReadFromCamera |
( |
struct CameraHandle * |
camera_handle, |
|
|
void * |
buffer, |
|
|
uint64_t |
address, |
|
|
size_t |
length |
|
) |
| |
Read register content from camera.
- Parameters
-
| camera_handle | camera handle instance |
| buffer | user buffer to be filled |
| address | camera register space address |
| length | size of camera register space to be read |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_registerWriteToCamera()
| int Gbe_registerWriteToCamera |
( |
struct CameraHandle * |
camera_handle, |
|
|
const void * |
buffer, |
|
|
uint64_t |
address, |
|
|
size_t |
length |
|
) |
| |
Write register content to camera.
- Parameters
-
| camera_handle | camera handle instance |
| buffer | user buffer to be written |
| address | camera register space address |
| length | size of camera register space to be written |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_RequestMasterSlaveInit()
| int Gbe_RequestMasterSlaveInit |
( |
unsigned int |
board, |
|
|
int |
slave, |
|
|
unsigned int |
flags, |
|
|
unsigned int |
timeout |
|
) |
| |
Synchronize system wide Master/Slave initialization (call this function before Fg_Init(...))
- Parameters
-
| board | board index |
| slave | request synchronization as master (0) or slave (0) |
| flags | reserved (use 0) |
| timeout | timeout in milliseconds |
- Returns
- Gbe error code (defined in gbe_error.h)
◆ Gbe_resetStreamChannel()
| int Gbe_resetStreamChannel |
( |
struct CameraHandle * |
camera_handle | ) |
|
Reset stream channel of a camera connection.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_SaveCameraParameters()
| int Gbe_SaveCameraParameters |
( |
struct CameraHandle * |
cameraHandle, |
|
|
const char * |
paramFileName, |
|
|
uint32_t |
flags |
|
) |
| |
◆ Gbe_scanNetwork()
| int Gbe_scanNetwork |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
int |
discovery_timeout |
|
) |
| |
Scans the network for cameras.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| discovery_timeout | timeout for the camera discovery |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_sendActionCommand()
| int Gbe_sendActionCommand |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint32_t |
ipv4, |
|
|
uint32_t |
device_key, |
|
|
uint32_t |
group_key, |
|
|
uint32_t |
group_mask |
|
) |
| |
Sends an ACTION command over selected port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| ipv4 | target IP address of the command |
| device_key | Device Key of the command |
| group_key | Group Key of the command |
| group_mask | Group Mask of the command |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_sendForceIpCommand()
| int Gbe_sendForceIpCommand |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint8_t |
mac[6], |
|
|
uint32_t |
ipv4, |
|
|
uint32_t |
ipv4_mask, |
|
|
uint32_t |
ipv4_gateway |
|
) |
| |
Sends a FORCEIP command over selected port.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| mac | MAC address of the target camera |
| ipv4 | IP address to force (use 0 for restarting ip configuration cycle) |
| ipv4_mask | IP address mask to force |
| ipv4_gateway | IP gateway address to force |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_sendUdpPayload()
| int Gbe_sendUdpPayload |
( |
struct BoardHandle * |
board_handle, |
|
|
int |
port, |
|
|
uint16_t |
local_udp_port, |
|
|
uint32_t |
remote_ipv4, |
|
|
uint16_t |
remote_port, |
|
|
const void * |
buffer, |
|
|
size_t |
length |
|
) |
| |
Send UDP payload via UDP socket.
- Parameters
-
| board_handle | board handle instance |
| port | port number |
| local_udp_port | local udp port |
| remote_ipv4 | remote ip address |
| remote_port | remote udp port |
| buffer | pointer to datagram |
| length | size of datagram |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_setBoardPropertyWithType()
| int Gbe_setBoardPropertyWithType |
( |
struct BoardHandle * |
board_handle, |
|
|
const char * |
propertyName, |
|
|
const void * |
propertyValuePtr, |
|
|
int |
propertyType |
|
) |
| |
Set board property.
- Parameters
-
| board_handle | board handle instance |
| propertyName | name of the property |
| propertyValuePtr | pointer to the value of the property |
| propertyType | type of the property (see PROPERTY_TYPE_* defines) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_setBooleanValue()
| int Gbe_setBooleanValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
unsigned int |
value |
|
) |
| |
Set GenICam Boolean value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value | value to write (0 = false, otherwise true) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_setCameraPropertyWithType()
| int Gbe_setCameraPropertyWithType |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
propertyName, |
|
|
const void * |
propertyValuePtr, |
|
|
int |
propertyType |
|
) |
| |
Set camera property.
- Parameters
-
| camera_handle | camera handle instance |
| propertyName | name of the property |
| propertyValuePtr | pointer to the value of the property |
| propertyType | type of the property (see PROPERTY_TYPE_* defines) |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
◆ Gbe_setEnumerationValue()
| int Gbe_setEnumerationValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
const char * |
value |
|
) |
| |
Set GenICam Enumeration value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value | value to write |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_setFloatValue()
| int Gbe_setFloatValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
double |
value |
|
) |
| |
Set GenICam Float value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value | value to write |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_setIntegerValue()
| int Gbe_setIntegerValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
int64_t |
value |
|
) |
| |
Set GenICam Integer value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value | value to write |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_setStringValue()
| int Gbe_setStringValue |
( |
struct CameraHandle * |
camera_handle, |
|
|
const char * |
name, |
|
|
const char * |
value |
|
) |
| |
Set GenICam String value.
- Parameters
-
| camera_handle | camera handle instance |
| name | feature name |
| value | value to write |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_startAcquisition()
| int Gbe_startAcquisition |
( |
struct CameraHandle * |
camera_handle | ) |
|
◆ Gbe_stopAcquisition()
| int Gbe_stopAcquisition |
( |
struct CameraHandle * |
camera_handle | ) |
|
◆ Gbe_switchCameraConnection()
| int Gbe_switchCameraConnection |
( |
struct CameraHandle * |
camera_handle, |
|
|
struct BoardHandle * |
board_handle, |
|
|
int |
port |
|
) |
| |
Switch established camera connection to another board/port.
- Parameters
-
| camera_handle | camera handle instance |
| board_handle | board handle instance |
| port | port number |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
◆ Gbe_unlockTLParams()
| int Gbe_unlockTLParams |
( |
struct CameraHandle * |
camera_handle | ) |
|
Unlock GenICam transport layer parameters.
- Parameters
-
| camera_handle | camera handle instance |
- Returns
- Gbe error code (defined in gbe_error.h)
- See also
- Gbe_getErrorDescription
- Warning
- expert function
|