Group CCameraList¶

Modules > CCameraList

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

Public Functions¶

Type	Name
	spinCameraListAppend (spinCameraList hCameraListBase, spinCameraList hCameraListToAppend)
	spinCameraListClear (spinCameraList hCameraList)
	spinCameraListCreateEmpty (spinCameraList * phCameraList)
	spinCameraListDestroy (spinCameraList hCameraList)
	spinCameraListGet (spinCameraList hCameraList, size_t index, spinCamera * phCamera)
	spinCameraListGetBySerial (spinCameraList hCameraList, const char * pSerial, spinCamera * phCamera)
	spinCameraListGetSize (spinCameraList hCameraList, size_t * pSize)
	spinCameraListRemove (spinCameraList hCameraList, size_t index)
	spinCameraListRemoveBySerial (spinCameraList hCameraList, const char * pSerial)

Public Functions Documentation¶

function spinCameraListAppend¶

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

function spinCameraListClear¶

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

function spinCameraListCreateEmpty¶

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

function spinCameraListDestroy¶

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

function spinCameraListGet¶

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

function spinCameraListGetBySerial¶

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

function spinCameraListGetSize¶

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

function spinCameraListRemove¶

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

function spinCameraListRemoveBySerial¶

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