Spinnaker C++
4.0.0.116
Functions | Variables
SpinnakerDirectShow.h

Global header file for Spinnaker DirectShow library. More...

Functions

STDMETHOD() GetSelectedCameraIndex (unsigned int *selectedIndex)=0
 Retrieves an integer index to the currently selected camera. More...
 
STDMETHOD() SetSelectedCameraIndex (unsigned int index, bool needsRelease=true)=0
 Sets the currently selected camera to the index specified. More...
 
STDMETHOD() GetCameraInfo (unsigned int index, char *model, char *type, char *serial, size_t bufferSize)=0
 Retrieves general information about the camera at the specified index. More...
 
STDMETHOD() IsStreaming (bool *isStreaming)=0
 Checks if the selected camera is currently streaming. More...
 
STDMETHOD() BeginAcquisition ()=0
 Starts the image acquisition engine for the currently selected camera. More...
 
STDMETHOD() EndAcquisition ()=0
 Stops the image acquisition engine for the currently selected camera. More...
 

Variables

static const GUID IID_ISpinnakerInterface
 This is the Interface that allows users to get and set device node properties on the camera. More...
 

Detailed Description

Global header file for Spinnaker DirectShow library.

By including this file, all required header files for full Spinnaker DirectShow operation will be included automatically. It is recommended that this file be used instead of manually including individual header files.

We welcome your bug reports, suggestions, and comments: https://www.flir.com/support-center/rma/iis-support-request

Function Documentation

STDMETHOD() 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.
STDMETHOD() 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.
STDMETHOD() 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
indexThe index at which to retrieve the camera information
modelModel description of the camera
typeTransport layer description of the camera
serialSerial number of the camera
bufferSizeSize of the individual provided model, sensor, serial buffer in bytes
Returns
An HRESULT indicating the success or failure of the function.
STDMETHOD() GetSelectedCameraIndex ( unsigned int *  selectedIndex)
pure virtual

Retrieves an integer index to the currently selected camera.

Parameters
selectedIndexAn integer that represents the index of the selected camera
Returns
An HRESULT indicating the success or failure of the function.
STDMETHOD() IsStreaming ( bool *  isStreaming)
pure virtual

Checks if the selected camera is currently streaming.

Parameters
isStreamingFlag indicating whether camera is streaming or not
Returns
An HRESULT indicating the success or failure of the function.
STDMETHOD() 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
indexThe index at which to retrieve the camera object
needsReleaseSpecifies whether to release the previously selected camera object
Returns
An HRESULT indicating the success or failure of the function.

Variable Documentation

const GUID IID_ISpinnakerInterface
static
Initial value:
= {0x5143ad36,
0x51d1,
0x422d,
{0x9b, 0x17, 0x81, 0xdd, 0x3d, 0xb0, 0x60, 0xe}}

This is the Interface that allows users to get and set device node properties on the camera.

You can query the SpinnakerDirectShow Capture Filter for IID_ISpinnakerInterface and it will return a pointer to the ISpinnakerInterface interface. The GUID is equivalent to {5143AD36-51D1-422D-9B17-81DD3DB0600E}.

Examples:
SpinSimpleGUI_DirectShow.cpp.
Contact Support Spinnaker® SDK Programmer's Guide and API Reference