The functions in this section provide access to information, objects, and functionality of camera lists. This includes updating, size and camera retrieval, and clearance. More...

Functions
SPINNAKERC_API	spinCameraListCreateEmpty (spinCameraList *phCameraList)
	Creates an empty camera list (camera lists created this way must be destroyed) More...

SPINNAKERC_API	spinCameraListDestroy (spinCameraList hCameraList)
	Destroys a camera list. More...

SPINNAKERC_API	spinCameraListGetSize (spinCameraList hCameraList, size_t *pSize)
	Retrieves the number of cameras on a camera list. More...

SPINNAKERC_API	spinCameraListGet (spinCameraList hCameraList, size_t index, spinCamera *phCamera)
	Retrieves a camera from a camera list using an index. More...

SPINNAKERC_API	spinCameraListClear (spinCameraList hCameraList)
	Clears a camera list. More...

SPINNAKERC_API	spinCameraListRemove (spinCameraList hCameraList, size_t index)
	Removes a camera from a camera list using its index. More...

SPINNAKERC_API	spinCameraListAppend (spinCameraList hCameraListBase, spinCameraList hCameraListToAppend)
	Appends all the cameras from one camera list to another. More...

SPINNAKERC_API	spinCameraListGetBySerial (spinCameraList hCameraList, const char pSerial, spinCamera phCamera)
	Retrieves a camera from a camera list using its serial number. More...

SPINNAKERC_API	spinCameraListRemoveBySerial (spinCameraList hCameraList, const char *pSerial)
	Removes a camera from a camera list using its serial number. More...

Detailed Description

The functions in this section provide access to information, objects, and functionality of camera lists. This includes updating, size and camera retrieval, and clearance.

Function Documentation

◆ spinCameraListAppend()

SPINNAKERC_API spinCameraListAppend	(	spinCameraList	hCameraListBase,
		spinCameraList	hCameraListToAppend
	)

Appends all the cameras from one camera list to another.

See also: spinError

Parameters

hCameraListBase	The camera list to receive the other
hCameraListToAppend	The camera list to add to the other

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinCameraListClear()

SPINNAKERC_API spinCameraListClear ( spinCameraList hCameraList )

Clears a camera list.

See also: spinError

Parameters

hCameraList The camera list to clear

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCameraListCreateEmpty()

SPINNAKERC_API spinCameraListCreateEmpty ( spinCameraList * phCameraList )

Creates an empty camera list (camera lists created this way must be destroyed)

See also: spinError

Parameters

phCameraList The camera list handle pointer in which the empty camera list is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCameraListDestroy()

SPINNAKERC_API spinCameraListDestroy ( spinCameraList hCameraList )

Destroys a camera list.

See also: spinError

Parameters

hCameraList The camera list to destroy

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCameraListGet()

SPINNAKERC_API spinCameraListGet	(	spinCameraList	hCameraList,
		size_t	index,
		spinCamera *	phCamera
	)

Retrieves a camera from a camera list using an index.

This function will return a SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

See also: spinError

Parameters

hCameraList	The camera list of the camera to retrieve
index	The index of the camera
phCamera	The camera handle pointer in which the camera is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCameraListGetBySerial()

SPINNAKERC_API spinCameraListGetBySerial	(	spinCameraList	hCameraList,
		const char *	pSerial,
		spinCamera *	phCamera
	)

Retrieves a camera from a camera list using its serial number.

This function will return a NULL spinCamera pointer if no matching camera serial is found.

See also: spinError

Parameters

hCameraList	The camera list of the camera to retrieve
serial	The serial number of the camera to retrieve
phCamera	The camera handle pointer in which the camera is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinCameraListGetSize()

SPINNAKERC_API spinCameraListGetSize	(	spinCameraList	hCameraList,
		size_t *	pSize
	)

Retrieves the number of cameras on a camera list.

See also: spinError

Parameters

hCameraList	The camera list where the cameras to be counted are
pSize	The unsigned integer pointer in which the number of cameras is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCameraListRemove()

SPINNAKERC_API spinCameraListRemove	(	spinCameraList	hCameraList,
		size_t	index
	)

Removes a camera from a camera list using its index.

See also: spinError

Parameters

hCameraList	The camera list of the camera to remove
index	The index of the camera to remove

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinCameraListRemoveBySerial()

SPINNAKERC_API spinCameraListRemoveBySerial	(	spinCameraList	hCameraList,
		const char *	pSerial
	)

Removes a camera from a camera list using its serial number.

See also: spinError

Parameters

hCameraList	The camera list of the camera to remove
pSerial	The serial number of the camera to remove

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Functions

Detailed Description

Function Documentation

◆ spinCameraListAppend()

◆ spinCameraListClear()

◆ spinCameraListCreateEmpty()

◆ spinCameraListDestroy()

◆ spinCameraListGet()

◆ spinCameraListGetBySerial()

◆ spinCameraListGetSize()

◆ spinCameraListRemove()

◆ spinCameraListRemoveBySerial()