BGAPI2 DataStream Functions

Functions related to the GenICam DataStream of each device. More...

Typedefs

typedef struct BGAPI2_DataStream BGAPI2_DataStream
 Struct for pointers of type DataStream. More...
 

Functions

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...
 

Detailed Description

Functions related to the GenICam DataStream of each device.

Typedef Documentation

◆ BGAPI2_DataStream

Struct for pointers of type DataStream.

Function Documentation

◆ BGAPI2_DataStream_Open()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_Open ( BGAPI2_DataStream data_stream)

Opens a datastream.

Parameters
[in]data_streamPointer to the DataStream created with BGAPI2_Device_GetDataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error (init failed)
BGAPI2_RESULT_NOT_INITIALIZEDProducer not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORCan't read producer interface infos
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_Device_GetDataStream

◆ BGAPI2_DataStream_Close()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_Close ( BGAPI2_DataStream data_stream)

Closes a datastream.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error (init failed, data stream not opened)
BGAPI2_RESULT_NOT_INITIALIZEDProducer not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_IsOpen()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_IsOpen ( BGAPI2_DataStream data_stream,
bo_bool *  is_open 
)

Checks if the data stream is opened.

Parameters
[in]data_streamPointer to the DataStream
[out]is_openPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_INITIALIZEDProducer not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNode()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]nameNode name
[out]nodePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNodeTree()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNodeTree ( BGAPI2_DataStream data_stream,
BGAPI2_NodeMap **  node_tree 
)

Gets the node tree of given datastream.

Parameters
[in]data_streamPointer to the DataStream
[out]node_treePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNodeList()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetNodeList ( BGAPI2_DataStream data_stream,
BGAPI2_NodeMap **  node_list 
)

Gets the node list of given datastream.

Parameters
[in]data_streamPointer to the DataStream
[out]node_listNode map
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_SetNewBufferEventMode()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]event_modeEvent mode for new buffer events of datastream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_EventMode

◆ BGAPI2_DataStream_GetNewBufferEventMode()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]event_modePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetID()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetID ( BGAPI2_DataStream data_stream,
char *  ID,
bo_uint64 *  string_length 
)

Returns the identifier of datastream.

Parameters
[in]data_streamPointer to the DataStream
[in,out]IDNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumDelivered()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_deliveredPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumUnderrun()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_underrunPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumAnnounced()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_announcedPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumQueued()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_queuedPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumAwaitDelivery()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_await_deliveryPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetNumStarted()

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.

Parameters
[in]data_streamPointer to the DataStream
[out]num_startedPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetPayloadSize()

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.

Based on the current device settings and including all control data (e.g. chunk header). This function is mainly used for devices which supports several data streams to allow stream based memory allocation

Parameters
[in]data_streamPointer to the DataStream
[out]payload_sizePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetIsGrabbing()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetIsGrabbing ( BGAPI2_DataStream data_stream,
bo_bool *  is_grabbing 
)

Returns the flag for started datastream.

Parameters
[in]data_streamPointer to the DataStream
[out]is_grabbingPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetDefinesPayloadSize()

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.

Based on the current device settings and including all control data (e.g. chunk header). This function is mainly used for devices which supports several data streams to allow stream based memory allocation

Parameters
[in]data_streamPointer to the DataStream
[out]defines_payload_sizePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORInternal error, not producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetTLType()

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.

Parameters
[in]data_streamPointer to the DataStream
[in,out]tl_typeNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_StartAcquisition()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]num_to_acquireNumber of buffer to acquire
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_StartAcquisitionContinuous()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_StartAcquisitionContinuous ( BGAPI2_DataStream data_stream)

Acquires buffers from datastream.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_StopAcquisition()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_StopAcquisition ( BGAPI2_DataStream data_stream)

Stop acquiring buffers from datastream.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_AbortAcquisition()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_AbortAcquisition ( BGAPI2_DataStream data_stream)

Stops the DataStream immediately. Active transmissions are aborted.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_Buffer_GetIsIncomplete

◆ BGAPI2_DataStream_FlushInputToOutputQueue()

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.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_Buffer_QueueBuffer
BGAPI2_DataStream_GetFilledBuffer

◆ BGAPI2_DataStream_FlushAllToInputQueue()

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.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_Buffer_QueueBuffer
BGAPI2_DataStream_GetFilledBuffer

◆ BGAPI2_DataStream_FlushUnqueuedToInputQueue()

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.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
See also
BGAPI2_Buffer_QueueBuffer

◆ BGAPI2_DataStream_DiscardOutputBuffers()

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.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_DiscardAllBuffers()

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.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_AnnounceBuffer()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_AnnounceBuffer ( BGAPI2_DataStream data_stream,
BGAPI2_Buffer buffer 
)

Adds the Buffer objects to the datastream.

Parameters
[in]data_streamPointer to the DataStream
[in]bufferPointer to buffer to announce
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_RevokeBuffer()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]bufferPointer to buffer to revoke
[out]user_obj
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_QueueBuffer()

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.

If the image aquisition is done the filled Buffer object is moved into the output buffer queue and is fetched with function BGAPI2_DataStream_GetFilledBuffer. See also the functions of the BufferList, to move the Buffer object between the internal lists

Parameters
[in]data_streamPointer to the DataStream
[in]bufferPointer to buffer to queue
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetFilledBuffer()

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.

If the output buffer queue is empty after the timeout, the function delivers NULL

Parameters
[in]data_streamPointer to the DataStream
[in]bufferPointer to buffer to queue
[in]timeoutTimeout to stop if no image is delivered from the camera, -1 means indefinitely
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_TIMEOUTNo buffer filled in iTimeout
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_CancelGetFilledBuffer()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_CancelGetFilledBuffer ( BGAPI2_DataStream data_stream)

Cancels a currently running BGAPI2_DataStream_GetFilledBuffer.

Parameters
[in]data_streamPointer to the DataStream
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_GetBufferID()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]indexThe ID for the buffer to be returned
[out]bufferPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_LOWLEVEL_ERRORInternal error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_DataStream_RegisterNewBufferEventHandler()

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.

Parameters
[in]data_streamPointer to the DataStream
[in]callback_ownerData, context pointer for use in callback function
[in]buffer_event_handlerAddress of function from type BGAPI2_NewBufferEventHandler
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError, no producer loaded
BGAPI2_RESULT_NOT_INITIALIZEDError, datastream is not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
Todo:
What is that???

◆ BGAPI2_DataStream_GetParent()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DataStream_GetParent ( BGAPI2_DataStream data_stream,
BGAPI2_Device **  parent 
)

Returns the parent object (device) which belongs to.

Parameters
[in]data_streamPointer to the DataStream
[out]parentPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters