Spinnaker C
4.3.0.189
 
Functions | Variables
SpinnakerC.h File Reference

Functions

SPINNAKERC_API spinErrorGetLast (spinError *pError)
 Retrieves the error code of the last error. More...
 
SPINNAKERC_API spinErrorGetLastMessage (char *pBuf, size_t *pBufLen)
 Retrieves the error message of the last error. More...
 
SPINNAKERC_API spinErrorGetLastBuildDate (char *pBuf, size_t *pBufLen)
 Retrieves the build date of the last error. More...
 
SPINNAKERC_API spinErrorGetLastBuildTime (char *pBuf, size_t *pBufLen)
 Retrieves the build time of the last error. More...
 
SPINNAKERC_API spinErrorGetLastFileName (char *pBuf, size_t *pBufLen)
 Retrieves the filename of the last error. More...
 
SPINNAKERC_API spinErrorGetLastFullMessage (char *pBuf, size_t *pBufLen)
 Retrieves the full error message of the last error. More...
 
SPINNAKERC_API spinErrorGetLastFunctionName (char *pBuf, size_t *pBufLen)
 Retrieves the function name of the last error. More...
 
SPINNAKERC_API spinErrorGetLastLineNumber (int64_t *pLineNum)
 Retrieves the line number of the last error. More...
 
SPINNAKERC_API spinSystemGetInstance (spinSystem *phSystem)
 Retrieves an instance of the system object; the system is a singleton, so there will only ever be one instance; system instance must be destroyed by calling spinSystemReleaseInstance. More...
 
SPINNAKERC_API spinSystemReleaseInstance (spinSystem hSystem)
 Releases the system; make sure handle is cleaned up properly by setting it to NULL after system is released; the handle can only be used again after calling spinSystemGetInstance. More...
 
SPINNAKERC_API spinSystemGetInterfaces (spinSystem hSystem, spinInterfaceList hInterfaceList)
 Retrieves a list of detected (and enumerable) interfaces on the system; interface lists must be created and destroyed. More...
 
SPINNAKERC_API spinSystemGetCameras (spinSystem hSystem, spinCameraList hCameraList)
 Retrieves a list of detected (and enumerable) cameras on the system; camera lists must be created and destroyed. More...
 
SPINNAKERC_API spinSystemGetCamerasEx (spinSystem hSystem, bool8_t bUpdateInterfaces, bool8_t bUpdateCameras, spinCameraList hCameraList)
 Retrieves a list of detected (and enumerable) cameras on the system; manually set whether to update the current interface and camera lists; camera lists must be created and destroyed. More...
 
SPINNAKERC_API spinSystemSetLoggingLevel (spinSystem hSystem, spinnakerLogLevel logLevel)
 Sets the logging level for all logging events on the system. More...
 
SPINNAKERC_API spinSystemGetLoggingLevel (spinSystem hSystem, spinnakerLogLevel *pLogLevel)
 Retrieves the logging level for all logging events on the system. More...
 
SPINNAKERC_API spinSystemRegisterLogEventHandler (spinSystem hSystem, spinLogEventHandler hLogEventHandler)
 Registers a logging event handler to the system (event handlers registered in this way must be unregistered) More...
 
SPINNAKERC_API spinSystemUnregisterLogEventHandler (spinSystem hSystem, spinLogEventHandler hLogEventHandler)
 Unregisters a selected logging event handler from the system. More...
 
SPINNAKERC_API spinSystemUnregisterAllLogEventHandlers (spinSystem hSystem)
 Unregisters all logging event handlers from the system. More...
 
SPINNAKERC_API spinSystemIsInUse (spinSystem hSystem, bool8_t *pbIsInUse)
 Checks whether a system is currently in use. More...
 
SPINNAKERC_API spinSystemRegisterDeviceArrivalEventHandler (spinSystem hSystem, spinDeviceArrivalEventHandler hDeviceArrivalEventHandler)
 Registers a device arrival event handler to every interface on the system (event handlers registered this way must be unregistered) More...
 
SPINNAKERC_API spinSystemRegisterDeviceRemovalEventHandler (spinSystem hSystem, spinDeviceRemovalEventHandler hDeviceRemovalEventHandler)
 Registers a device removal event handler to the system to every interface on the system (event handlers registered this way must be unregistered) More...
 
SPINNAKERC_API spinSystemUnregisterDeviceArrivalEventHandler (spinSystem hSystem, spinDeviceArrivalEventHandler hDeviceArrivalEventHandler)
 Unregisters a device arrival event handler from the system. More...
 
SPINNAKERC_API spinSystemUnregisterDeviceRemovalEventHandler (spinSystem hSystem, spinDeviceRemovalEventHandler hDeviceRemovalEventHandler)
 Unregisters a device removal event handler from the system. More...
 
SPINNAKERC_API spinSystemRegisterInterfaceEventHandler (spinSystem hSystem, spinInterfaceEventHandler hInterfaceEventHandler)
 Registers an interface event handler (device arrival and device removal) to every interface on the system (interface events registered this way must be unregistered) If new interfaces are detected by the system after spinSystemRegisterInterfaceEventHandler() is called, those interfaces will be automatically registered with this event. More...
 
SPINNAKERC_API spinSystemUnregisterInterfaceEventHandler (spinSystem hSystem, spinInterfaceEventHandler hInterfaceEventHandler)
 Unregisters an interface event handler from the system. More...
 
SPINNAKERC_API spinSystemUpdateCameras (spinSystem hSystem, bool8_t *pbChanged)
 Updates the list of cameras on the system, informing whether there has been any changes. More...
 
SPINNAKERC_API spinSystemUpdateCamerasEx (spinSystem hSystem, bool8_t bUpdateInterfaces, bool8_t *pbChanged)
 Updates the list of cameras on the system, informing whether there has been any changes; manually set whether to update the current interface lists. More...
 
SPINNAKERC_API spinSystemSendActionCommand (spinSystem hSystem, size_t iDeviceKey, size_t iGroupKey, size_t iGroupMask, size_t iActionTime, bool8_t requestAck, size_t *piResultSize, actionCommandResult results[])
 Broadcast an Action Command to all devices on system. More...
 
SPINNAKERC_API spinSystemGetLibraryVersion (spinSystem hSystem, spinLibraryVersion *hLibraryVersion)
 Get current library version of Spinnaker. More...
 
SPINNAKERC_API spinSystemGetTLNodeMap (spinSystem hSystem, spinNodeMapHandle *phNodeMap)
 Retrieves the transport layer nodemap from the system. More...
 
SPINNAKERC_API spinInterfaceListCreateEmpty (spinInterfaceList *phInterfaceList)
 Creates an empty interface list (interface lists created this way must be destroyed) More...
 
SPINNAKERC_API spinInterfaceListDestroy (spinInterfaceList hInterfaceList)
 Destroys an interface list. More...
 
SPINNAKERC_API spinInterfaceListGetSize (spinInterfaceList hInterfaceList, size_t *pSize)
 Retrieves the number of interfaces in an interface list. More...
 
SPINNAKERC_API spinInterfaceListGet (spinInterfaceList hInterfaceList, size_t index, spinInterface *phInterface)
 Retrieves an interface from an interface list using an index (interfaces retrieved this way must be released) More...
 
SPINNAKERC_API spinInterfaceListClear (spinInterfaceList hInterfaceList)
 Clears an interface list. More...
 
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...
 
SPINNAKERC_API spinImageListCreateEmpty (spinImageList *phImageList)
 Creates an empty image list (image lists created this way must be destroyed) More...
 
SPINNAKERC_API spinImageListDestroy (spinImageList hImageList)
 Destroys a image list. More...
 
SPINNAKERC_API spinImageListGetSize (spinImageList hImageList, size_t *pSize)
 Retrieves the number of images in an image list. More...
 
SPINNAKERC_API spinImageListGet (spinImageList hImageList, size_t index, spinImage *phImage)
 Retrieves a image from a image list using an index. More...
 
SPINNAKERC_API spinImageListClear (spinImageList hImageList)
 Clears a image list. More...
 
SPINNAKERC_API spinImageListRemove (spinImageList hImageList, size_t index)
 Removes a image from a image list using its index. More...
 
SPINNAKERC_API spinImageListAppend (spinImageList hImageListBase, spinImageList hImageListToAppend)
 Appends all the images from one image list to another. More...
 
SPINNAKERC_API spinImageListGetByPixelFormat (spinImageList hImageList, spinPixelFormatEnums pixelFormat, spinImage *phImage)
 Retrieves a image from a image list given its pixel format. More...
 
SPINNAKERC_API spinImageListGetByStreamIndex (spinImageList hImageList, uint64_t streamIndex, spinImage *phImage)
 Retrieves a image from a image list given its stream index. More...
 
SPINNAKERC_API spinImageListRemoveByPixelFormat (spinImageList hImageList, spinPixelFormatEnums pixelFormat)
 Removes a image from a image list using its pixel format. More...
 
SPINNAKERC_API spinImageListRemoveByStreamIndex (spinImageList hImageList, uint64_t streamIndex)
 Removes a image from a image list using its stream index. More...
 
SPINNAKERC_API spinImageListRelease (spinImageList hImageList)
 
SPINNAKERC_API spinImageListSave (spinImageList hImageList, const char *fileName)
 Saves an image list as an object to a file. More...
 
SPINNAKERC_API spinImageListLoad (spinImageList *phImageList, const char *fileName)
 Creates an image list object from file. More...
 
SPINNAKERC_API spinInterfaceUpdateCameras (spinInterface hInterface, bool8_t *pbChanged)
 Checks whether any cameras have been connected or disconnected on an interface. More...
 
SPINNAKERC_API spinInterfaceGetCameras (spinInterface hInterface, spinCameraList hCameraList)
 Retrieves a camera list from an interface; camera lists must be created and destroy. More...
 
SPINNAKERC_API spinInterfaceGetCamerasEx (spinInterface hInterface, bool8_t bUpdateCameras, spinCameraList hCameraList)
 Retrieves a camera list from an interface; manually set whether to update the cameras; camera lists must be created and destroyed. More...
 
SPINNAKERC_API spinInterfaceGetTLNodeMap (spinInterface hInterface, spinNodeMapHandle *phNodeMap)
 Retrieves the transport layer nodemap from an interface. More...
 
SPINNAKERC_API spinInterfaceRegisterDeviceArrivalEventHandler (spinInterface hInterface, spinDeviceArrivalEventHandler hDeviceArrivalEventHandler)
 Registers a device arrival event handler on an interface (event handlers registered in this way must be unregistered) More...
 
SPINNAKERC_API spinInterfaceRegisterDeviceRemovalEventHandler (spinInterface hInterface, spinDeviceRemovalEventHandler hDeviceRemovalEventHandler)
 Registers a device removal event handler on an interface (event handlers registered in this way must be unregistered) More...
 
SPINNAKERC_API spinInterfaceUnregisterDeviceArrivalEventHandler (spinInterface hInterface, spinDeviceArrivalEventHandler hDeviceArrivalEventHandler)
 Unregisters a device arrival event handler from an interface. More...
 
SPINNAKERC_API spinInterfaceUnregisterDeviceRemovalEventHandler (spinInterface hInterface, spinDeviceRemovalEventHandler hDeviceRemovalEventHandler)
 Unregisters a device removal event handler from an interface. More...
 
SPINNAKERC_API spinInterfaceRegisterInterfaceEventHandler (spinInterface hInterface, spinInterfaceEventHandler hInterfaceEventHandler)
 Registers an interface event handler (both device arrival and device removal) on an interface. More...
 
SPINNAKERC_API spinInterfaceUnregisterInterfaceEventHandler (spinInterface hInterface, spinInterfaceEventHandler hInterfaceEventHandler)
 Unregisters an interface event handler from an interface. More...
 
SPINNAKERC_API spinInterfaceRelease (spinInterface hInterface)
 Releases an interface. More...
 
SPINNAKERC_API spinInterfaceIsInUse (spinInterface hInterface, bool8_t *pbIsInUse)
 Checks whether an interface is in use. More...
 
SPINNAKERC_API spinInterfaceSendActionCommand (spinInterface hInterface, size_t iDeviceKey, size_t iGroupKey, size_t iGroupMask, size_t iActionTime, bool8_t requestAck, size_t *piResultSize, actionCommandResult results[])
 Broadcast an Action Command to all devices on interface. More...
 
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...
 
SPINNAKERC_API spinCameraDiscoverMaxPacketSize (spinCamera hCamera, unsigned int *pMaxPacketSize)
 Returns the largest packet size that can be safely used on the interface that device is connected to. More...
 
SPINNAKERC_API spinCameraForceIP ()
 Forces the camera to be on the same subnet as its corresponding interface. More...
 
SPINNAKERC_API spinImageCreateEmpty (spinImage *phImage)
 Creates an empty image; images created this way must be destroyed. More...
 
SPINNAKERC_API spinImageCreate (spinImage hSrcImage, spinImage *phDestImage)
 Creates an image from another; images created this way must be destroyed. More...
 
SPINNAKERC_API spinImageCreateEx (spinImage *phImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void *pData)
 Creates an image with some set properties; images created this way must be destroyed. More...
 
SPINNAKERC_API spinImageCreateEx2 (spinImage *phImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void *pData, spinTLPayloadType dataPayloadType, size_t dataSize)
 Creates an image with some set properties; images created this way must be destroyed. More...
 
SPINNAKERC_API spinImageDestroy (spinImage hImage)
 Destroys an image. More...
 
SPINNAKERC_API spinImageGetColorProcessing (spinImage hImage, spinColorProcessingAlgorithm *pAlgorithm)
 Retrieves the color processing algorithm of a specific image. More...
 
SPINNAKERC_API spinImageReset (spinImage hImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat)
 Resets an image with some set properties. More...
 
SPINNAKERC_API spinImageResetEx (spinImage hImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void *pData)
 Resets an image with some set properties and image data. More...
 
SPINNAKERC_API spinImageGetID (spinImage hImage, uint64_t *pId)
 Retrieves the ID of an image. More...
 
SPINNAKERC_API spinImageGetData (spinImage hImage, void **ppData)
 Retrieves the image data of an image. More...
 
SPINNAKERC_API spinImageGetPrivateData (spinImage hImage, void **ppData)
 Retrieves the private data of an image. More...
 
SPINNAKERC_API spinImageGetBufferSize (spinImage hImage, size_t *pSize)
 Retrieves the buffer size of an image. More...
 
SPINNAKERC_API spinImageDeepCopy (spinImage hSrcImage, spinImage hDestImage)
 Creates a deep copy of an image (the destination image must be created as an empty image prior to the deep copy) More...
 
SPINNAKERC_API spinImageGetWidth (spinImage hImage, size_t *pWidth)
 Retrieves the width of an image. More...
 
SPINNAKERC_API spinImageGetHeight (spinImage hImage, size_t *pHeight)
 Retrieves the height of an image. More...
 
SPINNAKERC_API spinImageGetOffsetX (spinImage hImage, size_t *pOffsetX)
 Retrieves the offset of an image along its X axis. More...
 
SPINNAKERC_API spinImageGetOffsetY (spinImage hImage, size_t *pOffsetY)
 Retrieves the offset of an image along its Y axis. More...
 
SPINNAKERC_API spinImageGetPaddingX (spinImage hImage, size_t *pPaddingX)
 Retrieves the padding of an image along its X axis. More...
 
SPINNAKERC_API spinImageGetPaddingY (spinImage hImage, size_t *pPaddingY)
 Retrieves the padding of an image along its Y axis. More...
 
SPINNAKERC_API spinImageGetFrameID (spinImage hImage, uint64_t *pFrameID)
 Retrieves the frame ID of an image. More...
 
SPINNAKERC_API spinImageGetTimeStamp (spinImage hImage, uint64_t *pTimeStamp)
 Retrieves the timestamp of an image. More...
 
SPINNAKERC_API spinImageGetPayloadType (spinImage hImage, size_t *pPayloadType)
 Retrieves the payload type of an image (as an enum, spinPayloadTypeInfoIds) More...
 
SPINNAKERC_API spinImageGetTLPayloadType (spinImage hImage, spinTLPayloadType *pPayloadType)
 Retrieves the transport layer payload type of an image (as an enum, spinPayloadTypeInfoIds) More...
 
SPINNAKERC_API spinImageGetPixelFormat (spinImage hImage, spinPixelFormatEnums *pPixelFormat)
 Retrieves the pixel format of an image (as an enum, spinPixelFormatEnums) More...
 
SPINNAKERC_API spinImageGetTLPixelFormat (spinImage hImage, uint64_t *pPixelFormat)
 Retrieves the transport layer pixel format of an image (as an unsigned integer) More...
 
SPINNAKERC_API spinImageGetTLPixelFormatNamespace (spinImage hImage, spinTLPixelFormatNamespace *pPixelFormatNamespace)
 Retrieves the transport layer pixel format namespace of an image (as an enum, spinPixelFormatNamespaceID) More...
 
SPINNAKERC_API spinImageGetPixelFormatName (spinImage hImage, char *pBuf, size_t *pBufLen)
 Retrieves the pixel format of an image (as a symbolic) More...
 
SPINNAKERC_API spinImageIsIncomplete (spinImage hImage, bool8_t *pbIsIncomplete)
 Checks whether an image is incomplete. More...
 
SPINNAKERC_API spinImageGetValidPayloadSize (spinImage hImage, size_t *pSize)
 Retrieves the valid payload size of an image. More...
 
SPINNAKERC_API spinImageSave (spinImage hImage, const char *pFilename, spinImageFileFormat format)
 Saves an image using a specified file format (using an enum, spinImageFileFormat) More...
 
SPINNAKERC_API spinImageSaveFromExt (spinImage hImage, const char *pFilename)
 Saves an image using a specified file format (using the extension of the filename) More...
 
SPINNAKERC_API spinImageSavePng (spinImage hImage, const char *pFilename, const spinPNGOption *pOption)
 Saves an image as a PNG image. More...
 
SPINNAKERC_API spinImageSavePpm (spinImage hImage, const char *pFilename, const spinPPMOption *pOption)
 Saves an image as a PPM image. More...
 
SPINNAKERC_API spinImageSavePgm (spinImage hImage, const char *pFilename, const spinPGMOption *pOption)
 Saves an image as an PGM image. More...
 
SPINNAKERC_API spinImageSaveTiff (spinImage hImage, const char *pFilename, const spinTIFFOption *pOption)
 Saves an image as a TIFF image. More...
 
SPINNAKERC_API spinImageSaveJpeg (spinImage hImage, const char *pFilename, const spinJPEGOption *pOption)
 Saves an image as a JPEG image. More...
 
SPINNAKERC_API spinImageSaveJpg2 (spinImage hImage, const char *pFilename, const spinJPG2Option *pOption)
 Saves an image as a JPEG 2000 image. More...
 
SPINNAKERC_API spinImageSaveBmp (spinImage hImage, const char *pFilename, const spinBMPOption *pOption)
 Saves an image as a BMP image. More...
 
SPINNAKERC_API spinImageGetChunkLayoutID (spinImage hImage, uint64_t *pId)
 Retrieves the chunk layout ID of an image. More...
 
SPINNAKERC_API spinImageCalculateStatistics (spinImage hImage, const spinImageStatistics hStatistics)
 Calculates the image statistics of an image. More...
 
SPINNAKERC_API spinImageGetStatus (spinImage hImage, spinImageStatus *pStatus)
 Retrieves the image status of an image. More...
 
SPINNAKERC_API spinImageGetStatusDescription (spinImageStatus status, char *pBuf, size_t *pBufLen)
 Retrieves the description of image status. More...
 
SPINNAKERC_API spinImageRelease (spinImage hImage)
 Releases an image. More...
 
SPINNAKERC_API spinImageHasCRC (spinImage hImage, bool8_t *pbHasCRC)
 Checks whether an image has CRC. More...
 
SPINNAKERC_API spinImageCheckCRC (spinImage hImage, bool8_t *pbCheckCRC)
 Checks whether the CRC of an image is correct. More...
 
SPINNAKERC_API spinImageGetBitsPerPixel (spinImage hImage, size_t *pBitsPerPixel)
 Retrieves the number of bits per pixel of an image. More...
 
SPINNAKERC_API spinImageGetSize (spinImage hImage, size_t *pImageSize)
 Retrieves the size of an image. More...
 
SPINNAKERC_API spinImageGetStride (spinImage hImage, size_t *pStride)
 Retrieves the stride of an image. More...
 
SPINNAKERC_API spinImageProcessorCreate (spinImageProcessor *phImageProcessor)
 Creates an image processor. More...
 
SPINNAKERC_API spinImageProcessorDestroy (spinImageProcessor hImageProcessor)
 Destroys a image list. More...
 
SPINNAKERC_API spinImageProcessorSetColorProcessing (spinImageProcessor hImageProcessor, spinColorProcessingAlgorithm colorAlgorithm)
 Sets the color processing algorithm used at the time of the spinImageProcessorConvert() call, therefore the most recent execution of this function will take precedence. More...
 
SPINNAKERC_API spinImageProcessorGetColorProcessing (spinImageProcessor hImageProcessor, spinColorProcessingAlgorithm *pColorAlgorithm)
 Gets the default color processing algorithm. More...
 
SPINNAKERC_API spinImageProcessorSetNumDecompressionThreads (spinImageProcessor hImageProcessor, unsigned int numThreads)
 Sets the default number of threads used for image decompression during spinImageProcessorConvert(). More...
 
SPINNAKERC_API spinImageProcessorGetNumDecompressionThreads (spinImageProcessor hImageProcessor, unsigned int *pNumThreads)
 Gets the number of threads used for image decompression during spinImageProcessorConvert(). More...
 
SPINNAKERC_API spinImageProcessorConvert (spinImageProcessor hImageProcessor, spinImage hSrcImage, spinImage hDestImage, spinPixelFormatEnums destFormat)
 Converts the source image buffer to the specified destination pixel format and stores the result in the destination image. More...
 
SPINNAKERC_API spinImageProcessorConvertImageList (spinImageProcessor hImageProcessor, spinImageList hSrcImageList, spinImage hDestImage, spinPixelFormatEnums destFormat)
 Converts the source list of image buffers to the specified output pixel format and returns the result in a new image. More...
 
SPINNAKERC_API spinImageProcessorApplyGamma (spinImageProcessor hImageProcessor, spinImage hSrcImage, spinImage hDestImage, float gamma, bool8_t applyGammaInverse)
 Applies gamma correction to the source image and stores the result in the destination image. More...
 
SPINNAKERC_API spinDeviceEventHandlerCreate (spinDeviceEventHandler *phDeviceEventHandler, spinDeviceEventFunction pFunction, void *pUserData)
 Creates a device event handler. More...
 
SPINNAKERC_API spinDeviceEventHandlerDestroy (spinDeviceEventHandler hDeviceEventHandler)
 Destroys a device event handler. More...
 
SPINNAKERC_API spinImageEventHandlerCreate (spinImageEventHandler *phImageEventHandler, spinImageEventFunction pFunction, void *pUserData)
 Creates an image event handler. More...
 
SPINNAKERC_API spinImageEventHandlerDestroy (spinImageEventHandler hImageEventHandler)
 Destroys an image event handler. More...
 
SPINNAKERC_API spinImageListEventHandlerCreate (spinImageListEventHandler *phImageEventHandler, spinImageListEventFunction pFunction, void *pUserData)
 Creates an image list event handler. More...
 
SPINNAKERC_API spinImageListEventHandlerDestroy (spinImageListEventHandler hImageListEventHandler)
 Destroys an image list event handler. More...
 
SPINNAKERC_API spinDeviceArrivalEventHandlerCreate (spinDeviceArrivalEventHandler *phDeviceArrivalEventHandler, spinArrivalEventFunction pFunction, void *pUserData)
 Creates a device arrival event handler. More...
 
SPINNAKERC_API spinDeviceArrivalEventHandlerDestroy (spinDeviceArrivalEventHandler hDeviceArrivalEventHandler)
 Destroys a device arrival event handler. More...
 
SPINNAKERC_API spinDeviceRemovalEventHandlerCreate (spinDeviceRemovalEventHandler *phDeviceRemovalEventHandler, spinRemovalEventFunction pFunction, void *pUserData)
 Creates a device removal event handler. More...
 
SPINNAKERC_API spinDeviceRemovalEventHandlerDestroy (spinDeviceRemovalEventHandler hDeviceRemovalEventHandler)
 Destroys a device removal event handler. More...
 
SPINNAKERC_API spinInterfaceEventHandlerCreate (spinInterfaceEventHandler *phInterfaceEventHandler, spinArrivalEventFunction pArrivalFunction, spinRemovalEventFunction pRemovalFunction, void *pUserData)
 Creates an interface event handler (both device arrival and device removal) More...
 
SPINNAKERC_API spinInterfaceEventHandlerDestroy (spinInterfaceEventHandler hInterfaceEventHandler)
 Destroys an interface event handler (both device arrival and device removal) More...
 
SPINNAKERC_API spinLogEventHandlerCreate (spinLogEventHandler *phLogEventHandler, spinLogEventFunction pFunction, void *pUserData)
 Creates a log event handler. More...
 
SPINNAKERC_API spinLogEventHandlerDestroy (spinLogEventHandler hLogEventHandler)
 Destroys a log event handler. More...
 
SPINNAKERC_API spinImageStatisticsCreate (spinImageStatistics *phStatistics)
 Creates an image statistics context. More...
 
SPINNAKERC_API spinImageStatisticsDestroy (spinImageStatistics hStatistics)
 Destroys an image statistics context. More...
 
SPINNAKERC_API spinImageStatisticsEnableAll (spinImageStatistics hStatistics)
 Enables all channels of an image statistics context. More...
 
SPINNAKERC_API spinImageStatisticsDisableAll (spinImageStatistics hStatistics)
 Disables all channels of an image statistics context. More...
 
SPINNAKERC_API spinImageStatisticsEnableGreyOnly (spinImageStatistics hStatistics)
 Disables all channels of an image statistics context except grey-scale. More...
 
SPINNAKERC_API spinImageStatisticsEnableRgbOnly (spinImageStatistics hStatistics)
 Disables all channels of an image statistics context except red, blue, and green. More...
 
SPINNAKERC_API spinImageStatisticsEnableHslOnly (spinImageStatistics hStatistics)
 Disables all channels of an image statistics context except hue, saturation, and lightness. More...
 
SPINNAKERC_API spinImageStatisticsGetChannelStatus (spinImageStatistics hStatistics, spinStatisticsChannel channel, bool8_t *pbEnabled)
 Checks whether an image statistics context is enabled. More...
 
SPINNAKERC_API spinImageStatisticsSetChannelStatus (spinImageStatistics hStatistics, spinStatisticsChannel channel, bool8_t bEnable)
 Sets the status of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetRange (spinImageStatistics hStatistics, spinStatisticsChannel channel, unsigned int *pMin, unsigned int *pMax)
 Retrieves the range of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetPixelValueRange (spinImageStatistics hStatistics, spinStatisticsChannel channel, unsigned int *pMin, unsigned int *pMax)
 Retrieves the pixel value range of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetNumPixelValues (spinImageStatistics hStatistics, spinStatisticsChannel channel, unsigned int *pNumValues)
 Retrieves the number of pixel values of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetMean (spinImageStatistics hStatistics, spinStatisticsChannel channel, float *pMean)
 Retrieves the mean of pixel values of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetHistogram (spinImageStatistics hStatistics, spinStatisticsChannel channel, int **ppHistogram)
 Retrieves a histogram of an image statistics channel. More...
 
SPINNAKERC_API spinImageStatisticsGetAll (spinImageStatistics hStatistics, spinStatisticsChannel channel, unsigned int *pRangeMin, unsigned int *pRangeMax, unsigned int *pPixelValueMin, unsigned int *pPixelValueMax, unsigned int *pNumPixelValues, float *pPixelValueMean, int **ppHistogram)
 Retrieves all available information of an image statistics channel. More...
 
SPINNAKERC_API spinLogDataGetCategoryName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the category name of a log event. More...
 
SPINNAKERC_API spinLogDataGetPriority (spinLogEventData hLogEventData, int64_t *pValue)
 Retrieves the priority of a log event. More...
 
SPINNAKERC_API spinLogDataGetPriorityName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the priority name of a log event. More...
 
SPINNAKERC_API spinLogDataGetTimestamp (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the timestamp of a log event. More...
 
SPINNAKERC_API spinLogDataGetNDC (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the NDC of a log event. More...
 
SPINNAKERC_API spinLogDataGetThreadName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the thread name of a log event. More...
 
SPINNAKERC_API spinLogDataGetLogMessage (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
 Retrieves the log message of a log event. More...
 
SPINNAKERC_API spinDeviceEventGetId (spinDeviceEventData hDeviceEventData, uint64_t *pEventId)
 Retrieves the event ID of a device event. More...
 
SPINNAKERC_API spinDeviceEventGetPayloadData (spinDeviceEventData hDeviceEventData, const uint8_t *pBuf, size_t *pBufSize)
 Retrieves the payload data of a device event. More...
 
SPINNAKERC_API spinDeviceEventGetPayloadDataSize (spinDeviceEventData hDeviceEventData, size_t *pBufSize)
 Retrieves the payload data size of a device event. More...
 
SPINNAKERC_API spinDeviceEventGetName (spinDeviceEventData hDeviceEventData, char *pBuf, size_t *pBufLen)
 Retrieves the event name of a device event. More...
 
SPINNAKERC_API spinImageChunkDataGetIntValue (spinImage hImage, const char *pName, int64_t *pValue)
 
SPINNAKERC_API spinImageChunkDataGetFloatValue (spinImage hImage, const char *pName, double *pValue)
 
SPINNAKERC_API spinImageChunkDataGetRawData (spinImage hImage, const char *pName, uint8_t **pData)
 
SPINNAKERC_API spinImageChunkDataGetBoolValue (spinImage hImage, const char *pName, bool8_t *pValue)
 

Variables

bool8_tpbIsStreaming
 

Function Documentation

◆ spinCameraForceIP()

SPINNAKERC_API spinCameraForceIP ( )

Forces the camera to be on the same subnet as its corresponding interface.

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