DriveWorks SDK Reference
5.16.65 Release
For Test and Development only

SensorPlugin.h File Reference

Detailed Description

NVIDIA DriveWorks: Sensor Plugin Interface to interact with live sensors

Description: This file defines the interfaces to be implemented for live sensor plugins.

Definition in file SensorPlugin.h.

Go to the source code of this file.

Data Structures

struct  dwSensorPluginFunctions
 Function Table exposing sensor plugin functions. More...
 

Macros

#define SENSOR_PLUGIN_COMMON_FUNCTIONS
 

Typedefs

typedef dwStatus(* dwSensorPlugin_initializeHandle) (dwSensorPluginSensorHandle_t *handle, char const *params, dwContextHandle_t ctx)
 Initialize a new handle to the sensor managed by the plugin module. More...
 

Functions

DW_API_PUBLIC dwStatus dwSAL_registerSensorPlugin (dwSensorType sensorType, char const *codecMimeType, void const *funcTable, dwSALHandle_t const sal)
 Register sensor plugin which works with live sensors. More...
 

Data Structure Documentation

◆ dwSensorPluginFunctions

struct dwSensorPluginFunctions
Data Fields
SENSOR_PLUGIN_COMMON_FUNCTIONS

Macro Definition Documentation

◆ SENSOR_PLUGIN_COMMON_FUNCTIONS

#define SENSOR_PLUGIN_COMMON_FUNCTIONS
Value:
dwSensorPlugin_initializeHandle initializeHandle; \
dwSensorPlugin_release release; \
dwSensorPlugin_start start; \
dwSensorPlugin_stop stop; \
dwSensorPlugin_reset reset; \
dwSensorPlugin_readRawData readRawData; \
dwSensorPlugin_returnRawData returnRawData
dwStatus(* dwSensorPlugin_initializeHandle)(dwSensorPluginSensorHandle_t *handle, char const *params, dwContextHandle_t ctx)
Initialize a new handle to the sensor managed by the plugin module.
Definition: SensorPlugin.h:62

Definition at line 65 of file SensorPlugin.h.

Typedef Documentation

◆ dwSensorPlugin_initializeHandle

typedef dwStatus(* dwSensorPlugin_initializeHandle) (dwSensorPluginSensorHandle_t *handle, char const *params, dwContextHandle_t ctx)

Initialize a new handle to the sensor managed by the plugin module.

Parameters
[out]handleA pointer to sensor handle.
[in]paramsSpecifies the parameters for the sensor.
[in]ctxcontext handle.
Returns
DW_INVALID_ARGUMENT - if pointer to the sensor handle is NULL.
DW_SUCCESS

Definition at line 62 of file SensorPlugin.h.

Function Documentation

◆ dwSAL_registerSensorPlugin()

DW_API_PUBLIC dwStatus dwSAL_registerSensorPlugin ( dwSensorType  sensorType,
char const *  codecMimeType,
void const *  funcTable,
dwSALHandle_t const  sal 
)

Register sensor plugin which works with live sensors.

Parameters
[in]sensorTypethe sensor type of registered sensor plugin
[in]codecMimeTypethe codec type of registered CodecHeader plugin
[in]funcTablepointer to sensor plugin function pointer table
[in]salSpecifies the SAL handle to register sensor plugin.
Returns
DW_INVALID_ARGUMENT if codecMimeType, funcTable or sal is nullptr.
DW_BUFFER_FULL if no available entry in registration factory DW_SUCCESS