nx_cloud_storage_sdk  1.0
Cloud Storage SDK
Public Member Functions | Protected Member Functions | List of all members
nx::vms_server_plugins::cloud_storage::sample::Engine Class Reference
Inheritance diagram for nx::vms_server_plugins::cloud_storage::sample::Engine:
nx::sdk::RefCountable< nx::sdk::cloud_storage::IEngine > nx::sdk::cloud_storage::IEngine nx::sdk::Interface< IEngine > nx::sdk::IRefCountable

Public Member Functions

 Engine (const nx::sdk::cloud_storage::IArchiveUpdateHandler *deviceManagerHandler, const std::string &pluginId)
 
virtual void startNotifications () override
 
virtual void stopNotifications () override
 
virtual void doQueryBookmarks (const char *filter, nx::sdk::Result< nx::sdk::IString *> *outResult) override
 
virtual nx::sdk::ErrorCode deleteBookmark (const char *bookmarkId) override
 
virtual nx::sdk::ErrorCode saveMetadata (const char *deviceId, int64_t timeStampUs, nx::sdk::cloud_storage::MetadataType type, const char *data) override
 
virtual bool isOnline () const override
 
virtual nx::sdk::ErrorCode storageSpace (nx::sdk::cloud_storage::StorageSpace *storageSpace) const override
 
virtual nx::sdk::ErrorCode saveBestShotImage (const char *data) override
 
- Public Member Functions inherited from nx::sdk::RefCountable< nx::sdk::cloud_storage::IEngine >
 RefCountable (const RefCountable &)=delete
 
 RefCountable (RefCountable &&)=delete
 
RefCountableoperator= (const RefCountable &)=delete
 
RefCountableoperator= (RefCountable &&)=delete
 
virtual int addRef () const override
 
virtual int releaseRef () const override
 
int refCount () const
 
- Public Member Functions inherited from nx::sdk::cloud_storage::IEngine
virtual Result< IDeviceAgent * > obtainDeviceAgent (const IDeviceInfo *deviceInfo)
 
Result< IString * > queryBookmarks (const char *filter)
 
Result< IString * > queryMotionTimePeriods (const char *filter)
 
Result< IString * > queryAnalytics (const char *filter)
 
Result< IString * > queryAnalyticsTimePeriods (const char *filter)
 
Result< IString * > fetchBestShotImage (const char *objectTrackId) const
 
- Public Member Functions inherited from nx::sdk::Interface< IEngine >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
int refCountThreadUnsafe () const
 

Protected Member Functions

virtual void doObtainDeviceAgent (nx::sdk::Result< nx::sdk::cloud_storage::IDeviceAgent *> *outResult, const nx::sdk::IDeviceInfo *deviceInfo) override
 
virtual void doQueryMotionTimePeriods (const char *filter, nx::sdk::Result< nx::sdk::IString *> *outResult) override
 
virtual void doQueryAnalytics (const char *filter, nx::sdk::Result< nx::sdk::IString *> *outResult) override
 
virtual void doQueryAnalyticsTimePeriods (const char *filter, nx::sdk::Result< nx::sdk::IString *> *outResult) override
 
virtual void doFetchBestShotImage (const char *objectTrackId, nx::sdk::Result< nx::sdk::IString *> *outResult) const override
 
- Protected Member Functions inherited from nx::sdk::Interface< IEngine >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 

Additional Inherited Members

- Static Public Member Functions inherited from nx::sdk::cloud_storage::IEngine
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 
- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Member Function Documentation

◆ isOnline()

bool nx::vms_server_plugins::cloud_storage::sample::Engine::isOnline ( ) const
overridevirtual

Check if plugin backend is operational. This function will be periodically called by Server.

Implements nx::sdk::cloud_storage::IEngine.

◆ saveBestShotImage()

nx::sdk::ErrorCode nx::vms_server_plugins::cloud_storage::sample::Engine::saveBestShotImage ( const char *  data)
overridevirtual

Add a best shot image to the ObjectTrack. data is the JSON representation of the nx::sdk::cloud_storage::Image struct.

Implements nx::sdk::cloud_storage::IEngine.

◆ saveMetadata()

nx::sdk::ErrorCode nx::vms_server_plugins::cloud_storage::sample::Engine::saveMetadata ( const char *  deviceId,
int64_t  timestampUs,
nx::sdk::cloud_storage::MetadataType  type,
const char *  data 
)
overridevirtual
Parameters
dataA null-terminated string containing the JSON of the corresponding metadata object. Refer to Bookmark, ObjectTrack and Motion objects in the sdk/cloud_storage/helpers/data.h for details.

Implements nx::sdk::cloud_storage::IEngine.

◆ startNotifications()

void nx::vms_server_plugins::cloud_storage::sample::Engine::startNotifications ( )
overridevirtual

No IArchiveUpdateHandler::onArchiveUpdated() should be called by the plugin before this function has been called.

Implements nx::sdk::cloud_storage::IEngine.

◆ stopNotifications()

void nx::vms_server_plugins::cloud_storage::sample::Engine::stopNotifications ( )
overridevirtual

No IArchiveUpdateHandler::onArchiveUpdated() should be called by the plugin after this function has been called.

Implements nx::sdk::cloud_storage::IEngine.

◆ storageSpace()

nx::sdk::ErrorCode nx::vms_server_plugins::cloud_storage::sample::Engine::storageSpace ( nx::sdk::cloud_storage::StorageSpace storageSpace) const
overridevirtual

Get backend storage space information.

Implements nx::sdk::cloud_storage::IEngine.


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