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

Detailed Description

Function Documentation

STDMETHOD() BooleanGetValue	(	const char *	nodeName,
		bool *	value
	)

pure virtual

Gets boolean node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() BooleanSetValue	(	const char *	nodeName,
		bool	value
	)

pure virtual

Sets boolean node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value to set to device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() CommandExecute ( const char * nodeName )

pure virtual

Executes the command for the specified feature.

Parameters

nodeName GenICam device feature name

Returns: An HRESULT error code indicating the success or failure of the function.

STDMETHOD() EnumerationGetEntry	(	const char *	nodeName,
		char *	value,
		size_t	bufferSize
	)

pure virtual

Gets enumeration entry string for the specified enumeration feature.

Parameters

nodeName	GenICam device feature name
value	The enumeration entry string read from the device
bufferSize	Size of the provided value buffer in bytes

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() EnumerationGetNumEntries	(	const char *	enumerationName,
		size_t *	numEntries
	)

pure virtual

Retrieves the number of enumeration entry nodes available for the specified enumeration feature.

Parameters

enumerationName	GenICam device enumeration feature name
numEntries	Number of nodes available for the specified enumeration feature

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() EnumerationSetEntry	(	const char *	nodeName,
		const char *	value
	)

pure virtual

Sets enumeration entry for the specified enumeration feature.

Parameters

nodeName	GenICam device feature name
value	The enumeration entry string to set to device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatGetInc	(	const char *	nodeName,
		double *	increment
	)

pure virtual

Gets float step increment for the specified feature.

Parameters

nodeName	GenICam device feature name
increment	The step increment value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatGetIncMode	(	const char *	nodeName,
		Spinnaker::GenApi::EIncMode *	incMode
	)

pure virtual

Gets float increment mode for the specified feature.

Parameters

nodeName	GenICam device feature name
incMode	Spinnaker GenAPI increment mode for the specified feature

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatGetMax	(	const char *	nodeName,
		double *	floatMax
	)

pure virtual

Gets maximum float value allowed for the specified feature.

Parameters

nodeName	GenICam device feature name
floatMax	The maximum allowed value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatGetMin	(	const char *	nodeName,
		double *	floatMin
	)

pure virtual

Gets minimum float value allowed for the specified feature.

Parameters

nodeName	GenICam device feature name
floatMin	The minimum allowed value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatGetValue	(	const char *	nodeName,
		double *	value
	)

pure virtual

Gets float node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() FloatSetValue	(	const char *	nodeName,
		double	value
	)

pure virtual

Sets float node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value to set to device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerGetInc	(	const char *	nodeName,
		int64_t *	increment
	)

pure virtual

Gets integer step increment for the specified feature.

Parameters

nodeName	GenICam device feature name
increment	The step increment value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerGetIncMode	(	const char *	nodeName,
		Spinnaker::GenApi::EIncMode *	incMode
	)

pure virtual

Gets integer increment mode for the specified feature.

Parameters

nodeName	GenICam device feature name
incMode	Spinnaker GenAPI increment mode for the specified feature

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerGetMax	(	const char *	nodeName,
		int64_t *	maxValue
	)

pure virtual

Gets maximum integer value allowed for the specified feature.

Parameters

nodeName	GenICam device feature name
maxValue	The maximum allowed value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerGetMin	(	const char *	nodeName,
		int64_t *	minValue
	)

pure virtual

Gets minimum integer value allowed for the specified feature.

Parameters

nodeName	GenICam device feature name
minValue	The minimum allowed value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerGetValue	(	const char *	nodeName,
		int64_t *	value
	)

pure virtual

Gets integer node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value read from the device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() IntegerSetValue	(	const char *	nodeName,
		int64_t	value
	)

pure virtual

Sets integer node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value to set to device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeGetDisplayName	(	const char *	nodeName,
		char *	displayName,
		size_t	bufferSize
	)

pure virtual

Gets a name string for display.

Parameters

nodeName	GenICam device feature name
displayName	Display name of the device feature
bufferSize	Size of the provided displayName buffer in bytes

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeGetType	(	const char *	nodeName,
		char *	typeName,
		size_t	bufferSize
	)

pure virtual

Gets the type of the node.

Parameters

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

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeIsAvailable	(	const char *	nodeName,
		bool *	isAvailable
	)

pure virtual

Checks if a node is available.

Parameters

nodeName	GenICam device feature name
isAvailable	Flag indicating whether node is available or not

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeIsImplemented	(	const char *	nodeName,
		bool *	isImplemented
	)

pure virtual

Checks if a node is implemented.

Parameters

nodeName	GenICam device feature name
isImplemented	Flag indicating whether node is implemented or not

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeIsReadable	(	const char *	nodeName,
		bool *	isReadable
	)

pure virtual

Checks if a node is readable.

Parameters

nodeName	GenICam device feature name
isReadable	Flag indicating whether node is readable or not

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeIsWritable	(	const char *	nodeName,
		bool *	isWritable
	)

pure virtual

Checks if a node is writable.

Parameters

nodeName	GenICam device feature name
isWritable	Flag indicating whether node is writable or not

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeMapGetNodeAtIndex	(	size_t	index,
		char *	nodeName,
		size_t	bufferSize
	)

pure virtual

Retrieves the string representation of the node at the specified index.

Parameters

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

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeMapGetNumNodes ( size_t * numNodes )

pure virtual

Retrieves the number of nodes available in the node map for the currently selected camera.

Parameters

numNodes Number of nodes available for the currently selected device

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() NodeToString	(	const char *	nodeName,
		char *	valueAsString,
		size_t	bufferSize
	)

pure virtual

Gets content of the node as string.

Parameters

nodeName	GenICam device feature name
valueAsString	String representation of the node value
bufferSize	Size of the provided valueAsString buffer in bytes

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() StringGetValue	(	const char *	nodeName,
		char *	value,
		size_t	bufferSize
	)

pure virtual

Gets string node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value read from the device
bufferSize	Size of the provided value buffer in bytes

Returns: An HRESULT indicating the success or failure of the function.

STDMETHOD() StringSetValue	(	const char *	nodeName,
		const char *	value
	)

pure virtual

Sets string node value for the specified feature.

Parameters

nodeName	GenICam device feature name
value	The value to set to device

Returns: An HRESULT indicating the success or failure of the function.

Variable Documentation

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.

Parameters

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

Returns: An HRESULT indicating the success or failure of the function.

Parameters

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

Returns: An HRESULT indicating the success or failure of the function.

const uint64_t EVENT_TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF

const uint64_t EVENT_TIMEOUT_NONE = 0

Timeout values for getting next image, device, or interface event.

Modules

Classes

Variables

Spinnaker GenAPI Functions

Integer Node Functions

Float Node Functions

Boolean Node Functions

String Node Functions

Enumeration Node Functions

Command Node Functions

Detailed Description

Function Documentation

Variable Documentation