Data Structures
struct	peak_frame_info
	peak Frame info More...

Enumerations
enum	peak_frame_type { PEAK_FRAME_TYPE_INVALID , PEAK_FRAME_TYPE_IMAGE }
	peak Frame type More...

Functions
peak_status	peak_Frame_GetInfo (peak_frame_handle hFrame, peak_frame_info *frameInfo)
	Query the frame info.
peak_status	peak_Frame_Type_Get (peak_frame_handle hFrame, peak_frame_type *frameType)
	Query the type of a frame.
peak_status	peak_Frame_Buffer_Get (peak_frame_handle hFrame, peak_buffer *buffer)
	Query the buffer of a frame.
peak_status	peak_Frame_ID_Get (peak_frame_handle hFrame, uint64_t *frameID)
	Query the frame id of a frame.
peak_status	peak_Frame_Timestamp_Get (peak_frame_handle hFrame, uint64_t *timestamp_ns)
	Query the timestamp of a frame.
peak_status	peak_Frame_ROI_Get (peak_frame_handle hFrame, peak_roi *roi)
	Query the size parameters of a frame.
peak_status	peak_Frame_PixelFormat_Get (peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
	Query the pixel format of a frame.
peak_bool	peak_Frame_IsComplete (peak_frame_handle hFrame)
	Check whether the frame is complete.
peak_status	peak_Frame_BytesExpected_Get (peak_frame_handle hFrame, size_t *bytesExpected)
	Query the bytes expected for a complete image.
peak_status	peak_Frame_BytesWritten_Get (peak_frame_handle hFrame, size_t *bytesWritten)
	Query the bytes written to the buffer of a frame.
peak_status	peak_Frame_ProcessingTime_Get (peak_frame_handle hFrame, uint32_t *processingTime_ms)
	Query the processing time of a frame.
peak_bool	peak_Frame_HasChunks (peak_frame_handle hFrame)
	Check whether the frame has chunk data.

Detailed Description

Frame info related functions and types.

Enumeration Type Documentation

◆ peak_frame_type

enum peak_frame_type

peak Frame type

The type and format of the contents of a received frame.

Enumerator

PEAK_FRAME_TYPE_INVALID

Invalid frame type.

Use this value for the initialization of variables of type peak_frame_type.

PEAK_FRAME_TYPE_IMAGE

Image data.

The frame contains image data, i.e. an ordered sequence of image pixels beginning at the first pixel of the image.

Function Documentation

◆ peak_Frame_Buffer_Get()

peak_status peak_Frame_Buffer_Get	(	peak_frame_handle	hFrame,
		peak_buffer *	buffer )

Query the buffer of a frame.

Provides the memory buffer that stores the contents of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	buffer	The buffer.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER buffer is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_BytesExpected_Get()

peak_status peak_Frame_BytesExpected_Get	(	peak_frame_handle	hFrame,
		size_t *	bytesExpected )

Query the bytes expected for a complete image.

Provides the bytes expected for a complete image.

Parameters

[in]	hFrame	The frame handle.
[out]	bytesExpected	The bytes expected for a complete image.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER bytesExpected is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_BytesWritten_Get()

peak_status peak_Frame_BytesWritten_Get	(	peak_frame_handle	hFrame,
		size_t *	bytesWritten )

Query the bytes written to the buffer of a frame.

Provides the bytes written to the buffer of a frame.

Parameters

[in]	hFrame	The frame handle.
[out]	bytesWritten	The bytes written.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER bytesWritten is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_GetInfo()

peak_status peak_Frame_GetInfo	(	peak_frame_handle	hFrame,
		peak_frame_info *	frameInfo )

Query the frame info.

Provides the frame info data of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	frameInfo	The frame info.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER frameInfo is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_HasChunks()

peak_bool peak_Frame_HasChunks ( peak_frame_handle hFrame )

Check whether the frame has chunk data.

If true, it can be processed by the Chunks feature.

Parameters

[in] hFrame The frame handle.

Returns: PEAK_TRUE The frame has chunk data.; PEAK_FALSE The frame has no chunk data or the query failed.

Since: 1.13

◆ peak_Frame_ID_Get()

peak_status peak_Frame_ID_Get	(	peak_frame_handle	hFrame,
		uint64_t *	frameID )

Query the frame id of a frame.

Provides the frame id of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	frameID	The frame id.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER frameID is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_IsComplete()

peak_bool peak_Frame_IsComplete ( peak_frame_handle hFrame )

Check whether the frame is complete.

Checks whether the frame was completely transmitted from the camera to the host.

See also: Incomplete Frame

This function implements the Valid Values Organization Query principle.

Parameters

[in] hFrame The frame handle.

Returns: PEAK_TRUE The frame is complete.; PEAK_FALSE The frame is incomplete or the query failed.

Since: 1.0

◆ peak_Frame_PixelFormat_Get()

peak_status peak_Frame_PixelFormat_Get	(	peak_frame_handle	hFrame,
		peak_pixel_format *	pixelFormat )

Query the pixel format of a frame.

Provides the pixel format of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	pixelFormat	The pixel format.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER pixelFormat is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_ProcessingTime_Get()

peak_status peak_Frame_ProcessingTime_Get	(	peak_frame_handle	hFrame,
		uint32_t *	processingTime_ms )

Query the processing time of a frame.

Provides the host side processing time of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	processingTime_ms	The processing time in milliseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER processingTime_ms is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_ROI_Get()

peak_status peak_Frame_ROI_Get	(	peak_frame_handle	hFrame,
		peak_roi *	roi )

Query the size parameters of a frame.

Provides the image size parameters of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	roi	The ROI.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER roi is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_Timestamp_Get()

peak_status peak_Frame_Timestamp_Get	(	peak_frame_handle	hFrame,
		uint64_t *	timestamp_ns )

Query the timestamp of a frame.

Provides the timestamp of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	timestamp_ns	The timestamp in nanoseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER timestamp is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

◆ peak_Frame_Type_Get()

peak_status peak_Frame_Type_Get	(	peak_frame_handle	hFrame,
		peak_frame_type *	frameType )

Query the type of a frame.

Provides the type of the specified frame.

Parameters

[in]	hFrame	The frame handle.
[out]	frameType	The frame type.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER frameType is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hFrame is an invalid frame handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.0

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_frame_type

Function Documentation

◆ peak_Frame_Buffer_Get()

◆ peak_Frame_BytesExpected_Get()

◆ peak_Frame_BytesWritten_Get()

◆ peak_Frame_GetInfo()

◆ peak_Frame_HasChunks()

◆ peak_Frame_ID_Get()

◆ peak_Frame_IsComplete()

◆ peak_Frame_PixelFormat_Get()

◆ peak_Frame_ProcessingTime_Get()

◆ peak_Frame_ROI_Get()

◆ peak_Frame_Timestamp_Get()

◆ peak_Frame_Type_Get()