Spinnaker C
4.3.0.189
 
Functions
SpinnakerGenApiC.h File Reference

Functions

SPINNAKERC_API spinNodeMapGetNode (spinNodeMapHandle hNodeMap, const char *pName, spinNodeHandle *phNode)
 Retrieves a node from the nodemap by name. More...
 
SPINNAKERC_API spinNodeMapGetNumNodes (spinNodeMapHandle hNodeMap, size_t *pValue)
 Gets the number of nodes in the map. More...
 
SPINNAKERC_API spinNodeMapGetNodeByIndex (spinNodeMapHandle hNodeMap, size_t index, spinNodeHandle *phNode)
 Retrieves a node from the nodemap by index. More...
 
SPINNAKERC_API spinNodeMapReleaseNode (spinNodeMapHandle hNodeMap, spinNodeHandle hNode)
 Releases the entry node handle. More...
 
SPINNAKERC_API spinNodeMapPoll (spinNodeMapHandle hNodeMap, int64_t timestamp)
 Fires nodes which have a polling time. More...
 
SPINNAKERC_API spinNodeIsImplemented (spinNodeHandle hNode, bool8_t *pbResult)
 Checks whether a node is implemented. More...
 
SPINNAKERC_API spinNodeIsReadable (spinNodeHandle hNode, bool8_t *pbResult)
 Checks whether a node is readable. More...
 
SPINNAKERC_API spinNodeIsWritable (spinNodeHandle hNode, bool8_t *pbResult)
 Checks whether a node is writable. More...
 
SPINNAKERC_API spinNodeIsAvailable (spinNodeHandle hNode, bool8_t *pbResult)
 Checks whether a node is available. More...
 
SPINNAKERC_API spinNodeIsEqual (spinNodeHandle hNodeFirst, spinNodeHandle hNodeSecond, bool8_t *pbResult)
 Checks whether two nodes are equal. More...
 
SPINNAKERC_API spinNodeGetAccessMode (spinNodeHandle hNode, spinAccessMode *pAccessMode)
 Retrieves the access mode of a node (as an enum, spinAccessMode) More...
 
SPINNAKERC_API spinNodeGetName (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the name of a node (no whitespace) More...
 
SPINNAKERC_API spinNodeGetNameSpace (spinNodeHandle hNode, spinNameSpace *pNamespace)
 Retrieve the namespace of a node (as an enum, spinNameSpace) More...
 
SPINNAKERC_API spinNodeGetVisibility (spinNodeHandle hNode, spinVisibility *pVisibility)
 Retrieves the recommended visibility of a node (as an enum, spinVisibility) More...
 
SPINNAKERC_API spinNodeInvalidateNode (spinNodeHandle hNode)
 Invalidates a node in case its values may have changed, rendering it no longer valid. More...
 
SPINNAKERC_API spinNodeGetCachingMode (spinNodeHandle hNode, spinCachingMode *pCachingMode)
 Retrieves the caching mode of a node (as an enum, spinCachingMode) More...
 
SPINNAKERC_API spinNodeGetToolTip (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves a short description of a node. More...
 
SPINNAKERC_API spinNodeGetDescription (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves a longer description of a node. More...
 
SPINNAKERC_API spinNodeGetDisplayName (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the display name of a node (whitespace possible) More...
 
SPINNAKERC_API spinNodeGetType (spinNodeHandle hNode, spinNodeType *pType)
 Retrieves the type of a node (as an enum, spinNodeType) More...
 
SPINNAKERC_API spinNodeGetPollingTime (spinNodeHandle hNode, int64_t *pPollingTime)
 Retrieve the polling time of a node. More...
 
SPINNAKERC_API spinNodeRegisterCallback (spinNodeHandle hNode, spinNodeCallbackFunction pCbFunction, spinNodeCallbackHandle *phCb)
 Registers a callback to a node. More...
 
SPINNAKERC_API spinNodeDeregisterCallback (spinNodeHandle hNode, spinNodeCallbackHandle hCb)
 Unregisters a callback from a node. More...
 
SPINNAKERC_API spinNodeGetImposedAccessMode (spinNodeHandle hNode, spinAccessMode imposedAccessMode)
 Retrieves the imposed access mode of a node. More...
 
SPINNAKERC_API spinNodeGetImposedVisibility (spinNodeHandle hNode, spinVisibility imposedVisibility)
 Retrieves the imposed visibility of a node. More...
 
SPINNAKERC_API spinNodeToString (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the value of any node type as a c-string. More...
 
SPINNAKERC_API spinNodeToStringEx (spinNodeHandle hNode, bool8_t bVerify, char *pBuf, size_t *pBufLen)
 Retrieves the value of any node type as a c-string; manually set whether to verify the node. More...
 
SPINNAKERC_API spinNodeFromString (spinNodeHandle hNode, const char *pBuf)
 Sets the value of any node type from a c-string; it is important to ensure that the value of the c-string is appropriate to the node type. More...
 
SPINNAKERC_API spinNodeFromStringEx (spinNodeHandle hNode, bool8_t bVerify, const char *pBuf)
 Sets the value of any node type from a c-string; manually set whether to verify the node; ensure the value of the c-string is appropriate to the node type. More...
 
SPINNAKERC_API spinStringSetValue (spinNodeHandle hNode, const char *pBuf)
 Sets the value of a string node. More...
 
SPINNAKERC_API spinStringSetValueEx (spinNodeHandle hNode, bool8_t bVerify, const char *pBuf)
 Sets the value of a string node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinStringGetValue (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the value of a string node as a c-string. More...
 
SPINNAKERC_API spinStringGetValueEx (spinNodeHandle hNode, bool8_t bVerify, char *pBuf, size_t *pBufLen)
 Retrieves the value of a string node as a cstring; manually set whether to verify the node. More...
 
SPINNAKERC_API spinStringGetMaxLength (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the maximum length of the c-string to be returned. More...
 
SPINNAKERC_API spinIntegerSetValue (spinNodeHandle hNode, int64_t value)
 Sets the value of an integer node. More...
 
SPINNAKERC_API spinIntegerSetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t value)
 Sets the value of an integer node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinIntegerGetValue (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the value of an integer node. More...
 
SPINNAKERC_API spinIntegerGetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t *pValue)
 Retrieves the value of an integer node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinIntegerGetMin (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the minimum value of an integer node; all potential values must be greater than or equal to the minimum. More...
 
SPINNAKERC_API spinIntegerGetMax (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the maximum value of an integer node; all potential values must be lesser than or equal to the maximum. More...
 
SPINNAKERC_API spinIntegerGetInc (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the increment of an integer node; all possible values must be divisible by the increment. More...
 
SPINNAKERC_API spinIntegerGetRepresentation (spinNodeHandle hNode, spinRepresentation *pValue)
 Retrieves the numerical representation of the value of a node; i.e. More...
 
SPINNAKERC_API spinFloatSetValue (spinNodeHandle hNode, double value)
 Sets the value of a float node. More...
 
SPINNAKERC_API spinFloatSetValueEx (spinNodeHandle hNode, bool8_t bVerify, double value)
 Sets the value of a float node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinFloatGetValue (spinNodeHandle hNode, double *pValue)
 Retrieves the value of a float node. More...
 
SPINNAKERC_API spinFloatGetValueEx (spinNodeHandle hNode, bool8_t bVerify, double *pValue)
 Retrieves the value of a float node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinFloatGetMin (spinNodeHandle hNode, double *pValue)
 Retrieves the minimum value of a float node; all potential values must be greater than or equal to the minimum. More...
 
SPINNAKERC_API spinFloatGetMax (spinNodeHandle hNode, double *pValue)
 Retrieves the maximum value of a float node; all potential values must be lesser than or equal to the maximum. More...
 
SPINNAKERC_API spinFloatGetRepresentation (spinNodeHandle hNode, spinRepresentation *pValue)
 Retrieves the numerical representation of the value of a node; i.e. More...
 
SPINNAKERC_API spinFloatGetUnit (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the units of the float node value. More...
 
SPINNAKERC_API spinEnumerationGetNumEntries (spinNodeHandle hEnumNode, size_t *pValue)
 Retrieves the number of entries of an enum node. More...
 
SPINNAKERC_API spinEnumerationGetEntryByIndex (spinNodeHandle hEnumNode, size_t index, spinNodeHandle *phEntry)
 Retrieves an entry node from an enum node using an index. More...
 
SPINNAKERC_API spinEnumerationGetEntryByName (spinNodeHandle hEnumNode, const char *pName, spinNodeHandle *phEntry)
 Retrieves an entry node from an enum node using the entry's symbolic. More...
 
SPINNAKERC_API spinEnumerationGetCurrentEntry (spinNodeHandle hEnumNode, spinNodeHandle *phEntry)
 Retrieves the currently selected entry node from an enum node. More...
 
SPINNAKERC_API spinEnumerationReleaseNode (spinNodeHandle hEnumNode, spinNodeHandle hEntry)
 Releases the entry node from the enum node handle. More...
 
SPINNAKERC_API spinEnumerationSetIntValue (spinNodeHandle hEnumNode, int64_t value)
 Sets a new entry using its integer value retrieved from a call to spinEnumerationEntryGetIntValue(); note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationSetEnumValue (spinNodeHandle hEnumNode, size_t value)
 Sets a new entry using its enum; note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationEntryGetIntValue (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the integer value of an entry node; note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationEntryGetEnumValue (spinNodeHandle hNode, size_t *pValue)
 Retrieves the enum value (as an integer) of an entry node; note that enumeraiton entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationEntryGetSymbolic (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the symbolic of an entry node as a c-string. More...
 
SPINNAKERC_API spinBooleanSetValue (spinNodeHandle hNode, bool8_t value)
 Sets the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1') More...
 
SPINNAKERC_API spinBooleanGetValue (spinNodeHandle hNode, bool8_t *pbValue)
 Retrieves the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1') More...
 
SPINNAKERC_API spinCommandExecute (spinNodeHandle hNode)
 Executes the action associated to a command node. More...
 
SPINNAKERC_API spinCommandIsDone (spinNodeHandle hNode, bool8_t *pbValue)
 Retrieves whether or not the action of a command node has completed. More...
 
SPINNAKERC_API spinCategoryGetNumFeatures (spinNodeHandle hCategoryNode, size_t *pValue)
 Retrieves the number of a features (or child nodes) or a category node. More...
 
SPINNAKERC_API spinCategoryGetFeatureByIndex (spinNodeHandle hCategoryNode, size_t index, spinNodeHandle *phFeature)
 Retrieves a node from a category node using an index. More...
 
SPINNAKERC_API spinCategoryReleaseNode (spinNodeHandle hCategoryNode, spinNodeHandle hFeature)
 Releases the feature node from the category node. More...
 
SPINNAKERC_API spinRegisterGet (spinNodeHandle hNode, uint8_t *pBuf, int64_t length)
 Retrieves the value of a register node. More...
 
SPINNAKERC_API spinRegisterGetEx (spinNodeHandle hNode, bool8_t bVerify, bool8_t bIgnoreCache, uint8_t *pBuf, int64_t length)
 Retrieves the value of a register node; manually set whether to verify the node and whether to ignore the cache. More...
 
SPINNAKERC_API spinRegisterGetAddress (spinNodeHandle hNode, int64_t *pAddress)
 Retrieves the address of a register node. More...
 
SPINNAKERC_API spinRegisterGetLength (spinNodeHandle hNode, int64_t *pLength)
 Retrieves the length (in bytes) of the value of a register node. More...
 
SPINNAKERC_API spinRegisterSet (spinNodeHandle hNode, const uint8_t *pBuf, int64_t length)
 Sets the value of a register node. More...
 
SPINNAKERC_API spinRegisterSetEx (spinNodeHandle hNode, bool8_t bVerify, const uint8_t *pBuf, int64_t length)
 Sets the value of a register node; manually set whether to verify the node. More...
 
SPINNAKERC_API spinRegisterSetReference (spinNodeHandle hNode, spinNodeHandle hRef)
 Uses a second node as a reference for a register node. More...