nx_server_plugin_sdk 1.0 Server Plugin SDK

Public Member Functions | List of all members
nxpl::Plugin Class Referenceabstract

`#include <plugin_api.h>`

Inheritance diagram for nxpl::Plugin:

## Public Member Functions
virtual const char * | name () const =0
virtual void | setSettings (const nxpl::Setting *settings, int count)=0
Public Member Functions inherited from nxpl::PluginInterface
virtual void * | queryInterface (const nxpl::NX_GUID &interfaceID)=0
| Cast to type, specified by interfaceID. More...
virtual int | addRef () const =0
| Increment reference counter. More...
virtual int | releaseRef () const =0
| Decrement reference counter. More...

## Detailed Description

Optional interface with general plugin features (name, settings). Server tries to cast the initial pointer received from createNXPluginInstance() to this type right after the plugin is loaded.

## Member Function Documentation

## ◆ name()

virtual const char* nxpl::Plugin::name | ( |  | ) | const
| pure virtual

Name of the plugin, used for information purpose only.

## ◆ setSettings()

virtual void nxpl::Plugin::setSettings | ( | const nxpl::Setting * | settings,
|  | int | count
| ) |  |
| pure virtual

Used by the server to assign settings to the plugin. Called before other plugin features are used.

Parameters

  settings | This memory cannot be accessed after this method returns.
  count | Size of the settings array.

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

- src/plugins/plugin_api.h