nvsipl::INvSIPLClient Class Reference

Detailed Description

Defines the public data structures and describes the interfaces for NvSIPL Client (libnvsipl.so).

Definition at line 50 of file NvSIPLClient.hpp.

Data Structures
struct	ClientDesc
	Describes a client of the pipeline. More...
struct	ConsumerDesc
	Defines a consumer of the output of the SIPL pipeline. More...
struct	ImageMetaData
	Defines the metadata associated with the image. More...
class	INvMCallback
	Describes a class with callback functions that must be implemented by the consumer of the SIPL image processing pipeline. More...
class	INvSIPLBuffer
	Describes the interfaces of SIPL buffer. More...
class	INvSIPLNvMBuffer
	Describes a SIPL buffer containing an NvMediaImage or NvMediaImageGroup. More...

Public Member Functions
virtual SIPLStatus	Init (ClientDesc *pDesc, INvMCallback *pCallback)=0
	Initializes NvSIPL Client (libnvsipl.so). More...
virtual SIPLStatus	Start (void)=0
	Starts NvSIPL Client (libnvsipl.so). More...
virtual SIPLStatus	Stop (void)=0
	Stops NvSIPL Client (libnvsipl.so). More...
virtual SIPLStatus	Deinit (void)=0
	De-initializes NvSIPL Client (libnvsipl.so). More...
virtual	~INvSIPLClient (void)=default
	Default destructor. More...

Static Public Member Functions
static std::unique_ptr < INvSIPLClient >	Create ()
	Create an instance of NvSIPL Client (libnvsipl.so). More...

Constructor & Destructor Documentation

virtual nvsipl::INvSIPLClient::~INvSIPLClient ( void  )

virtualdefault

Default destructor.

Member Function Documentation

static std::unique_ptr<INvSIPLClient> nvsipl::INvSIPLClient::Create ( )

static

Create an instance of NvSIPL Client (libnvsipl.so).

Static function to create an instance of implementation class and return handle. The object is automatically destroyed when the variable holding the return value goes out of scope.

Returns

unique_ptr A handle to an INvSIPLClient instance.

virtual SIPLStatus nvsipl::INvSIPLClient::Deinit ( void  )

pure virtual

De-initializes NvSIPL Client (libnvsipl.so).

Returns

SIPLStatus. The completion status of the operation.

virtual SIPLStatus nvsipl::INvSIPLClient::Init ( ClientDesc *  pDesc, INvMCallback *  pCallback  )

pure virtual

Initializes NvSIPL Client (libnvsipl.so).

Parameters

[in]	pDesc	Pointer ClientDesc returned by INvSIPLCamera::GetClientDesc
[in]	pCallback	A pointer to user implemented object of a class inheriting INvMCallback

Returns

SIPLStatus. The completion status of the operation.

virtual SIPLStatus nvsipl::INvSIPLClient::Start ( void  )

pure virtual

Starts NvSIPL Client (libnvsipl.so).

The function is a placeholder for any operations that are necessary before NvSIPL Client (libnvsipl.so) starts streaming out the buffer.

Currently there is no impact of calling this API.

Returns

SIPLStatus. The completion status of the operation.

virtual SIPLStatus nvsipl::INvSIPLClient::Stop ( void  )

pure virtual

Stops NvSIPL Client (libnvsipl.so).

The function is a placeholder for any operations that are necessary before NvSIPL Client (libnvsipl.so) stops streaming out the buffer.

Currently there is no impact of calling this API.

Returns

SIPLStatus. The completion status of the operation.

---

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

• NvSIPLClient.hpp