bgapi2_genicam.h File Reference

Go to the source code of this file.

Typedefs

typedef struct BGAPI2_System BGAPI2_System
 Struct for pointers of type System. More...
 
typedef struct BGAPI2_Interface BGAPI2_Interface
 Struct for pointers of type Interface. More...
 
typedef struct BGAPI2_Device BGAPI2_Device
 Struct for pointers of type Device. More...
 
typedef struct BGAPI2_DataStream BGAPI2_DataStream
 Struct for pointers of type DataStream. More...
 
typedef struct BGAPI2_Buffer BGAPI2_Buffer
 Struct for pointers of type Buffer. More...
 
typedef struct BGAPI2_Node BGAPI2_Node
 Struct for pointers of type Node. More...
 
typedef struct BGAPI2_NodeMap BGAPI2_NodeMap
 Struct for pointers of type NodeMap. More...
 
typedef struct BGAPI2_Image BGAPI2_Image
 Struct for pointers of type Image. More...
 
typedef struct BGAPI2_ImageProcessor BGAPI2_ImageProcessor
 Struct for pointers of type ImageProcessor. More...
 
typedef struct BGAPI2_Polarizer BGAPI2_Polarizer
 Struct for pointers of type Polarizer. More...
 
typedef struct BGAPI2_DeviceEvent BGAPI2_DeviceEvent
 Struct for pointers of type DeviceEvent. More...
 
typedef struct BGAPI2_PnPEvent BGAPI2_PnPEvent
 Struct for pointers of type PnPEvent. More...
 
typedef void(BGAPI2CALL * BGAPI2_PnPEventHandler) (void *callBackOwner, BGAPI2_PnPEvent *pnpEvent)
 Declaration for callback functions for BGAPI2_PnPEventHandler. More...
 
typedef void(BGAPI2CALL * BGAPI2_DevEventHandler) (void *callBackOwner, BGAPI2_DeviceEvent *deviceEvent)
 Declaration for callback functions for BGAPI2_DevEventHandler. More...
 
typedef void(BGAPI2CALL * BGAPI2_NewBufferEventHandler) (void *callBackOwner, BGAPI2_Buffer *pBuffer)
 Declaration for callback functions for BGAPI2_NewBufferEventHandler. More...
 

Enumerations

enum  BGAPI2_EventMode { EVENTMODE_UNREGISTERED = 0, EVENTMODE_POLLING = 1, EVENTMODE_EVENT_HANDLER = 2 }
 An enumeration containing the string representation of the possible event configurations. More...
 
enum  BGAPI2_POLARIZER_FORMATS {
  BGAPI2_POLARIZER_AOP = 0, BGAPI2_POLARIZER_DOLP = 1, BGAPI2_POLARIZER_ADOLP = 2, BGAPI2_POLARIZER_INTENSITY = 3,
  BGAPI2_POLARIZER_POL0_DEG = 4, BGAPI2_POLARIZER_POL45_DEG = 5, BGAPI2_POLARIZER_POL90_DEG = 6, BGAPI2_POLARIZER_POL135_DEG = 7,
  BGAPI2_POLARIZER_REFLECTION_MIN = 8, BGAPI2_POLARIZER_REFLECTION_MAX = 9
}
 Enumeration containing the string representation of the possible polarization formats. More...
 

Functions

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_UpdateSystemList ()
 Search for GenTL producers in the current directory and in GENICAM_GENTLxx_PATH. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_UpdateSystemListFromPath (const char *producer_path)
 Search for GenTL producers only in the path specified. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_LoadSystemFromPath (const char *file_path, BGAPI2_System **system)
 Creates a system (GenTL producer) object, specified by filepath before opening it. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetNumSystems (bo_uint *count)
 Returns the number of systems (GenTL Producers) found by BGAPI2_UpdateSystemList() More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetSystem (bo_uint index, BGAPI2_System **system)
 Get a pointer to the System (GenTL Producer) specified by the index. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_Open (BGAPI2_System *system)
 Opens a system (GenTL producer) to work with it. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_IsOpen (BGAPI2_System *system, bo_bool *is_open)
 Check if the system (GenTL producer) is opened. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_UpdateInterfaceList (BGAPI2_System *system, bo_bool *changed, bo_uint64 timeout)
 Updates the list of of accessable interfaces and creates an object for each. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetInterface (BGAPI2_System *system, bo_uint index, BGAPI2_Interface **iface)
 Get a pointer to the interface with the specified index. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetNumInterfaces (BGAPI2_System *system, bo_uint *count_interfaces)
 Returns the number of accessable interfaces. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_Close (BGAPI2_System *system)
 Closes a system (producer), you need to call BGAPI2_ReleaseSystem to unload the library. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseSystem (BGAPI2_System *system)
 Release a system (GenTL producer) specified. You need to call BGAPI2_System_Close first! More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetNode (BGAPI2_System *system, const char *name, BGAPI2_Node **node)
 Get the named node (feature) of given map of system. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetNodeTree (BGAPI2_System *system, BGAPI2_NodeMap **node_tree)
 Get a tree of all system nodes (features) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetNodeList (BGAPI2_System *system, BGAPI2_NodeMap **node_list)
 Get a list of all system nodes (features) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetID (BGAPI2_System *system, char *ID, bo_uint64 *string_length)
 Returns the identifier of the system (GenTL producer). More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetVendor (BGAPI2_System *system, char *vendor, bo_uint64 *string_length)
 Returns the vendor of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetModel (BGAPI2_System *system, char *model, bo_uint64 *string_length)
 Returns the name (model) of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetVersion (BGAPI2_System *system, char *version, bo_uint64 *string_length)
 Returns the version of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetTLType (BGAPI2_System *system, char *tl_type, bo_uint64 *string_length)
 Returns the name of the transport layer of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetFileName (BGAPI2_System *system, char *name, bo_uint64 *string_length)
 Returns the file name of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetPathName (BGAPI2_System *system, char *path_name, bo_uint64 *string_length)
 Returns the complete path name of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_System_GetDisplayName (BGAPI2_System *system, char *display_name, bo_uint64 *string_length)
 Returns the "user friendly" display name of the system (GenTL producer) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_Open (BGAPI2_Interface *iface)
 Opens an interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_IsOpen (BGAPI2_Interface *iface, bo_bool *is_open)
 Checks the open state of a interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_UpdateDeviceList (BGAPI2_Interface *iface, bo_bool *changed, bo_uint64 timeout)
 Updates the list of devices on the interface and creates an object for each found device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetDevice (BGAPI2_Interface *iface, bo_uint index, BGAPI2_Device **device)
 Get a pointer to the device with supplied index. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetNumDevices (BGAPI2_Interface *iface, bo_uint *count_devices)
 Returns count of devices on interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetParent (BGAPI2_Interface *iface, BGAPI2_System **parent)
 Returns the parent object (GenTL producer) which the interface belongs to. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_Close (BGAPI2_Interface *iface)
 Closes an interfaces. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetNode (BGAPI2_Interface *iface, const char *name, BGAPI2_Node **node)
 Get a named node of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetNodeTree (BGAPI2_Interface *iface, BGAPI2_NodeMap **node_tree)
 Get the node tree of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetNodeList (BGAPI2_Interface *iface, BGAPI2_NodeMap **node_list)
 Get the node list of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_SetPnPEventMode (BGAPI2_Interface *iface, BGAPI2_EventMode event_mode)
 Set the event mode (polling, callback, off) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetPnPEventMode (BGAPI2_Interface *iface, BGAPI2_EventMode *event_mode)
 Returns the current event mode setting. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreatePnPEvent (BGAPI2_PnPEvent **pnp_event)
 Creates a structure to store pnp events retrieved via BGAPI2_Interface_GetPnPEvent More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleasePnPEvent (BGAPI2_PnPEvent *pnp_event)
 Destroys a pnp event structure. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetPnPEvent (BGAPI2_Interface *iface, BGAPI2_PnPEvent *pnp_event, bo_uint64 timeout)
 Polls for event information until timeout is reached. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_CancelGetPnPEvent (BGAPI2_Interface *iface)
 Cancels an actively running BGAPI2_Interface_GetPnPEvent More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_RegisterPnPEventHandler (BGAPI2_Interface *iface, void *callback_owner, BGAPI2_PnPEventHandler pnp_event_handler)
 Register one callback function to handle all pnp events of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetID (BGAPI2_Interface *iface, char *ID, bo_uint64 *string_length)
 Returns the identifier of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetDisplayName (BGAPI2_Interface *iface, char *display_name, bo_uint64 *string_length)
 Returns the "user friendly" display name of interface, can be called on an interface which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Interface_GetTLType (BGAPI2_Interface *iface, char *tl_type, bo_uint64 *string_length)
 Returns the transport layer name of interface, can be called on an interface which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_Open (BGAPI2_Device *device)
 Opens a device for reading and writing. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_OpenExclusive (BGAPI2_Device *device)
 Opens a device in exclusive mode. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_OpenReadOnly (BGAPI2_Device *device)
 Opens a device in read-only-mode. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_IsOpen (BGAPI2_Device *device, bo_bool *is_open)
 Checks if the device is opened. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetDataStream (BGAPI2_Device *device, bo_uint index, BGAPI2_DataStream **data_stream)
 Returns a pointer to the data stream handle identified by index. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetNumDataStreams (BGAPI2_Device *device, bo_uint *count_data_streams)
 Returns the number of datastreams of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_Close (BGAPI2_Device *device)
 Closes a device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetNode (BGAPI2_Device *device, const char *name, BGAPI2_Node **node)
 Get a named node of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetNodeTree (BGAPI2_Device *device, BGAPI2_NodeMap **node_tree)
 Get the node tree of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetNodeList (BGAPI2_Device *device, BGAPI2_NodeMap **node_list)
 Get the node list of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_SetDeviceEventMode (BGAPI2_Device *device, BGAPI2_EventMode event_mode)
 Set the device event mode (polling, callback, off) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetDeviceEventMode (BGAPI2_Device *device, BGAPI2_EventMode *event_mode)
 Get the device event mode (polling, callback, off) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateDeviceEvent (BGAPI2_DeviceEvent **device_event)
 Creates a structure to store device events retrieved via BGAPI2_Device_GetDeviceEvent More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseDeviceEvent (BGAPI2_DeviceEvent *device_event)
 Destroys a device event structure. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetDeviceEvent (BGAPI2_Device *device, BGAPI2_DeviceEvent *device_event, bo_uint64 timeout)
 Polls for event information until timeout is reached. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_CancelGetDeviceEvent (BGAPI2_Device *device)
 Cancels a running BGAPI2_Device_GetDeviceEvent More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_RegisterDeviceEventHandler (BGAPI2_Device *device, void *callback_owner, BGAPI2_DevEventHandler device_event_handler)
 Register one callback function to handle all device events of the interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetPayloadSize (BGAPI2_Device *device, bo_uint64 *payload_size)
 Returns the payload size in bytes, used to allocate image buffers. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetRemoteNode (BGAPI2_Device *device, const char *name, BGAPI2_Node **node)
 Get the named node of given remote device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetRemoteNodeTree (BGAPI2_Device *device, BGAPI2_NodeMap **node_tree)
 Get the update node tree of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetRemoteNodeList (BGAPI2_Device *device, BGAPI2_NodeMap **node_list)
 Get the update node list of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetID (BGAPI2_Device *device, char *ID, bo_uint64 *string_length)
 Returns the identifier of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetVendor (BGAPI2_Device *device, char *vendor, bo_uint64 *string_length)
 Returns the vendor of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetModel (BGAPI2_Device *device, char *model, bo_uint64 *string_length)
 Returns the name (model) of the device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetSerialNumber (BGAPI2_Device *device, char *serial_number, bo_uint64 *string_length)
 Returns the serial number of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetTLType (BGAPI2_Device *device, char *tl_type, bo_uint64 *string_length)
 Returns the transport layer of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetDisplayName (BGAPI2_Device *device, char *display_name, bo_uint64 *string_length)
 Returns the "user friendly" display name of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetAccessStatus (BGAPI2_Device *device, char *access_status, bo_uint64 *string_length)
 Returns the access state of device, can be called on a device which is not open. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetRemoteConfigurationFile (BGAPI2_Device *device, char *config_file, bo_uint64 *string_length)
 Returns the configuration file (xml) of the remote device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_SetRemoteConfigurationFile (BGAPI2_Device *device, const char *config_file)
 Sets a configuration file (xml) to use with the attached remote device (camera) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_StartStacking (BGAPI2_Device *device, bo_bool replace_mode)
 Starts a stack of feature writes to the device (caching write operations). More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_WriteStack (BGAPI2_Device *device)
 End the stacking and write all featues to the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_CancelStack (BGAPI2_Device *device)
 End the stacking without writing featues to the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_IsUpdateModeAvailable (BGAPI2_Device *device, bo_bool *is_available)
 Checks for availability of update state of device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_IsUpdateModeActive (BGAPI2_Device *device, bo_bool *is_active)
 Returns the update mode state of device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_SetUpdateMode (BGAPI2_Device *device, bo_bool update_mode, const char *custom_key)
 Set the update mode state of device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetUpdateNode (BGAPI2_Device *device, const char *name, BGAPI2_Node **node)
 Get the named node of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetUpdateNodeTree (BGAPI2_Device *device, BGAPI2_NodeMap **node_tree)
 Get the update node tree of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetUpdateNodeList (BGAPI2_Device *device, BGAPI2_NodeMap **node_list)
 Get the update node list of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetUpdateConfigurationFile (BGAPI2_Device *device, char *config_file, bo_uint64 *string_length)
 Returns the configuration file (xml) of the update device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Device_GetParent (BGAPI2_Device *device, BGAPI2_Interface **parent)
 Returns the parent object (interface) of the device. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetInterface (BGAPI2_Node *node, char *iface, bo_uint64 *string_length)
 Returns the data type (interface) of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetExtension (BGAPI2_Node *node, char *extension, bo_uint64 *string_length)
 Returns the extension (vendor specific information) of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetToolTip (BGAPI2_Node *node, char *tool_tip, bo_uint64 *string_length)
 Returns the tooltip of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDescription (BGAPI2_Node *node, char *description, bo_uint64 *string_length)
 Returns the description of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetName (BGAPI2_Node *node, char *name, bo_uint64 *string_length)
 Returns the name of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDisplayname (BGAPI2_Node *node, char *display_name, bo_uint64 *string_length)
 Returns the "user friendly" display name of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetVisibility (BGAPI2_Node *node, char *visibility, bo_uint64 *string_length)
 Returns the visibility of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetEventID (BGAPI2_Node *node, bo_int64 *event_id)
 Returns the event identifier of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetImplemented (BGAPI2_Node *node, bo_bool *is_implemented)
 Returns the implemented state of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAvailable (BGAPI2_Node *node, bo_bool *is_available)
 Returns the availability state of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetLocked (BGAPI2_Node *node, bo_bool *is_locked)
 Returns the locked state of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetImposedAccessMode (BGAPI2_Node *node, char *imposed_access_mode, bo_uint64 *string_length)
 Returns the imposed access mode of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetCurrentAccessMode (BGAPI2_Node *node, char *current_access_mode, bo_uint64 *string_length)
 Returns the current access mode of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsReadable (BGAPI2_Node *node, bo_bool *is_readable)
 Returns the readability state of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsWriteable (BGAPI2_Node *node, bo_bool *is_writable)
 Returns the writeability state of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAlias (BGAPI2_Node *node, char *alias, bo_uint64 *string_length)
 Returns the alias name of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetValue (BGAPI2_Node *node, char *value, bo_uint64 *string_length)
 Returns the value of node as a string. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetValue (BGAPI2_Node *node, const char *value)
 Sets a string value to a node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetRepresentation (BGAPI2_Node *node, char *representation, bo_uint64 *string_length)
 Returns the representation of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntMin (BGAPI2_Node *node, bo_int64 *min)
 Returns the minimal integer value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntMax (BGAPI2_Node *node, bo_int64 *max)
 Returns the maximum integer value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntInc (BGAPI2_Node *node, bo_int64 *inc)
 Returns the integer increment value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetInt (BGAPI2_Node *node, bo_int64 *value)
 Returns the integer value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetInt (BGAPI2_Node *node, bo_int64 value)
 Sets the integer value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_HasUnit (BGAPI2_Node *node, bo_bool *has_unit)
 Returns the availability of a unit for the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetUnit (BGAPI2_Node *node, char *unit, bo_uint64 *string_length)
 Returns the unit of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleMin (BGAPI2_Node *node, bo_double *min)
 Returns the minimal double value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleMax (BGAPI2_Node *node, bo_double *max)
 Returns the maximum double value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleInc (BGAPI2_Node *node, bo_double *inc)
 Returns the double increment value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_HasInc (BGAPI2_Node *node, bo_bool *has_inc)
 Returns the availability of an increment value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoublePrecision (BGAPI2_Node *node, bo_uint64 *prec)
 Returns the double precision value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDouble (BGAPI2_Node *node, bo_double *value)
 Returns the double value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetDouble (BGAPI2_Node *node, bo_double value)
 Sets the double value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetMaxStringLength (BGAPI2_Node *node, bo_int64 *max_string_length)
 Returns the maximum string length value of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetString (BGAPI2_Node *node, char *value, bo_uint64 *string_length)
 Returns the string value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetString (BGAPI2_Node *node, const char *value)
 Sets the string value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetEnumNodeList (BGAPI2_Node *node, BGAPI2_NodeMap **enum_node_map)
 Gets the enumeration node map of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Execute (BGAPI2_Node *node)
 Executes the selected node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsDone (BGAPI2_Node *node, bo_bool *is_done)
 Checks if the execution of node is done. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetBool (BGAPI2_Node *node, bo_bool *value)
 Returns the boolean value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetBool (BGAPI2_Node *node, bo_bool value)
 Sets the boolean value of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetNodeTree (BGAPI2_Node *node, BGAPI2_NodeMap **node_tree)
 Gets the node tree of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetNodeList (BGAPI2_Node *node, BGAPI2_NodeMap **node_list)
 Gets the node list of the node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsSelector (BGAPI2_Node *node, bo_bool *is_selector)
 Checks if the node is an selector. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetSelectedFeatures (BGAPI2_Node *node, BGAPI2_NodeMap **selected_features)
 Returns the selected features of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetLength (BGAPI2_Node *node, bo_int64 *length)
 Returns the (data) length of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAddress (BGAPI2_Node *node, bo_int64 *address)
 Returns the (data) address of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Get (BGAPI2_Node *node, void *buffer, bo_int64 length)
 Returns the data of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Set (BGAPI2_Node *node, void *buffer, bo_int64 length)
 Sets the data of node. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNode (BGAPI2_NodeMap *node_map, const char *name, BGAPI2_Node **node)
 Gets the named node of given map. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodeCount (BGAPI2_NodeMap *node_map, bo_uint64 *count)
 Returns the number of nodes in nodemap. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodeByIndex (BGAPI2_NodeMap *node_map, bo_uint64 index, BGAPI2_Node **node)
 Returns the node with the index. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodePresent (BGAPI2_NodeMap *node_map, const char *name, bo_bool *is_present)
 Checks if node is present in nodemap. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNode (BGAPI2_DeviceEvent *device_event, const char *name, BGAPI2_Node **node)
 Gets the named node of given map of interface. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNodeTree (BGAPI2_DeviceEvent *device_event, BGAPI2_NodeMap **node_tree)
 Gets the node map of interface (tree elements) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNodeList (BGAPI2_DeviceEvent *device_event, BGAPI2_NodeMap **node_tree)
 Gets the node map of interface (list of entries) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetName (BGAPI2_DeviceEvent *device_event, char *name, bo_uint64 *string_length)
 Returns the name of device event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetDisplayName (BGAPI2_DeviceEvent *device_event, char *display_name, bo_uint64 *string_length)
 Returns the "user friendly" display name of device event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetTimeStamp (BGAPI2_DeviceEvent *device_event, bo_uint64 *time_stamp)
 Returns the timestamp of device event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetID (BGAPI2_DeviceEvent *device_event, char *ID, bo_uint64 *string_length)
 Returns the identifier of device event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetSerialNumber (BGAPI2_PnPEvent *pnp_event, char *serial_number, bo_uint64 *string_length)
 Returns the serial number of pnp event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetPnPType (BGAPI2_PnPEvent *pnp_event, bo_uint64 *pnp_type)
 Returns the type of pnp event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetID (BGAPI2_PnPEvent *pnp_event, char *ID, bo_uint64 *string_length)
 Returns the identifier of pnp event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBuffer (BGAPI2_Buffer **buffer)
 Creates a new buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBufferWithUserPtr (BGAPI2_Buffer **buffer, void *user_obj)
 Returns a new buffer, initialized with user parameter. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBufferWithExternalMemory (BGAPI2_Buffer **buffer, void *user_buffer, bo_uint64 user_buffer_size, void *user_obj)
 Returns a new buffer, initialized with user parameter and external memory. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeleteBuffer (BGAPI2_Buffer *buffer, void **user_obj)
 Destroys the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNode (BGAPI2_Buffer *buffer, char *name, BGAPI2_Node **node)
 Gets a node of the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNodeTree (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_tree)
 Gets the node tree of the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNodeList (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_list)
 Gets the node list of the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetChunkNodeList (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_list)
 Gets the chunk node list of given buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetID (BGAPI2_Buffer *buffer, char *ID, bo_uint64 *string_length)
 Returns the identifier of the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetMemPtr (BGAPI2_Buffer *buffer, void **mem_ptr)
 Returns the memory (data) pointer of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetMemSize (BGAPI2_Buffer *buffer, bo_uint64 *buffer_size)
 Returns the memory size of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetUserPtr (BGAPI2_Buffer *buffer, void **user)
 Returns the user pointer of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetTimestamp (BGAPI2_Buffer *buffer, bo_uint64 *timestamp)
 Delivers the timestamp of the buffer obtained by the camera. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetHostTimestamp (BGAPI2_Buffer *buffer, bo_uint64 *host_timestamp)
 Returns the host time stamp of the first received packet of a new image using a steady clock. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNewData (BGAPI2_Buffer *buffer, bo_bool *new_data)
 Returns the flag for new data of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsQueued (BGAPI2_Buffer *buffer, bo_bool *is_queued)
 Returns the flag for queued buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsAcquiring (BGAPI2_Buffer *buffer, bo_bool *is_acquiring)
 Returns the flag for acquiring data of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsIncomplete (BGAPI2_Buffer *buffer, bo_bool *is_incomplete)
 Returns the flag for incomplete data of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetTLType (BGAPI2_Buffer *buffer, char *tl_type, bo_uint64 *string_length)
 Returns the transport layer of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetSizeFilled (BGAPI2_Buffer *buffer, bo_uint64 *size_filled)
 Returns the current size of data of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetWidth (BGAPI2_Buffer *buffer, bo_uint64 *width)
 Returns the width (in pixel) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetHeight (BGAPI2_Buffer *buffer, bo_uint64 *height)
 Returns height (in pixel) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetXOffset (BGAPI2_Buffer *buffer, bo_uint64 *offset_x)
 Returns x offset (in pixel) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetYOffset (BGAPI2_Buffer *buffer, bo_uint64 *offset_y)
 Returns y offset (in pixel) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetXPadding (BGAPI2_Buffer *buffer, bo_uint64 *padding_x)
 Returns x padding bytes (number of extra bytes in each line) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetYPadding (BGAPI2_Buffer *buffer, bo_uint64 *padding_y)
 Returns y padding bytes (number of extra bytes at image end) of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetFrameID (BGAPI2_Buffer *buffer, bo_uint64 *frame_id)
 Returns the frame identifier of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetImagePresent (BGAPI2_Buffer *buffer, bo_bool *image_present)
 Returns the flag for available image of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetImageOffset (BGAPI2_Buffer *buffer, bo_uint64 *image_offset)
 Returns the offset into buffer memory to begin of data of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetPayloadType (BGAPI2_Buffer *buffer, char *payload_type, bo_uint64 *string_length)
 Returns the payload type of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetPixelFormat (BGAPI2_Buffer *buffer, char *pixelformat, bo_uint64 *string_length)
 Returns the payload type of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetDeliveredImageHeight (BGAPI2_Buffer *buffer, bo_uint64 *delivered_image_height)
 Returns the delivered image height of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetDeliveredChunkPayloadSize (BGAPI2_Buffer *buffer, bo_uint64 *delivered_chunk_payload_size)
 Returns the delivered chunk payload size of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetContainsChunk (BGAPI2_Buffer *buffer, bo_bool *contains_chunk)
 Returns the flag to indicating existing chunk of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetChunkLayoutID (BGAPI2_Buffer *buffer, bo_uint64 *chunk_layout_id)
 Returns the chunk layout identifier size of buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetFileName (BGAPI2_Buffer *buffer, char *file_name, bo_uint64 *string_length)
 Returns the filename of buffer (only for payload type = file) More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetParent (BGAPI2_Buffer *buffer, BGAPI2_DataStream **parent)
 Returns the parent object (data stream) which belongs to. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_Open (BGAPI2_DataStream *data_stream)
 Opens a datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_Close (BGAPI2_DataStream *data_stream)
 Closes a datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_IsOpen (BGAPI2_DataStream *data_stream, bo_bool *is_open)
 Checks if the data stream is opened. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNode (BGAPI2_DataStream *data_stream, const char *name, BGAPI2_Node **node)
 Gets the named node of given datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNodeTree (BGAPI2_DataStream *data_stream, BGAPI2_NodeMap **node_tree)
 Gets the node tree of given datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNodeList (BGAPI2_DataStream *data_stream, BGAPI2_NodeMap **node_list)
 Gets the node list of given datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_SetNewBufferEventMode (BGAPI2_DataStream *data_stream, BGAPI2_EventMode event_mode)
 Sets the new buffer event mode. The event mode is controlled by the event register functions. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNewBufferEventMode (BGAPI2_DataStream *data_stream, BGAPI2_EventMode *event_mode)
 Returns the new buffer event mode. The event mode is controlled by the event register functions. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetID (BGAPI2_DataStream *data_stream, char *ID, bo_uint64 *string_length)
 Returns the identifier of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumDelivered (BGAPI2_DataStream *data_stream, bo_uint64 *num_delivered)
 Returns the number of delivered buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumUnderrun (BGAPI2_DataStream *data_stream, bo_uint64 *num_underrun)
 Returns the number of underrun buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumAnnounced (BGAPI2_DataStream *data_stream, bo_uint64 *num_announced)
 Returns the number of announced buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumQueued (BGAPI2_DataStream *data_stream, bo_uint64 *num_queued)
 Returns the number of queued buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumAwaitDelivery (BGAPI2_DataStream *data_stream, bo_uint64 *num_await_delivery)
 Returns the number of wait for delivery buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNumStarted (BGAPI2_DataStream *data_stream, bo_uint64 *num_started)
 Returns the number of currently filled buffer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetPayloadSize (BGAPI2_DataStream *data_stream, bo_uint64 *payload_size)
 Returns the size of the expected data block of this DataStream object in bytes. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetIsGrabbing (BGAPI2_DataStream *data_stream, bo_bool *is_grabbing)
 Returns the flag for started datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetDefinesPayloadSize (BGAPI2_DataStream *data_stream, bo_bool *defines_payload_size)
 Returns the size of the expecting data block of this DataStream object in bytes. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetTLType (BGAPI2_DataStream *data_stream, char *tl_type, bo_uint64 *string_length)
 Returns the transport layer of datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_StartAcquisition (BGAPI2_DataStream *data_stream, bo_uint64 num_to_acquire)
 Acquires a defined number of buffers from datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_StartAcquisitionContinuous (BGAPI2_DataStream *data_stream)
 Acquires buffers from datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_StopAcquisition (BGAPI2_DataStream *data_stream)
 Stop acquiring buffers from datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_AbortAcquisition (BGAPI2_DataStream *data_stream)
 Stops the DataStream immediately. Active transmissions are aborted. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_FlushInputToOutputQueue (BGAPI2_DataStream *data_stream)
 Moves all Buffer objects from the input buffer queue to the output buffer queue. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_FlushAllToInputQueue (BGAPI2_DataStream *data_stream)
 Moves all Buffers of the Buffer list to the input buffer queue even those in the output buffer queue. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_FlushUnqueuedToInputQueue (BGAPI2_DataStream *data_stream)
 Moves all free (not queued) Buffers of the Buffer list to the input buffer queue. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_DiscardOutputBuffers (BGAPI2_DataStream *data_stream)
 Discard all Buffer objects in the output buffer queue. The discarded Buffer objects are freed. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_DiscardAllBuffers (BGAPI2_DataStream *data_stream)
 Discard all Buffer objects in the input buffer queue and output buffer queue. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_AnnounceBuffer (BGAPI2_DataStream *data_stream, BGAPI2_Buffer *buffer)
 Adds the Buffer objects to the datastream. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_RevokeBuffer (BGAPI2_DataStream *data_stream, BGAPI2_Buffer *buffer, void **user_obj)
 Removes a Buffer object from the buffer list. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_QueueBuffer (BGAPI2_DataStream *data_stream, BGAPI2_Buffer *buffer)
 Moves a Buffer object into the input buffer queue and make it available for the image acquisition. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetFilledBuffer (BGAPI2_DataStream *data_stream, BGAPI2_Buffer **buffer, bo_uint64 timeout)
 Fetches a new image from the DataStream object and removes it from the output buffer queue. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_CancelGetFilledBuffer (BGAPI2_DataStream *data_stream)
 Cancels a currently running BGAPI2_DataStream_GetFilledBuffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetBufferID (BGAPI2_DataStream *data_stream, bo_uint index, BGAPI2_Buffer **buffer)
 Returns buffer from datastream with index number. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_RegisterNewBufferEventHandler (BGAPI2_DataStream *data_stream, void *callback_owner, BGAPI2_NewBufferEventHandler buffer_event_handler)
 Register a callback for datastream new buffer events. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetParent (BGAPI2_DataStream *data_stream, BGAPI2_Device **parent)
 Returns the parent object (device) which belongs to. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetWidth (BGAPI2_Image *image, bo_uint *width)
 Get the image width from given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetHeight (BGAPI2_Image *image, bo_uint *height)
 Get the image height from given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetPixelformat (BGAPI2_Image *image, char *pixelformat, bo_uint64 *string_length)
 Get the image pixelformat from given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetBuffer (BGAPI2_Image *image, void **buffer)
 Get the image pixel buffer from given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetTransformBufferLength (BGAPI2_Image *image, const char *pixelformat, bo_uint *buffer_size)
 Get the required image buffer size for new pixelformat of given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_Release (BGAPI2_Image *image)
 Release (delete) a given image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_Init (BGAPI2_Image *image, bo_uint width, bo_uint height, const char *pixelformat, void *buffer, bo_uint64 buffer_size)
 Initialize a given image with parameters. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNode (BGAPI2_Image *image, const char *name, BGAPI2_Node **node)
 Get the named node of given map of image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNodeTree (BGAPI2_Image *image, BGAPI2_NodeMap **node_tree)
 Get the node tree of the image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNodeList (BGAPI2_Image *image, BGAPI2_NodeMap **node_list)
 Get the node list of the image. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateImageProcessor (BGAPI2_ImageProcessor **img_proc)
 Creates an image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseImageProcessor (BGAPI2_ImageProcessor *img_proc)
 Release an image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetVersion (BGAPI2_ImageProcessor *img_proc, char *version, bo_uint64 *string_length)
 Get the version string of image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateEmptyImage (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image **image)
 Creates an empty image by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateImage (BGAPI2_ImageProcessor *img_proc, bo_uint width, bo_uint height, const char *pixelformat, void *buffer, bo_uint64 buffer_size, BGAPI2_Image **image)
 Creates an image by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateTransformedImage (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image *image_input, const char *pixelformat, BGAPI2_Image **image_result)
 Transformes an given image using the pixelformat using the image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_TransformImageToBuffer (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image *image, const char *pixelformat, void *buffer, bo_uint64 buffer_size)
 Creates an new image based on given image with new pixelformat by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNode (BGAPI2_ImageProcessor *img_proc, const char *name, BGAPI2_Node **node)
 Get the named node of given map of image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeTree (BGAPI2_ImageProcessor *img_proc, BGAPI2_NodeMap **node_tree)
 Get the node map of image processor as a tree. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeList (BGAPI2_ImageProcessor *img_proc, BGAPI2_NodeMap **node_list)
 Get the node map of image processor as a list. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_Create (BGAPI2_Polarizer **polarizer)
 Creates a polarizer object. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_Release (BGAPI2_Polarizer *polarizer)
 Release a polarizer object. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_Initialize (BGAPI2_Polarizer *polarizer, BGAPI2_Buffer *buffer)
 Initialize the Polarizer and provide the buffer with the raw polarized data for calculations. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_ReadCalibrationData (BGAPI2_Polarizer *polarizer, BGAPI2_Device *device)
 Get the calibration data and angle offset from the camera. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_EnableInterpolation (BGAPI2_Polarizer *polarizer, bo_bool interpolate)
 Keep output image the same size as the input buffer. The default is disabled. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_Enable (BGAPI2_Polarizer *polarizer, BGAPI2_POLARIZER_FORMATS format, bo_bool enable)
 Each component to be calculated must be enabled first. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_Get (BGAPI2_Polarizer *polarizer, BGAPI2_POLARIZER_FORMATS format, BGAPI2_Image *image)
 Get the calculated component (BGAPI_POLARIZER_AOP, etc.) from the buffer. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_GetFormatString (BGAPI2_Polarizer *polarizer, BGAPI2_POLARIZER_FORMATS format, char *format_string, bo_uint64 *size)
 Get the string of the polarization format. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Polarizer_SetMaxThreads (BGAPI2_Polarizer *polarizer, bo_uint number)
 Set the number of threads the Polarizer can use for calculations. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceEnable (bo_bool benable)
 Enable the BGAPI Trace. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputToFile (bo_bool bactive, const char *tracefilename)
 Activate the tracing to an outputfile. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputToDebugger (bo_bool bactive)
 Activate the tracing to the debugger. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateMaskError (bo_bool bactive)
 Trace errors. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateMaskWarning (bo_bool bactive)
 Trace warnings. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateMaskInformation (bo_bool bactive)
 Trace infos. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputOptionTimestamp (bo_bool bactive)
 Trace Timestamps. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputOptionTimestampDiff (bo_bool bactive)
 Trace Timestamp differences. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputOptionThreadID (bo_bool bactive)
 Trace the thread ID. More...
 
BGAPI2_C_DECL void BGAPI2CALL BGAPI2_TraceActivateOutputOptionPrefix (bo_bool bactive)
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_SetEnv (const char *producer_path)
 Sets the GENICAM_GENTL_PATHxx environment variable with given value. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetEnv (char *producer_path, bo_uint64 *string_length)
 Get the value of the GENICAM_GENTL_PATHxx environment variable. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetLastError (BGAPI2_RESULT *error_code, char *error_text, bo_uint64 *string_length)
 Returns a description of the last occurred error. More...
 

Detailed Description

Copyright 2014-2018 Baumer Optronic