Engage Engine API
1.251.9091
|
Engine Policy Timeline configuration. More...
#include <ConfigurationObjects.h>
Inherits AppConfigurationObjects::ConfigurationObjectBase.
Public Member Functions | |
void | clear () |
![]() | |
virtual void | initForDocumenting () |
virtual std::string | toString () |
virtual bool | isDocumenting () const |
Public Attributes | |
bool | enabled |
[Optional, Default: true] Specifies if Time Lines are enabled by default. | |
std::string | storageRoot |
Specifies where the timeline recordings will be stored physically. | |
int | maxStorageMb |
Specifies the maximum storage space to use. | |
int | maxMemMb |
Specifies the maximum memory to use - defaults to maxStorageMb. | |
int | maxAudioEventMemMb |
Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults to maxMemMb. | |
int | maxDiskMb |
Specifies the maximum disk space to use - defaults to maxStorageMb. | |
long | maxEventAgeSecs |
Maximum age of an event after which it is to be erased. | |
int | maxEvents |
Maximum number of events to be retained. | |
long | groomingIntervalSecs |
Interval at which events are to be checked for age-based grooming. | |
SecurityCertificate | security |
The certificate to use for signing the recording. | |
long | autosaveIntervalSecs |
[Default 5] Interval at which events are to be saved from memory to disk (a slow operation) | |
bool | disableSigningAndVerification |
[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be available | |
bool | ephemeral |
[Default false] If true, recordings are automatically purged when the Engine is shut down and/or reinitialized. | |
![]() | |
nlohmann::json | _attached |
Additional Inherited Members | |
![]() | |
bool | _documenting |
Engine Policy Timeline configuration.
Timelines are used to record audio for instant replay and archival purposes. The audio files contain "anti tampering" features.
Helper C++ class to serialize and de-serialize EnginePolicyTimelines JSON
Example:
Definition at line 6995 of file ConfigurationObjects.h.
|
inline |
Definition at line 7051 of file ConfigurationObjects.h.
|
inline |
Definition at line 7056 of file ConfigurationObjects.h.
long AppConfigurationObjects::EnginePolicyTimelines::autosaveIntervalSecs |
[Default 5] Interval at which events are to be saved from memory to disk (a slow operation)
Definition at line 7043 of file ConfigurationObjects.h.
bool AppConfigurationObjects::EnginePolicyTimelines::disableSigningAndVerification |
[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be available
Definition at line 7046 of file ConfigurationObjects.h.
bool AppConfigurationObjects::EnginePolicyTimelines::enabled |
[Optional, Default: true] Specifies if Time Lines are enabled by default.
Certain time line settings can be overridden at a per group level using the ConfigurationObjects::GroupTimeline configuration.
Definition at line 7007 of file ConfigurationObjects.h.
bool AppConfigurationObjects::EnginePolicyTimelines::ephemeral |
[Default false] If true, recordings are automatically purged when the Engine is shut down and/or reinitialized.
Definition at line 7049 of file ConfigurationObjects.h.
long AppConfigurationObjects::EnginePolicyTimelines::groomingIntervalSecs |
Interval at which events are to be checked for age-based grooming.
Definition at line 7031 of file ConfigurationObjects.h.
int AppConfigurationObjects::EnginePolicyTimelines::maxAudioEventMemMb |
Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults to maxMemMb.
Definition at line 7019 of file ConfigurationObjects.h.
int AppConfigurationObjects::EnginePolicyTimelines::maxDiskMb |
Specifies the maximum disk space to use - defaults to maxStorageMb.
Definition at line 7022 of file ConfigurationObjects.h.
long AppConfigurationObjects::EnginePolicyTimelines::maxEventAgeSecs |
Maximum age of an event after which it is to be erased.
Definition at line 7025 of file ConfigurationObjects.h.
int AppConfigurationObjects::EnginePolicyTimelines::maxEvents |
Maximum number of events to be retained.
Definition at line 7028 of file ConfigurationObjects.h.
int AppConfigurationObjects::EnginePolicyTimelines::maxMemMb |
Specifies the maximum memory to use - defaults to maxStorageMb.
Definition at line 7016 of file ConfigurationObjects.h.
int AppConfigurationObjects::EnginePolicyTimelines::maxStorageMb |
Specifies the maximum storage space to use.
Definition at line 7013 of file ConfigurationObjects.h.
SecurityCertificate AppConfigurationObjects::EnginePolicyTimelines::security |
The certificate to use for signing the recording.
This is part of the anti tampering feature where the certificate and it's private key are used to digitally sign the event. The public portion of the certificate is added to the event file for later verification.
Definition at line 7040 of file ConfigurationObjects.h.
std::string AppConfigurationObjects::EnginePolicyTimelines::storageRoot |
Specifies where the timeline recordings will be stored physically.
Definition at line 7010 of file ConfigurationObjects.h.