nx_metadata_sdk
1.0
Metadata SDK
|
#include <i_engine.h>
Public Member Functions | |
Result< const IActiveSettingChangedResponse * > | getSettingsOnActiveSettingChange (const IActiveSettingChangedAction *activeSettingChangedAction) |
![]() | |
virtual IRefCountable * | queryInterface (const InterfaceId *id) |
Ptr< RefCountable > | queryInterface () |
Ptr< const RefCountable > | queryInterface () const |
Static Public Member Functions | |
static auto | interfaceId () |
Protected Member Functions | |
virtual void | doGetSettingsOnActiveSettingChange (Result< const IActiveSettingChangedResponse *> *outResult, const IActiveSettingChangedAction *activeSettingChangedAction)=0 |
![]() | |
virtual IRefCountable * | queryInterface (const IRefCountable::InterfaceId *id) override |
IRefCountable * | queryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId) |
Main interface for an Analytics Engine instance. The instances are created by a Mediaserver via calling analytics::IPlugin::createEngine() typically on Mediaserver start (or when a new Engine is created by the system administrator), and destroyed (via releaseRef()) on Mediaserver shutdown (or when an existing Engine is deleted by the system administrator).
For the VMS end user, each Engine instance is perceived as an independent Analytics Engine which has its own set of values of settings stored in the Mediaserver database.
All methods are guaranteed to be called without overlapping even if from different threads (i.e. with a guaranteed barrier between the calls), thus, no synchronization is required for the implementation.
|
protectedpure virtual |
Called by getSettingsOnActiveSettingChange()
|
inline |
When a setting marked as Active changes its value in the GUI, the Server calls this method to notify the Plugin and allow it to adjust the values of the settings and the Settings Model. This mechanism allows certain settings to depend on the current values of others, for example, switching a checkbox or a drop-down can lead to some other setting being replaced with another, or some values being converted to a different measurement unit.