Low Level API: Class for pylon USB3 Vision cameras providing access to stream grabber related methods and parameters. More...
#include <pylon/usb/PylonUsbCamera.h>
Public Member Functions | |
Construction | |
CPylonUsbStreamGrabber () | |
Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber. More... | |
CPylonUsbStreamGrabber (IStreamGrabber *pStreamGrabber) | |
Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber. More... | |
Some smart pointer functionality | |
virtual void | Attach (IStreamGrabber *) |
Attach a pylon stream grabber. | |
virtual bool | IsAttached () const |
Checks if a pylon stream grabber is attached. | |
virtual IStreamGrabber * | GetStreamGrabber () const |
Returns the pylon stream grabber interface pointer. | |
Some smart pointer functionality | |
virtual void | Attach (GenApi::INodeMap *, bool replace=false) |
Attach a pylon node map. | |
virtual GenApi::INodeMap * | GetNodeMap () const |
Returns the pylon node map interface pointer. | |
Implementation of the IStreamGrabber interface | |
See Pylon::IStreamGrabber for more details. | |
void | Open () |
Opens the stream grabber. More... | |
void | Close () |
Closes the stream grabber. More... | |
bool | IsOpen () const |
Retrieve whether the stream grabber is open. More... | |
StreamBufferHandle | RegisterBuffer (void *Buffer, size_t BufferSize) |
Registers a buffer for subsequent use. More... | |
const void * | DeregisterBuffer (StreamBufferHandle handle) |
Deregisters the buffer. More... | |
void | PrepareGrab () |
Prepares grabbing. More... | |
void | FinishGrab () |
Stops grabbing. More... | |
void | QueueBuffer (StreamBufferHandle Handle, const void *Context=NULL) |
Enqueues a buffer in the input queue. More... | |
void | CancelGrab () |
Cancels pending requests. More... | |
bool | RetrieveResult (GrabResult &Result) |
Retrieves a grab result from the output queue. More... | |
WaitObject & | GetWaitObject () const |
Returns the result event object. More... | |
GenApi::INodeMap * | GetNodeMap () |
Returns the associated stream grabber parameters. More... | |
Partial implementation of the INodeMap interface | |
See GENAPI_NAMESPACE::INodeMap for more details | |
void | GetNodes (GenApi::NodeList_t &Nodes) const |
GenApi::INode * | GetNode (const GenICam::gcstring &Name) const |
void | InvalidateNodes () const |
void | Poll (int64_t ElapsedTime) |
Public Attributes | |
Root - Interface to the USB-specific stream parameters. | |
GenApi::IInteger & | MaxNumBuffer |
The maximum number of buffers that can be used simultaneously. More... | |
GenApi::IInteger & | MaxBufferSize |
The maximum buffer size in bytes that can be registered. More... | |
GenApi::IInteger & | MaxTransferSize |
Controls the maximum size of USB transfers. More... | |
GenApi::IInteger & | NumMaxQueuedUrbs |
The maximum number of requests to be enqueued to the driver. More... | |
GenApi::IInteger & | TransferLoopThreadPriority |
The priority of the thread that handles USB requests of the stream interface. More... | |
GenApi::IInteger & | TransferTimeout |
Timeout in ms for payload and trailer transfers. More... | |
Statistic - Statistical data. | |
GenApi::IInteger & | Statistic_Total_Buffer_Count |
The total count of processed buffers. More... | |
GenApi::IInteger & | Statistic_Failed_Buffer_Count |
The count of buffers that returned with an error status. More... | |
GenApi::IInteger & | Statistic_Last_Failed_Buffer_Status |
The status code of the last failed buffer. More... | |
GenApi::IString & | Statistic_Last_Failed_Buffer_Status_Text |
The message text of the status code of the last failed buffer. More... | |
GenApi::IInteger & | Statistic_Missed_Frame_Count |
The count of bad or missed frames between successfully grabbed images. More... | |
GenApi::IInteger & | Statistic_Resynchronization_Count |
The count of stream resynchronizations. More... | |
GenApi::IInteger & | Statistic_Last_Block_Id |
The last grabbed block ID. More... | |
Low Level API: Class for pylon USB3 Vision cameras providing access to stream grabber related methods and parameters.
|
inline |
Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber.
|
inline |
Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber.
|
inlineinherited |
Cancels pending requests.
, resources remain allocated. Following, the results must be retrieved from the Output Queue.
|
inlineinherited |
Closes the stream grabber.
Flushes the result queue and stops the thread.
|
inlineinherited |
Deregisters the buffer.
Deregistering fails while the buffer is in use, so retrieve the buffer from the output queue after grabbing.
|
inlineinherited |
Stops grabbing.
Releases the resources and camera. Pending grab requests are canceled.
|
inlineinherited |
|
inlineinherited |
Returns the associated stream grabber parameters.
If no parameters are available, NULL is returned.
|
inlineinherited |
|
inlineinherited |
Returns the result event object.
This object is associated with the result queue. The event is signaled when queue is non-empty
|
inlineinherited |
|
inlineinherited |
Retrieve whether the stream grabber is open.
|
inlineinherited |
Opens the stream grabber.
|
inlineinherited |
|
inlineinherited |
Prepares grabbing.
Allocates resources, synchronizes with the camera and locks critical parameter
|
inlineinherited |
Enqueues a buffer in the input queue.
PrepareGrab is required to queue buffers. The context is returned together with the buffer and the grab result. It is not touched by the stream grabber. It is illegal to queue a buffer a second time before it is fetched from the result queue.
|
inlineinherited |
Registers a buffer for subsequent use.
Stream must be locked to register buffers The Buffer size may not exceed the value specified when PrepareGrab was called.
|
inlineinherited |
Retrieves a grab result from the output queue.
|
inherited |
The maximum buffer size in bytes that can be registered.
Visibility = Expert
|
inherited |
The maximum number of buffers that can be used simultaneously.
Visibility = Expert
|
inherited |
Controls the maximum size of USB transfers.
The default value is appropriate for most applications. Reducing the value may cause a higher CPU load. USB host adapter drivers may require to decrease the value in case the application fails to receive the image stream. The maximum value for the Maximum Transfer Size depends on the operating system version and may be limited by the host adapter drivers.
Visibility = Guru
|
inherited |
The maximum number of requests to be enqueued to the driver.
Visibility = Guru
|
inherited |
The count of buffers that returned with an error status.
Visibility = Expert
|
inherited |
The last grabbed block ID.
Visibility = Expert
|
inherited |
The status code of the last failed buffer.
Visibility = Expert
|
inherited |
The message text of the status code of the last failed buffer.
Visibility = Expert
|
inherited |
The count of bad or missed frames between successfully grabbed images.
Visibility = Expert
|
inherited |
The count of stream resynchronizations.
Visibility = Expert
|
inherited |
The total count of processed buffers.
Visibility = Expert
|
inherited |
The priority of the thread that handles USB requests of the stream interface.
Visibility = Guru
|
inherited |
Timeout in ms for payload and trailer transfers.
Timeout in ms for payload and trailer transfers.
\b Visibility = Invisible