The functions in this section provide access to information and objects retrieved from nodes. This includes node properties and callback registration. More...

Functions
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...

Detailed Description

The functions in this section provide access to information and objects retrieved from nodes. This includes node properties and callback registration.

Function Documentation

◆ spinNodeDeregisterCallback()

SPINNAKERC_API spinNodeDeregisterCallback	(	spinNodeHandle	hNode,
		spinNodeCallbackHandle	hCb
	)

Unregisters a callback from a node.

See also: spinError

Parameters

hNode	The node from which to unregister the callback
hCb	The callback handle to unregister

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

Examples: NodeMapCallback_C.c.

◆ spinNodeGetAccessMode()

SPINNAKERC_API spinNodeGetAccessMode	(	spinNodeHandle	hNode,
		spinAccessMode *	pAccessMode
	)

Retrieves the access mode of a node (as an enum, spinAccessMode)

See also: spinError; spinAccessMode

Parameters

hNode	The node of the access mode to retrieve
pAccessMode	The access mode enum pointer in which the access mode is returned

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

◆ spinNodeGetCachingMode()

SPINNAKERC_API spinNodeGetCachingMode	(	spinNodeHandle	hNode,
		spinCachingMode *	pCachingMode
	)

Retrieves the caching mode of a node (as an enum, spinCachingMode)

See also: spinError; spinCachingMode

Parameters

hNode	The node of the caching mode to retrieve
pCachingMode	The caching mode enum pointer in which the caching mode is returned

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

◆ spinNodeGetDescription()

SPINNAKERC_API spinNodeGetDescription	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves a longer description of a node.

See also: spinError

Parameters

hNode	The node of the description to retrieve
pBuf	The c-string character buffer in which the longer descrition of the node is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

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

◆ spinNodeGetDisplayName()

SPINNAKERC_API spinNodeGetDisplayName	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the display name of a node (whitespace possible)

See also: spinError

Parameters

hNode	The node of the display name to retrieve
pBuf	The c-string character buffer in which the display name of the node is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

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

Examples: ChunkData_C.c, NodeMapCallback_C.c, and NodeMapInfo_C.c.

◆ spinNodeGetImposedAccessMode()

SPINNAKERC_API spinNodeGetImposedAccessMode	(	spinNodeHandle	hNode,
		spinAccessMode	imposedAccessMode
	)

Retrieves the imposed access mode of a node.

See also: spinError

Parameters

hNode	The node of the imposed access mode to retrieve
imposedAccessMode	The access mode enum pointer in which the imposed access mode is returned

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

◆ spinNodeGetImposedVisibility()

SPINNAKERC_API spinNodeGetImposedVisibility	(	spinNodeHandle	hNode,
		spinVisibility	imposedVisibility
	)

Retrieves the imposed visibility of a node.

See also: spinError

Parameters

hNode	The node of the visibility to impose
imposedVisibility	The visibility enum pointer in which the imposed visibility is returned

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

◆ spinNodeGetName()

SPINNAKERC_API spinNodeGetName	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the name of a node (no whitespace)

See also: spinError

Parameters

hNode	The node of the name to retrieve
pBuf	The c-string character buffer in which the name of the node is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinNodeGetNameSpace()

SPINNAKERC_API spinNodeGetNameSpace	(	spinNodeHandle	hNode,
		spinNameSpace *	pNamespace
	)

Retrieve the namespace of a node (as an enum, spinNameSpace)

See also: spinError; spinNameSpace

Parameters

hNode	The node of the namespace to retrieve
pNamespace	The namespace enum pointer in which the namespace is returned

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

◆ spinNodeGetPollingTime()

SPINNAKERC_API spinNodeGetPollingTime	(	spinNodeHandle	hNode,
		int64_t *	pPollingTime
	)

Retrieve the polling time of a node.

See also: spinError

Parameters

hNode	The node of the polling time to retrieve
pPollingTime	The integer pointer in which the polling time is returned

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

◆ spinNodeGetToolTip()

SPINNAKERC_API spinNodeGetToolTip	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves a short description of a node.

See also: spinError

Parameters

hNode	The node of the tooltip to retrieve
pBuf	The c-string character buffer in which the short description of the node is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

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

Examples: NodeMapInfo_C.c.

◆ spinNodeGetType()

SPINNAKERC_API spinNodeGetType	(	spinNodeHandle	hNode,
		spinNodeType *	pType
	)

Retrieves the type of a node (as an enum, spinNodeType)

See also: spinError; spinNodeType

Parameters

hNode	The node of the node type to retrieve
pType	The node type enum pointer in which the type of node is returned

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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinNodeGetVisibility()

SPINNAKERC_API spinNodeGetVisibility	(	spinNodeHandle	hNode,
		spinVisibility *	pVisibility
	)

Retrieves the recommended visibility of a node (as an enum, spinVisibility)

See also: spinError; spinVisibility

Parameters

hNode	The node of the visibility to retrieve
pVisibility	The visibility enum pointer in which the visibility is returned

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

◆ spinNodeInvalidateNode()

SPINNAKERC_API spinNodeInvalidateNode ( spinNodeHandle hNode )

Invalidates a node in case its values may have changed, rendering it no longer valid.

See also: spinError

Parameters

hNode The node whose values may have changed

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

◆ spinNodeIsAvailable()

SPINNAKERC_API spinNodeIsAvailable	(	spinNodeHandle	hNode,
		bool8_t *	pbResult
	)

Checks whether a node is available.

See also: spinError

Parameters

hNode	The node to check
pbResult	The boolean pointer to return whether or not the node is available

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

◆ spinNodeIsEqual()

SPINNAKERC_API spinNodeIsEqual	(	spinNodeHandle	hNodeFirst,
		spinNodeHandle	hNodeSecond,
		bool8_t *	pbResult
	)

Checks whether two nodes are equal.

See also: spinError

Parameters

hNodeFirst	The first node to check
hNodeSecond	The second node to check
pbResult	The boolean pointer to return whether or not the two nodes are equal

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

◆ spinNodeIsImplemented()

SPINNAKERC_API spinNodeIsImplemented	(	spinNodeHandle	hNode,
		bool8_t *	pbResult
	)

Checks whether a node is implemented.

See also: spinError

Parameters

hNode	The node to check
pbResult	The boolean pointer to return whether or not the node is implemented

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

◆ spinNodeIsReadable()

SPINNAKERC_API spinNodeIsReadable	(	spinNodeHandle	hNode,
		bool8_t *	pbResult
	)

Checks whether a node is readable.

See also: spinError

Parameters

hNode	The node to check
pbResult	The boolean pointer to return whether or not the node is readable

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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, Enumeration_C_QuickSpin.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinNodeIsWritable()

SPINNAKERC_API spinNodeIsWritable	(	spinNodeHandle	hNode,
		bool8_t *	pbResult
	)

Checks whether a node is writable.

See also: spinError

Parameters

hNode	The node to check
pbResult	The boolean pointer to return whether or not the node is writable

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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, ImageEvents_C.c, ImageFormatControl_C.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, and Trigger_C.c.

◆ spinNodeRegisterCallback()

SPINNAKERC_API spinNodeRegisterCallback	(	spinNodeHandle	hNode,
		spinNodeCallbackFunction	pCbFunction,
		spinNodeCallbackHandle *	phCb
	)

Registers a callback to a node.

See also: spinError

Parameters

hNode	The node on which to register the callback
pCbFunction	The function pointer of the function that will execute when the callback is triggered; must match signature "void spinNodeCallbackFunction(spinNodeHandle hNode)"
phCb	The callback handle pointer in which the callback is returned; used to unregister callbacks

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

Examples: NodeMapCallback_C.c.

Functions

Detailed Description

Function Documentation

◆ spinNodeDeregisterCallback()

◆ spinNodeGetAccessMode()

◆ spinNodeGetCachingMode()

◆ spinNodeGetDescription()

◆ spinNodeGetDisplayName()

◆ spinNodeGetImposedAccessMode()

◆ spinNodeGetImposedVisibility()

◆ spinNodeGetName()

◆ spinNodeGetNameSpace()

◆ spinNodeGetPollingTime()

◆ spinNodeGetToolTip()

◆ spinNodeGetType()

◆ spinNodeGetVisibility()

◆ spinNodeInvalidateNode()

◆ spinNodeIsAvailable()

◆ spinNodeIsEqual()

◆ spinNodeIsImplemented()

◆ spinNodeIsReadable()

◆ spinNodeIsWritable()

◆ spinNodeRegisterCallback()