Jetson Linux API Reference

39.2 Release
NvFusaCaptureExternal::INvFusaCaptureCoeHandler Class Referenceabstract

Detailed Description

Interface INvFusaCaptureCoeHandler, the interface for camera over ethernet (CoE) handlers.

Definition at line 129 of file NvFusaCaptureExternal.hpp.

Inheritance diagram for NvFusaCaptureExternal::INvFusaCaptureCoeHandler:
Collaboration diagram for NvFusaCaptureExternal::INvFusaCaptureCoeHandler:

Public Member Functions

virtual uint8_t getChannelNumber (void) const noexcept=0
 Gets the channel number assigned to the CoE handler. More...
 
virtual NvFusaCaptureStatus startCapture (NvSciBufObj &buffer) override=0
 
virtual NvFusaCaptureStatus getCaptureStatus (NvSciBufObj &buffer, const uint32_t timeout) override=0
 
 ~INvFusaCaptureCoeHandler () override=default
 
 INvFusaCaptureCoeHandler (INvFusaCaptureCoeHandler &other)=delete
 
INvFusaCaptureCoeHandler & operator= (INvFusaCaptureCoeHandler &other) &=delete
 
 INvFusaCaptureCoeHandler (INvFusaCaptureCoeHandler &&other)=delete
 
INvFusaCaptureCoeHandler & operator= (INvFusaCaptureCoeHandler &&other) &=delete
 
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...
 

Protected Member Functions

 INvFusaCaptureCoeHandler ()
 

Constructor & Destructor Documentation

◆ INvFusaCaptureCoeHandler()

NvFusaCaptureExternal::INvFusaCaptureCoeHandler::INvFusaCaptureCoeHandler ( )
inlineprotected

Definition at line 158 of file NvFusaCaptureExternal.hpp.

Member Function Documentation

◆ getChannelNumber()

virtual uint8_t NvFusaCaptureExternal::INvFusaCaptureCoeHandler::getChannelNumber ( void  ) const
pure virtualnoexcept

Gets the channel number assigned to the CoE handler.

Returns
The channel number. [4-8] Range expected.

◆ registerBuffer()

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

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.

◆ unregisterBuffer()

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

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: