#include <SpinnakerDirectShow.h>

Public Member Functions
Spinnaker Interface and Camera Functions
These functions deal with querying/setting generic interface and camera info.
virtual HRESULT	GetNumCameras (unsigned int *numCameras)=0
	Retrieves the number of cameras available for this Spinnaker DirectShow interface.

virtual HRESULT	GetSelectedCameraIndex (unsigned int *selectedIndex)=0
	Retrieves an integer index to the currently selected camera.

virtual HRESULT	SetSelectedCameraIndex (unsigned int index, bool needsRelease=true)=0
	Sets the currently selected camera to the index specified.

virtual HRESULT	GetCameraInfo (unsigned int index, char model, char type, char *serial, size_t bufferSize)=0
	Retrieves general information about the camera at the specified index.

virtual HRESULT	IsStreaming (bool *isStreaming)=0
	Checks if the selected camera is currently streaming.

virtual HRESULT	BeginAcquisition ()=0
	Starts the image acquisition engine for the currently selected camera.

virtual HRESULT	EndAcquisition ()=0
	Stops the image acquisition engine for the currently selected camera.

Spinnaker GenAPI Generic Functions
These functions deal with Spinnaker GenAPI NodeMap and Node Accesses for setting camera properties.
virtual HRESULT	NodeMapGetNumNodes (size_t *numNodes)=0
	Retrieves the number of nodes available in the node map for the currently selected camera.

virtual HRESULT	NodeMapGetNodeAtIndex (size_t index, char *nodeName, size_t bufferSize)=0
	Retrieves the string representation of the node at the specified index.

virtual HRESULT	NodeIsImplemented (const char nodeName, bool isImplemented)=0
	Checks if a node is implemented.

virtual HRESULT	NodeIsAvailable (const char nodeName, bool isAvailable)=0
	Checks if a node is available.

virtual HRESULT	NodeIsReadable (const char nodeName, bool isReadable)=0
	Checks if a node is readable.

virtual HRESULT	NodeIsWritable (const char nodeName, bool isWritable)=0
	Checks if a node is writable.

virtual HRESULT	NodeGetType (const char nodeName, char typeName, size_t bufferSize)=0
	Gets the type of the node.

virtual HRESULT	NodeToString (const char nodeName, char valueAsString, size_t bufferSize)=0
	Gets content of the node as string.

virtual HRESULT	NodeGetDisplayName (const char nodeName, char displayName, size_t bufferSize)=0
	Gets a name string for display.

Spinnaker GenAPI Integer Node Functions
These functions deal with Spinnaker GenAPI Integer Node Accesses
virtual HRESULT	IntegerGetValue (const char nodeName, int64_t value)=0
	Gets integer node value for the specified feature.

virtual HRESULT	IntegerSetValue (const char *nodeName, int64_t value)=0
	Sets integer node value for the specified feature.

virtual HRESULT	IntegerGetMax (const char nodeName, int64_t maxValue)=0
	Gets maximum integer value allowed for the specified feature.

virtual HRESULT	IntegerGetMin (const char nodeName, int64_t minValue)=0
	Gets minimum integer value allowed for the specified feature.

virtual HRESULT	IntegerGetIncMode (const char nodeName, Spinnaker::GenApi::EIncMode incMode)=0
	Gets integer increment mode for the specified feature.

virtual HRESULT	IntegerGetInc (const char nodeName, int64_t increment)=0
	Gets integer step increment for the specified feature.

Spinnaker GenAPI Float Node Functions
These functions deal with Spinnaker GenAPI Float Node Accesses
virtual HRESULT	FloatGetValue (const char nodeName, double value)=0
	Gets float node value for the specified feature.

virtual HRESULT	FloatSetValue (const char *nodeName, double value)=0
	Sets float node value for the specified feature.

virtual HRESULT	FloatGetMax (const char nodeName, double floatMax)=0
	Gets maximum float value allowed for the specified feature.

virtual HRESULT	FloatGetMin (const char nodeName, double floatMin)=0
	Gets minimum float value allowed for the specified feature.

virtual HRESULT	FloatGetIncMode (const char nodeName, Spinnaker::GenApi::EIncMode incMode)=0
	Gets float increment mode for the specified feature.

virtual HRESULT	FloatGetInc (const char nodeName, double increment)=0
	Gets float step increment for the specified feature.

Spinnaker GenAPI Boolean Node Functions
These functions deal with Spinnaker GenAPI Boolean Node Accesses
virtual HRESULT	BooleanGetValue (const char nodeName, bool value)=0
	Gets boolean node value for the specified feature.

virtual HRESULT	BooleanSetValue (const char *nodeName, bool value)=0
	Sets boolean node value for the specified feature.

Spinnaker GenAPI String Node Functions
These functions deal with Spinnaker GenAPI String Node Accesses
virtual HRESULT	StringGetValue (const char nodeName, char value, size_t bufferSize)=0
	Gets string node value for the specified feature.

virtual HRESULT	StringSetValue (const char nodeName, const char value)=0
	Sets string node value for the specified feature.

Spinnaker GenAPI Enumeration Node Functions
These functions deal with Spinnaker GenAPI Enumeration and EnumeratEntry Node Accesses
virtual HRESULT	EnumerationGetEntry (const char nodeName, char value, size_t bufferSize)=0
	Gets enumeration entry string for the specified enumeration feature.

virtual HRESULT	EnumerationSetEntry (const char nodeName, const char value)=0
	Sets enumeration entry for the specified enumeration feature.

virtual HRESULT	EnumerationEntryExists (const char enumerationName, const char enumerationEntryName, bool *entryExist)=0
	Checks if an enumeration entry exists for the specified enumeration feature.

virtual HRESULT	EnumerationGetNumEntries (const char enumerationName, size_t numEntries)=0
	Retrieves the number of enumeration entry nodes available for the specified enumeration feature.

virtual HRESULT	EnumerationGetEntryAtIndex (const char enumerationName, unsigned int entryIndex, char enumerationEntryName, size_t bufferSize)=0
	Gets enumeration entry string for the specified enumeration feature at the specified index.

Spinnaker GenAPI Command Node Functions
These functions deal with Spinnaker GenAPI Command Node Accesses
virtual HRESULT	CommandExecute (const char *nodeName)=0
	Executes the command for the specified feature.

Detailed Description

Examples: SpinSimpleGUI_DirectShow.cpp.

Member Function Documentation

◆ BeginAcquisition()

virtual HRESULT BeginAcquisition ( )

pure virtual

Starts the image acquisition engine for the currently selected camera.

Nothing occurs if the camera is already streaming.

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

◆ BooleanGetValue()

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

◆ BooleanSetValue()

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

◆ CommandExecute()

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

◆ EndAcquisition()

virtual HRESULT EndAcquisition ( )

pure virtual

Stops the image acquisition engine for the currently selected camera.

Nothing occurs if there were no prior call to BeginAcquisition(). Note that EndAcquisition() needs to be called before selecting a new camera.

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

◆ EnumerationEntryExists()

virtual HRESULT EnumerationEntryExists	(	const char *	enumerationName,
		const char *	enumerationEntryName,
		bool *	entryExist
	)

pure virtual

Checks if an enumeration entry exists for the specified enumeration feature.

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.

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ EnumerationGetEntry()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ EnumerationGetEntryAtIndex()

virtual HRESULT EnumerationGetEntryAtIndex	(	const char *	enumerationName,
		unsigned int	entryIndex,
		char *	enumerationEntryName,
		size_t	bufferSize
	)

pure virtual

Gets enumeration entry string for the specified enumeration feature at the specified index.

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.

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ EnumerationGetNumEntries()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ EnumerationSetEntry()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ FloatGetInc()

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

◆ FloatGetIncMode()

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

◆ FloatGetMax()

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

◆ FloatGetMin()

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

◆ FloatGetValue()

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

◆ FloatSetValue()

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

◆ GetCameraInfo()

virtual HRESULT GetCameraInfo	(	unsigned int	index,
		char *	model,
		char *	type,
		char *	serial,
		size_t	bufferSize
	)

pure virtual

Retrieves general information about the camera at the specified index.

Parameters

index	The index at which to retrieve the camera information
model	Model description of the camera
type	Transport layer description of the camera
serial	Serial number of the camera
bufferSize	Size of the individual provided model, sensor, serial buffer in bytes

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ GetNumCameras()

virtual HRESULT GetNumCameras ( unsigned int * numCameras )

pure virtual

Retrieves the number of cameras available for this Spinnaker DirectShow interface.

Parameters

numCameras An integer that represents the number of cameras discovered

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ GetSelectedCameraIndex()

virtual HRESULT GetSelectedCameraIndex ( unsigned int * selectedIndex )

pure virtual

Retrieves an integer index to the currently selected camera.

Parameters

selectedIndex An integer that represents the index of the selected camera

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ IntegerGetInc()

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

◆ IntegerGetIncMode()

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

◆ IntegerGetMax()

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

◆ IntegerGetMin()

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

◆ IntegerGetValue()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ IntegerSetValue()

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

◆ IsStreaming()

virtual HRESULT IsStreaming ( bool * isStreaming )

pure virtual

Checks if the selected camera is currently streaming.

Parameters

isStreaming Flag indicating whether camera is streaming or not

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

◆ NodeGetDisplayName()

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

◆ NodeGetType()

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

◆ NodeIsAvailable()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ NodeIsImplemented()

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

◆ NodeIsReadable()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ NodeIsWritable()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ NodeMapGetNodeAtIndex()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ NodeMapGetNumNodes()

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

Examples: SpinSimpleGUI_DirectShow.cpp.

◆ NodeToString()

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

◆ SetSelectedCameraIndex()

virtual HRESULT SetSelectedCameraIndex	(	unsigned int	index,
		bool	needsRelease = `true`
	)

pure virtual

Sets the currently selected camera to the index specified.

This function will do nothing if the selected index is out of range.

Parameters

index	The index at which to retrieve the camera object
needsRelease	Specifies whether to release the previously selected camera object

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

◆ StringGetValue()

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

◆ StringSetValue()

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

The documentation for this interface was generated from the following file:

include/SpinnakerDirectShow.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ BeginAcquisition()

◆ BooleanGetValue()

◆ BooleanSetValue()

◆ CommandExecute()

◆ EndAcquisition()

◆ EnumerationEntryExists()

◆ EnumerationGetEntry()

◆ EnumerationGetEntryAtIndex()

◆ EnumerationGetNumEntries()

◆ EnumerationSetEntry()

◆ FloatGetInc()

◆ FloatGetIncMode()

◆ FloatGetMax()

◆ FloatGetMin()

◆ FloatGetValue()

◆ FloatSetValue()

◆ GetCameraInfo()

◆ GetNumCameras()

◆ GetSelectedCameraIndex()

◆ IntegerGetInc()

◆ IntegerGetIncMode()

◆ IntegerGetMax()

◆ IntegerGetMin()

◆ IntegerGetValue()

◆ IntegerSetValue()

◆ IsStreaming()

◆ NodeGetDisplayName()

◆ NodeGetType()

◆ NodeIsAvailable()

◆ NodeIsImplemented()

◆ NodeIsReadable()

◆ NodeIsWritable()

◆ NodeMapGetNodeAtIndex()

◆ NodeMapGetNumNodes()

◆ NodeToString()

◆ SetSelectedCameraIndex()

◆ StringGetValue()

◆ StringSetValue()