Modules | |
Spinnaker.h | |
Global header file for Spinnaker. | |
Spinnaker Definitions | |
Definitions file for Spinnaker. | |
SpinnakerDirectShow.h | |
Global header file for Spinnaker DirectShow library. | |
Spinnaker Platform | |
Platform-specific header file for Spinnaker. | |
Spinnaker Video Definitions | |
Definitions file for Spinnaker video recorder. | |
Classes | |
struct | PNGOption |
Spinnaker struct definitions. More... | |
struct | MJPGOption |
Options for saving MJPG files. More... | |
struct | H264Option |
Options for saving H264 files. More... | |
struct | AVIOption |
Options for saving AVI files. More... | |
Variables | |
const uint64_t | EVENT_TIMEOUT_NONE = 0 |
Timeout values for getting next image, device, or interface event. More... | |
const uint64_t | EVENT_TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF |
Spinnaker GenAPI Functions | |
These functions deal with Spinnaker GenAPI NodeMap and Node Accesses for setting camera properties. | |
STDMETHOD() | NodeMapGetNumNodes (size_t *numNodes)=0 |
Retrieves the number of nodes available in the node map for the currently selected camera. More... | |
STDMETHOD() | NodeMapGetNodeAtIndex (size_t index, char *nodeName, size_t bufferSize)=0 |
Retrieves the string representation of the node at the specified index. More... | |
STDMETHOD() | NodeIsImplemented (const char *nodeName, bool *isImplemented)=0 |
Checks if a node is implemented. More... | |
STDMETHOD() | NodeIsAvailable (const char *nodeName, bool *isAvailable)=0 |
Checks if a node is available. More... | |
STDMETHOD() | NodeIsReadable (const char *nodeName, bool *isReadable)=0 |
Checks if a node is readable. More... | |
STDMETHOD() | NodeIsWritable (const char *nodeName, bool *isWritable)=0 |
Checks if a node is writable. More... | |
STDMETHOD() | NodeGetType (const char *nodeName, char *typeName, size_t bufferSize)=0 |
Gets the type of the node. More... | |
STDMETHOD() | NodeToString (const char *nodeName, char *valueAsString, size_t bufferSize)=0 |
Gets content of the node as string. More... | |
STDMETHOD() | NodeGetDisplayName (const char *nodeName, char *displayName, size_t bufferSize)=0 |
Gets a name string for display. More... | |
Integer Node Functions | |
These functions deal with Spinnaker GenAPI Integer Node Accesses | |
STDMETHOD() | IntegerGetValue (const char *nodeName, int64_t *value)=0 |
Gets integer node value for the specified feature. More... | |
STDMETHOD() | IntegerSetValue (const char *nodeName, int64_t value)=0 |
Sets integer node value for the specified feature. More... | |
STDMETHOD() | IntegerGetMax (const char *nodeName, int64_t *maxValue)=0 |
Gets maximum integer value allowed for the specified feature. More... | |
STDMETHOD() | IntegerGetMin (const char *nodeName, int64_t *minValue)=0 |
Gets minimum integer value allowed for the specified feature. More... | |
STDMETHOD() | IntegerGetIncMode (const char *nodeName, Spinnaker::GenApi::EIncMode *incMode)=0 |
Gets integer increment mode for the specified feature. More... | |
STDMETHOD() | IntegerGetInc (const char *nodeName, int64_t *increment)=0 |
Gets integer step increment for the specified feature. More... | |
Float Node Functions | |
These functions deal with Spinnaker GenAPI Float Node Accesses | |
STDMETHOD() | FloatGetValue (const char *nodeName, double *value)=0 |
Gets float node value for the specified feature. More... | |
STDMETHOD() | FloatSetValue (const char *nodeName, double value)=0 |
Sets float node value for the specified feature. More... | |
STDMETHOD() | FloatGetMax (const char *nodeName, double *floatMax)=0 |
Gets maximum float value allowed for the specified feature. More... | |
STDMETHOD() | FloatGetMin (const char *nodeName, double *floatMin)=0 |
Gets minimum float value allowed for the specified feature. More... | |
STDMETHOD() | FloatGetIncMode (const char *nodeName, Spinnaker::GenApi::EIncMode *incMode)=0 |
Gets float increment mode for the specified feature. More... | |
STDMETHOD() | FloatGetInc (const char *nodeName, double *increment)=0 |
Gets float step increment for the specified feature. More... | |
Boolean Node Functions | |
These functions deal with Spinnaker GenAPI Boolean Node Accesses | |
STDMETHOD() | BooleanGetValue (const char *nodeName, bool *value)=0 |
Gets boolean node value for the specified feature. More... | |
STDMETHOD() | BooleanSetValue (const char *nodeName, bool value)=0 |
Sets boolean node value for the specified feature. More... | |
String Node Functions | |
These functions deal with Spinnaker GenAPI String Node Accesses | |
STDMETHOD() | StringGetValue (const char *nodeName, char *value, size_t bufferSize)=0 |
Gets string node value for the specified feature. More... | |
STDMETHOD() | StringSetValue (const char *nodeName, const char *value)=0 |
Sets string node value for the specified feature. More... | |
Enumeration Node Functions | |
These functions deal with Spinnaker GenAPI Enumeration and EnumeratEntry Node Accesses | |
const char * | enumerationName |
Checks if an enumeration entry exists for the specified enumeration feature. More... | |
const char const char * | enumerationEntryName |
const char const char bool * | entryExist = 0 |
const char unsigned int | entryIndex |
const char unsigned int char size_t | bufferSize = 0 |
STDMETHOD() | EnumerationGetEntry (const char *nodeName, char *value, size_t bufferSize)=0 |
Gets enumeration entry string for the specified enumeration feature. More... | |
STDMETHOD() | EnumerationSetEntry (const char *nodeName, const char *value)=0 |
Sets enumeration entry for the specified enumeration feature. More... | |
STDMETHOD() | EnumerationGetNumEntries (const char *enumerationName, size_t *numEntries)=0 |
Retrieves the number of enumeration entry nodes available for the specified enumeration feature. More... | |
Command Node Functions | |
These functions deal with Spinnaker GenAPI Command Node Accesses | |
STDMETHOD() | CommandExecute (const char *nodeName)=0 |
Executes the command for the specified feature. More... | |
|
pure virtual |
Gets boolean node value for the specified feature.
nodeName | GenICam device feature name |
value | The value read from the device |
|
pure virtual |
Sets boolean node value for the specified feature.
nodeName | GenICam device feature name |
value | The value to set to device |
|
pure virtual |
Executes the command for the specified feature.
nodeName | GenICam device feature name |
|
pure virtual |
Gets enumeration entry string for the specified enumeration feature.
nodeName | GenICam device feature name |
value | The enumeration entry string read from the device |
bufferSize | Size of the provided value buffer in bytes |
|
pure virtual |
Retrieves the number of enumeration entry nodes available for the specified enumeration feature.
enumerationName | GenICam device enumeration feature name |
numEntries | Number of nodes available for the specified enumeration feature |
|
pure virtual |
Sets enumeration entry for the specified enumeration feature.
nodeName | GenICam device feature name |
value | The enumeration entry string to set to device |
|
pure virtual |
Gets float step increment for the specified feature.
nodeName | GenICam device feature name |
increment | The step increment value read from the device |
|
pure virtual |
Gets float increment mode for the specified feature.
nodeName | GenICam device feature name |
incMode | Spinnaker GenAPI increment mode for the specified feature |
|
pure virtual |
Gets maximum float value allowed for the specified feature.
nodeName | GenICam device feature name |
floatMax | The maximum allowed value read from the device |
|
pure virtual |
Gets minimum float value allowed for the specified feature.
nodeName | GenICam device feature name |
floatMin | The minimum allowed value read from the device |
|
pure virtual |
Gets float node value for the specified feature.
nodeName | GenICam device feature name |
value | The value read from the device |
|
pure virtual |
Sets float node value for the specified feature.
nodeName | GenICam device feature name |
value | The value to set to device |
|
pure virtual |
Gets integer step increment for the specified feature.
nodeName | GenICam device feature name |
increment | The step increment value read from the device |
|
pure virtual |
Gets integer increment mode for the specified feature.
nodeName | GenICam device feature name |
incMode | Spinnaker GenAPI increment mode for the specified feature |
|
pure virtual |
Gets maximum integer value allowed for the specified feature.
nodeName | GenICam device feature name |
maxValue | The maximum allowed value read from the device |
|
pure virtual |
Gets minimum integer value allowed for the specified feature.
nodeName | GenICam device feature name |
minValue | The minimum allowed value read from the device |
|
pure virtual |
Gets integer node value for the specified feature.
nodeName | GenICam device feature name |
value | The value read from the device |
|
pure virtual |
Sets integer node value for the specified feature.
nodeName | GenICam device feature name |
value | The value to set to device |
|
pure virtual |
Gets a name string for display.
nodeName | GenICam device feature name |
displayName | Display name of the device feature |
bufferSize | Size of the provided displayName buffer in bytes |
|
pure virtual |
Gets the type of the node.
nodeName | GenICam device feature name |
typeName | The type of the node. Available type names are: Integer, Float, Boolean, String, Enumeration, Entry, Command and Other |
bufferSize | Size of the provided typeName buffer in bytes |
|
pure virtual |
Checks if a node is available.
nodeName | GenICam device feature name |
isAvailable | Flag indicating whether node is available or not |
|
pure virtual |
Checks if a node is implemented.
nodeName | GenICam device feature name |
isImplemented | Flag indicating whether node is implemented or not |
|
pure virtual |
Checks if a node is readable.
nodeName | GenICam device feature name |
isReadable | Flag indicating whether node is readable or not |
|
pure virtual |
Checks if a node is writable.
nodeName | GenICam device feature name |
isWritable | Flag indicating whether node is writable or not |
|
pure virtual |
Retrieves the string representation of the node at the specified index.
index | Node index in the NodeMap |
nodeName | GenICam node name at specified index to be populated |
bufferSize | Size of the provided nodeName buffer in bytes |
|
pure virtual |
Retrieves the number of nodes available in the node map for the currently selected camera.
numNodes | Number of nodes available for the currently selected device |
|
pure virtual |
Gets content of the node as string.
nodeName | GenICam device feature name |
valueAsString | String representation of the node value |
bufferSize | Size of the provided valueAsString buffer in bytes |
|
pure virtual |
Gets string node value for the specified feature.
nodeName | GenICam device feature name |
value | The value read from the device |
bufferSize | Size of the provided value buffer in bytes |
|
pure virtual |
Sets string node value for the specified feature.
nodeName | GenICam device feature name |
value | The value to set to device |
const char unsigned int char size_t bufferSize = 0 |
const char const char bool* entryExist = 0 |
const char unsigned int entryIndex |
const char unsigned int char * enumerationEntryName |
const char * enumerationName |
Checks if an enumeration entry exists for the specified enumeration feature.
Gets enumeration entry string for the specified enumeration feature at the specified index.
enumerationName | GenICam device enumeration feature name |
enumerationEntryName | GenICam device enumeration entry name to check |
entryExist | Flag indicating whether the specified entry node exists for the enumeration node |
enumerationName | GenICam device enumeration feature name |
entryIndex | Enumeration entry index |
enumerationEntryName | GenICam device enumeration entry name at specified entryIndex to be populated |
bufferSize | Size of the provided enumerationEntryName buffer in bytes |
const uint64_t EVENT_TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF |
const uint64_t EVENT_TIMEOUT_NONE = 0 |
Timeout values for getting next image, device, or interface event.
Contact Support | Spinnaker® SDK Programmer's Guide and API Reference | Mon Apr 10 2023 © FLIR Integrated Imaging Solutions Inc. All rights reserved. |