The functions in this section provide access to information, objects, and functionality of cameras. This includes nodemap retrieval, acquisition and init commands, event handler registration, and camera property retrieval. More...
Functions | |
| SPINNAKERC_API | spinCameraInit (spinCamera hCamera) |
| Initializes a camera, allowing for much more interaction. More... | |
| SPINNAKERC_API | spinCameraDeInit (spinCamera hCamera) |
| Deinitializes a camera, greatly reducing functionality. More... | |
| SPINNAKERC_API | spinCameraGetNodeMap (spinCamera hCamera, spinNodeMapHandle *phNodeMap) |
| Retrieves the GenICam nodemap from a camera. More... | |
| SPINNAKERC_API | spinCameraGetTLDeviceNodeMap (spinCamera hCamera, spinNodeMapHandle *phNodeMap) |
| Retrieves the transport layer device nodemap from a camera. More... | |
| SPINNAKERC_API | spinCameraGetTLStreamNodeMap (spinCamera hCamera, spinNodeMapHandle *phNodeMap) |
| Retrieves the transport layer stream nodemap from a camera. More... | |
| SPINNAKERC_API | spinCameraGetAccessMode (spinCamera hCamera, spinAccessMode *pAccessMode) |
| Retrieves the access mode of a camera (as an enum, spinAccessMode) More... | |
| SPINNAKERC_API | spinCameraReadPort (spinCamera hCamera, uint64_t iAddress, void *pBuffer, size_t iSize) |
| SPINNAKERC_API | spinCameraWritePort (spinCamera hCamera, uint64_t iAddress, void *pBuffer, size_t iSize) |
| SPINNAKERC_API | spinCameraBeginAcquisition (spinCamera hCamera) |
| Has a camera start acquiring images. More... | |
| SPINNAKERC_API | spinCameraEndAcquisition (spinCamera hCamera) |
| Has a camera stop acquiring images. More... | |
| SPINNAKERC_API | spinCameraGetNextImage (spinCamera hCamera, spinImage *phImage) |
| Retrieves an image from a camera. More... | |
| SPINNAKERC_API | spinCameraGetNextImageEx (spinCamera hCamera, uint64_t grabTimeout, spinImage *phImage) |
| Retrieves an image from a camera; manually set the timeout in milliseconds. More... | |
| SPINNAKERC_API | spinCameraGetNextImageSync (spinCamera hCamera, uint64_t grabTimeout, spinImageList *phImageList) |
| If a camera supports one or more streams, this function gets one image from each of the camera's streams, and returns the images in a list. More... | |
| SPINNAKERC_API | spinCameraGetDeviceID (spinCamera hCamera, char *pBuf, size_t *pBufLen) |
| Retrieves a unique identifier for a camera. More... | |
| SPINNAKERC_API | spinCameraGetDeviceSerialNumber (spinCamera hCamera, char *pBuf, size_t *pBufLen) |
| Retrieves a manufacturer specific serial number that identifies the camera. More... | |
| SPINNAKERC_API_DEPRECATED ("Use spinCameraGetDeviceID() instead.", spinCameraGetUniqueID(spinCamera hCamera, char *pBuf, size_t *pBufLen);) SPINNAKERC_API spinCameraIsStreaming(spinCamera hCamera | |
| Retrieves a unique identifier for a camera. More... | |
| SPINNAKERC_API | spinCameraGetGuiXml (spinCamera hCamera, char *pBuf, size_t *pBufLen) |
| Retrieves the GUI XML from a camera. More... | |
| SPINNAKERC_API_DEPRECATED ("Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead.", spinCameraRegisterDeviceEventHandler(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler)) | |
| Registers a universal device event handler (every device event type) to a camera. More... | |
| SPINNAKERC_API_DEPRECATED ("Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead.", spinCameraRegisterDeviceEventHandlerEx(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler, const char *pName)) | |
| Registers a specific device event handler (only one device event type) to a camera. More... | |
| SPINNAKERC_API_DEPRECATED ("Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead.", spinCameraUnregisterDeviceEventHandler(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler)) | |
| Unregisters a device event handler from a camera. More... | |
| SPINNAKERC_API | spinCameraRegisterImageEventHandler (spinCamera hCamera, spinImageEventHandler hImageEventHandler) |
| Registers an image event handler to a camera. More... | |
| SPINNAKERC_API | spinCameraRegisterImageEventHandlerEx (spinCamera hCamera, spinImageEventHandler hImageEventHandler, uint64_t streamIndex) |
| Registers an image event handler to a camera Registers a specific stream handler for the camera given a stream index. More... | |
| SPINNAKERC_API | spinCameraUnregisterImageEventHandler (spinCamera hCamera, spinImageEventHandler hImageEventHandler) |
| Unregisters an image event handler from a camera. More... | |
| SPINNAKERC_API | spinCameraRegisterImageListEventHandler (spinCamera hCamera, spinImageListEventHandler hImageListEventHandler) |
| Registers an image list event handler to a camera. More... | |
| SPINNAKERC_API | spinCameraUnregisterImageListEventHandler (spinCamera hCamera, spinImageListEventHandler hImageListEventHandler) |
| Unregisters an image list event handler from a camera. More... | |
| SPINNAKERC_API | spinCameraRelease (spinCamera hCamera) |
| Releases a camera. More... | |
| SPINNAKERC_API | spinCameraIsValid (spinCamera hCamera, bool8_t *pbValid) |
| Checks whether a camera is still valid for use. More... | |
| SPINNAKERC_API | spinCameraIsInitialized (spinCamera hCamera, bool8_t *pbInit) |
| Checks whether a camera is currently initialized. More... | |
Variables | |
| bool8_t * | pbIsStreaming |
The functions in this section provide access to information, objects, and functionality of cameras. This includes nodemap retrieval, acquisition and init commands, event handler registration, and camera property retrieval.
| SPINNAKERC_API spinCameraBeginAcquisition | ( | spinCamera | hCamera | ) |
Has a camera start acquiring images.
| hCamera | The camera to begin acquiring images |
| SPINNAKERC_API spinCameraDeInit | ( | spinCamera | hCamera | ) |
Deinitializes a camera, greatly reducing functionality.
| hCamera | The camera to deinitialize |
| SPINNAKERC_API spinCameraEndAcquisition | ( | spinCamera | hCamera | ) |
Has a camera stop acquiring images.
| hCamera | The camera to stop acquiring images |
| SPINNAKERC_API spinCameraGetAccessMode | ( | spinCamera | hCamera, |
| spinAccessMode * | pAccessMode | ||
| ) |
Retrieves the access mode of a camera (as an enum, spinAccessMode)
| hCamera | The camera of the access mode to retrieve |
| pAccessMode | The access mode enum pointer in which the access mode is returned |
| SPINNAKERC_API spinCameraGetDeviceID | ( | spinCamera | hCamera, |
| char * | pBuf, | ||
| size_t * | pBufLen | ||
| ) |
Retrieves a unique identifier for a camera.
| hCamera | The camera of the unique identifier |
| pBuf | The c-string character buffer in which the unique identifier is returned |
| pBufLen | The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length |
| SPINNAKERC_API spinCameraGetDeviceSerialNumber | ( | spinCamera | hCamera, |
| char * | pBuf, | ||
| size_t * | pBufLen | ||
| ) |
Retrieves a manufacturer specific serial number that identifies the camera.
| hCamera | The camera handle identified by the serial number |
| pBuf | The c-string character buffer in which the device serial number is returned |
| pBufLen | The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length |
| SPINNAKERC_API spinCameraGetGuiXml | ( | spinCamera | hCamera, |
| char * | pBuf, | ||
| size_t * | pBufLen | ||
| ) |
Retrieves the GUI XML from a camera.
| hCamera | The camera of the GUI XML to retrieve |
| pBuf | The c-string character buffer in which the GUI XML is returned |
| pBufLen | The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length |
| SPINNAKERC_API spinCameraGetNextImage | ( | spinCamera | hCamera, |
| spinImage * | phImage | ||
| ) |
Retrieves an image from a camera.
| hCamera | The camera of the image to retrieve |
| phImage | The image handle pointer in which the image is returned |
| SPINNAKERC_API spinCameraGetNextImageEx | ( | spinCamera | hCamera, |
| uint64_t | grabTimeout, | ||
| spinImage * | phImage | ||
| ) |
Retrieves an image from a camera; manually set the timeout in milliseconds.
| hCamera | The camera of the image to retrieve |
| grabTimeout | A 64bit value that represents a timeout in milliseconds |
| phImage | The image handle pointer in which the image is returned |
| SPINNAKERC_API spinCameraGetNextImageSync | ( | spinCamera | hCamera, |
| uint64_t | grabTimeout, | ||
| spinImageList * | phImageList | ||
| ) |
If a camera supports one or more streams, this function gets one image from each of the camera's streams, and returns the images in a list.
This function will block for the specified timeout period until an image arrives on all the streams.
| hCamera | The camera of the image to retrieve |
| grabTimeout | A 64bit value that represents a timeout in milliseconds |
| SPINNAKERC_API spinCameraGetNodeMap | ( | spinCamera | hCamera, |
| spinNodeMapHandle * | phNodeMap | ||
| ) |
Retrieves the GenICam nodemap from a camera.
| hCamera | The camera from which the nodemap is retrieved |
| phNodeMap | The nodemap handle pointer in which the nodemap is returned |
| SPINNAKERC_API spinCameraGetTLDeviceNodeMap | ( | spinCamera | hCamera, |
| spinNodeMapHandle * | phNodeMap | ||
| ) |
Retrieves the transport layer device nodemap from a camera.
| hCamera | The camera from which the transport layer device nodemap is retrieved |
| phNodeMap | The nodemap handle pointer in which the nodemap is returned |
| SPINNAKERC_API spinCameraGetTLStreamNodeMap | ( | spinCamera | hCamera, |
| spinNodeMapHandle * | phNodeMap | ||
| ) |
Retrieves the transport layer stream nodemap from a camera.
| hCamera | The camera from which the transport layer streaming nodemap is retrieved |
| phNodeMap | The nodemap handle pointer in which the nodemap is returned |
| SPINNAKERC_API spinCameraInit | ( | spinCamera | hCamera | ) |
Initializes a camera, allowing for much more interaction.
| hCamera | The camera to initialize |
| SPINNAKERC_API spinCameraIsInitialized | ( | spinCamera | hCamera, |
| bool8_t * | pbInit | ||
| ) |
Checks whether a camera is currently initialized.
| hCamera | The camera to check |
| pbInit | The boolean pointer to return whether or not the camera is initialized |
| SPINNAKERC_API spinCameraIsValid | ( | spinCamera | hCamera, |
| bool8_t * | pbValid | ||
| ) |
Checks whether a camera is still valid for use.
| hCamera | The camera to check |
| pbValid | The boolean pointer to return whether or not the camera is valid |
| SPINNAKERC_API spinCameraReadPort | ( | spinCamera | hCamera, |
| uint64_t | iAddress, | ||
| void * | pBuffer, | ||
| size_t | iSize | ||
| ) |
| SPINNAKERC_API spinCameraRegisterImageEventHandler | ( | spinCamera | hCamera, |
| spinImageEventHandler | hImageEventHandler | ||
| ) |
Registers an image event handler to a camera.
| hCamera | The camera on which to register the image event handler |
| hImageEventHandler | The image event handler to register |
| SPINNAKERC_API spinCameraRegisterImageEventHandlerEx | ( | spinCamera | hCamera, |
| spinImageEventHandler | hImageEventHandler, | ||
| uint64_t | streamIndex | ||
| ) |
Registers an image event handler to a camera Registers a specific stream handler for the camera given a stream index.
The camera has to be initialized first with a call to spinCameraInit() before registering handlers for events.
| hCamera | The camera on which to register the image event handler |
| hImageEventHandler | The image event handler to register |
| streamIndex | The index of the stream of where this handler will be registered to |
| SPINNAKERC_API spinCameraRegisterImageListEventHandler | ( | spinCamera | hCamera, |
| spinImageListEventHandler | hImageListEventHandler | ||
| ) |
Registers an image list event handler to a camera.
| hCamera | The camera on which to register the image event handler |
| hImageListEventHandler | The image list event handler to register |
| SPINNAKERC_API spinCameraRelease | ( | spinCamera | hCamera | ) |
Releases a camera.
| hCamera | The camera to release |
| SPINNAKERC_API spinCameraUnregisterImageEventHandler | ( | spinCamera | hCamera, |
| spinImageEventHandler | hImageEventHandler | ||
| ) |
Unregisters an image event handler from a camera.
| hCamera | The camera from which to unregister the image event handler |
| hImageEventHandler | The image event handler to unregister |
| SPINNAKERC_API spinCameraUnregisterImageListEventHandler | ( | spinCamera | hCamera, |
| spinImageListEventHandler | hImageListEventHandler | ||
| ) |
Unregisters an image list event handler from a camera.
| hCamera | The camera from which to unregister the image event handler |
| hImageEventHandler | The image event handler to unregister |
| SPINNAKERC_API spinCameraWritePort | ( | spinCamera | hCamera, |
| uint64_t | iAddress, | ||
| void * | pBuffer, | ||
| size_t | iSize | ||
| ) |
| SPINNAKERC_API_DEPRECATED | ( | "Use spinCameraGetDeviceID() instead." | , |
| spinCameraGetUniqueID(spinCamera hCamera, char *pBuf, size_t *pBufLen); | |||
| ) |
Retrieves a unique identifier for a camera.
| hCamera | The camera of the unique identifier |
| pBuf | The c-string character buffer in which the unique identifier is returned |
| pBufLen | The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length |
| hCamera | The camera to check |
| pbIsStreaming | The boolean pointer to return whether or not the camera is currently streaming |
| SPINNAKERC_API_DEPRECATED | ( | "Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead." | , |
| spinCameraRegisterDeviceEventHandler(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler) | |||
| ) |
Registers a universal device event handler (every device event type) to a camera.
| hCamera | The camera on which to register the universal device event handler |
| hDeviceEventHandler | The device event handler to register |
| SPINNAKERC_API_DEPRECATED | ( | "Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead." | , |
| spinCameraRegisterDeviceEventHandlerEx(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler, const char *pName) | |||
| ) |
Registers a specific device event handler (only one device event type) to a camera.
| hCamera | The camera on which to register the specific device event handler |
| hDeviceEventHandler | The device event handler to register |
| pName | The name of the device event handler to register |
| SPINNAKERC_API_DEPRECATED | ( | "Use spinNodeRegisterCallback() and spinNodeDeregisterCallback() for handling device node callbacks instead." | , |
| spinCameraUnregisterDeviceEventHandler(spinCamera hCamera, spinDeviceEventHandler hDeviceEventHandler) | |||
| ) |
Unregisters a device event handler from a camera.
| hCamera | The camera from which to unregister the device event handler |
| hDeviceEventHandler | The device event handler to unregister |
| bool8_t* pbIsStreaming |