Jetson Linux API Reference

39.2 Release
NvFusaCaptureExternal::INvFusaCaptureHandler Class Referenceabstract

Detailed Description

Interface INvFusaCaptureHandler, the common interface for all captures handlers.

The typical flow is expected to be as follows:

Init:

Running loop:

De-init:

Notes:

  • Keep as many captures in flight as possible. (For Camera over ethernet use cases, this is 4).
  • Do not block the running loop. As long as the sensor is producing data, it is imperative to enqueue new captures.
  • Consequentially, timeouts should be appropriate such that it is better to encounter a timeout and discard the capture in a timely manner, rather than wait too long and stall the pipeline.

Definition at line 57 of file NvFusaCaptureExternal.hpp.

Inheritance diagram for NvFusaCaptureExternal::INvFusaCaptureHandler:

Public Member Functions

virtual NvFusaCaptureStatus registerBuffer (NvSciBufObj &buffer) const =0
 Registers a buffer with the capture handler. More...
 
virtual NvFusaCaptureStatus unregisterBuffer (NvSciBufObj &buffer) const =0
 Unregisters a buffer with the capture handler. More...
 
virtual NvFusaCaptureStatus startCapture (NvSciBufObj &buffer)
 Enqueue a capture to handler. More...
 
virtual NvFusaCaptureStatus getCaptureStatus (NvSciBufObj &buffer, const uint32_t timeout)
 Gets the capture status. More...
 
virtual ~INvFusaCaptureHandler ()=default
 
 INvFusaCaptureHandler (INvFusaCaptureHandler &other)=delete
 
INvFusaCaptureHandler & operator= (INvFusaCaptureHandler &other) &=delete
 
 INvFusaCaptureHandler (INvFusaCaptureHandler &&other)=delete
 
INvFusaCaptureHandler & operator= (INvFusaCaptureHandler &&other) &=delete
 

Protected Member Functions

 INvFusaCaptureHandler ()=default
 

Constructor & Destructor Documentation

◆ INvFusaCaptureHandler()

NvFusaCaptureExternal::INvFusaCaptureHandler::INvFusaCaptureHandler ( )
protecteddefault

Member Function Documentation

◆ getCaptureStatus()

virtual NvFusaCaptureStatus NvFusaCaptureExternal::INvFusaCaptureHandler::getCaptureStatus ( NvSciBufObj &  buffer,
const uint32_t  timeout 
)
inlinevirtual

Gets the capture status.

For an enqueued capture, wait up to the timeout for the capture to complete.

Parameters
[in]bufferEnqueued buffer to get capture status for.
[in]timeoutTimeout in milliseconds. A timeout of 0 is not allowed.
Returns
NvFusaCaptureStatus enum value.

Reimplemented in NvFusaCaptureExternal::INvFusaCaptureCoeHandler.

Definition at line 107 of file NvFusaCaptureExternal.hpp.

References NvFusaCaptureExternal::NOT_SUPPORTED.

◆ registerBuffer()

virtual NvFusaCaptureStatus NvFusaCaptureExternal::INvFusaCaptureHandler::registerBuffer ( NvSciBufObj &  buffer) const
pure virtual

Registers a buffer with the capture handler.

Buffers must be registered before starting a capture.

Parameters
[in]bufferThe buffer to register.
Returns
NvFusaCaptureStatus enum value.

◆ startCapture()

virtual NvFusaCaptureStatus NvFusaCaptureExternal::INvFusaCaptureHandler::startCapture ( NvSciBufObj &  buffer)
inlinevirtual

Enqueue a capture to handler.

Alerts HW that a capture is enabled for the enqueued buffer.

Parameters
[in]bufferRegistered buffer to enqueue for capture.
Returns
NvFusaCaptureStatus enum value.

Reimplemented in NvFusaCaptureExternal::INvFusaCaptureCoeHandler.

Definition at line 92 of file NvFusaCaptureExternal.hpp.

References NvFusaCaptureExternal::NOT_SUPPORTED.

◆ unregisterBuffer()

virtual NvFusaCaptureStatus NvFusaCaptureExternal::INvFusaCaptureHandler::unregisterBuffer ( NvSciBufObj &  buffer) const
pure virtual

Unregisters a buffer with the capture handler.

Buffers must be unregistered during de-initialization for each that was registered. Buffers may be unregistered during runtime as consumer applications see fit.

Parameters
[in]bufferThe buffer to unregister.
Returns
NvFusaCaptureStatus enum value.

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